org.opends.messages

Enum Severity

java.lang.Object

java.lang.Enum<Severity>

org.opends.messages.Severity

All Implemented Interfaces:

Serializable, Comparable<Severity>

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public enum Severity
extends Enum<Severity>

Defines values for message severity. Severities contain an integer value that can be used for bitwise operations as well as a short abbreviated string form of each value.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEBUG The severity that will be used for debug messages.
ERROR The severity that will be used for warning messages.
INFORMATION The severity that will be used for informational messages.
NOTICE The severity that will be used for important informational messages.
WARNING The severity that will be used for warning messages.

Method Summary

Methods

Modifier and Type	Method and Description
static Set<String>	getPropertyKeyFormSet() Returns a set of string representing all Severitys' abbreviated representations.
String	messageDesciptorName() Gets the abbreviated form of this Severity.
static Severity	parseString(String s) Returns the Severity associated with the input string s which can either be a severity's name or messageDescriptorForm.
String	propertyKeyFormName() Gets the name of this severity as it must appear in the property key name in a messages file.
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

INFORMATION

public static final Severity INFORMATION

The severity that will be used for informational messages.

WARNING

public static final Severity WARNING

The severity that will be used for warning messages.

ERROR

public static final Severity ERROR

The severity that will be used for warning messages.

DEBUG

public static final Severity DEBUG

The severity that will be used for debug messages.

NOTICE

public static final Severity NOTICE

The severity that will be used for important informational messages.

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

getPropertyKeyFormSet

public static Set<String> getPropertyKeyFormSet()

Returns a set of string representing all Severitys' abbreviated representations.

Returns:

set of messageDescriptorForm strings

parseString

public static Severity parseString(String s)

Returns the Severity associated with the input string s which can either be a severity's name or messageDescriptorForm.

Parameters:

s - Severity name or messageDescriptorForm

Returns:

Severity associated with s

messageDesciptorName

public String messageDesciptorName()

Gets the abbreviated form of this Severity.

Returns:

String abbreviated form

propertyKeyFormName

public String propertyKeyFormName()

Gets the name of this severity as it must appear in the property key name in a messages file.

Returns:

name of this severity