net.adamcin.oakpal.api

Enum Severity

java.lang.Object

java.lang.Enum<Severity>

net.adamcin.oakpal.api.Severity

All Implemented Interfaces:

Serializable, Comparable<Severity>

public enum Severity
extends Enum<Severity>

Levels of severity for violations detected during package scans.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAJOR Likely to be the source of component instability.
MINOR Unlikely to disrupt application functionality.
SEVERE Likely to be the source of platform instability.

Method Summary

Modifier and Type	Method and Description
static Severity	byName(@NotNull String name) Runtime throwing function to lookup severity codes by name.
boolean	isLessSevereThan(Severity other)
Severity	maxSeverity(@NotNull Severity other)
Predicate<Severity>	meetsMinimumSeverity()
static Severity	valueOf(String name) Returns the enum constant of this type with the specified name.
static Severity[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MINOR

public static final Severity MINOR

Unlikely to disrupt application functionality. Appropriate for reporting violations of code or style conventions, or inconsistency between modes of installation.

MAJOR

public static final Severity MAJOR

Likely to be the source of component instability. Appropriate for importer errors, mistaken assumptions about root path dependencies or namespaces, or failures related to unit testing of application packages.

SEVERE

public static final Severity SEVERE

Likely to be the source of platform instability. Appropriate for reporting cross-package filter overlap, destructive ACL handling modes, destruction of authorable content, or security violations.

Method Detail

values

public static Severity[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Severity c : Severity.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Severity valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

byName

public static Severity byName(@NotNull
                              @NotNull String name)

Runtime throwing function to lookup severity codes by name.

Parameters:

name - the severity level name

Returns:

the associated severity level

isLessSevereThan

public boolean isLessSevereThan(Severity other)

meetsMinimumSeverity

public Predicate<Severity> meetsMinimumSeverity()

maxSeverity

public Severity maxSeverity(@NotNull
                            @NotNull Severity other)