com.cloudbees.syslog

Enum Severity

java.lang.Object

java.lang.Enum<Severity>

com.cloudbees.syslog.Severity

All Implemented Interfaces:

Serializable, Comparable<Severity>

public enum Severity
extends Enum<Severity>

Syslog severity as defined in RFC 5424 - The Syslog Protocol.

Author:

Cyrille Le Clerc

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALERT Alert: action must be taken immediately, numerical code 1.
CRITICAL Critical: critical conditions, numerical code 2.
DEBUG Debug: debug-level messages, numerical code 7.
EMERGENCY Emergency: system is unusable, numerical code 0.
ERROR Error: error conditions, numerical code 3.
INFORMATIONAL Informational: informational messages, numerical code 6.
NOTICE Notice: normal but significant condition, numerical code 5.
WARNING Warning: warning conditions, numerical code 4.

Method Summary

Methods

Modifier and Type	Method and Description
static Comparator<Severity>	comparator() Compare on numericalCode()
static Severity	fromLabel(String label)
static Severity	fromNumericalCode(int numericalCode)
String	label() Syslog severity textual code.
int	numericalCode() Syslog severity numerical code
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

EMERGENCY

public static final Severity EMERGENCY

Emergency: system is unusable, numerical code 0.

ALERT

public static final Severity ALERT

Alert: action must be taken immediately, numerical code 1.

CRITICAL

public static final Severity CRITICAL

Critical: critical conditions, numerical code 2.

ERROR

public static final Severity ERROR

Error: error conditions, numerical code 3.

WARNING

public static final Severity WARNING

Warning: warning conditions, numerical code 4.

NOTICE

public static final Severity NOTICE

Notice: normal but significant condition, numerical code 5.

INFORMATIONAL

public static final Severity INFORMATIONAL

Informational: informational messages, numerical code 6.

DEBUG

public static final Severity DEBUG

Debug: debug-level messages, numerical code 7.

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

fromNumericalCode

public static Severity fromNumericalCode(int numericalCode)
                                  throws IllegalArgumentException

Parameters:

numericalCode - Syslog severity numerical code

Returns:

Syslog severity, not null

Throws:

IllegalArgumentException - the given numericalCode is not a valid Syslog severity numerical code

fromLabel

@Nullable
public static Severity fromLabel(@Nullable
                          String label)
                          throws IllegalArgumentException

Parameters:

label - Syslog severity textual code. null or empty returns null

Returns:

Syslog severity, null if given value is null

Throws:

IllegalArgumentException - the given value is not a valid Syslog severity textual code

numericalCode

public int numericalCode()

Syslog severity numerical code

label

@Nonnull
public String label()

Syslog severity textual code. Not null.

comparator

public static Comparator<Severity> comparator()

Compare on numericalCode()