Package com.redwood.scheduler.api.model.enumeration

Enum LogLevel

java.lang.Object

java.lang.Enum<LogLevel>

com.redwood.scheduler.api.model.enumeration.LogLevel

All Implemented Interfaces:

BaseSchedulerEnumeration<LogLevel,Character>, SchedulerEnumeration<LogLevel>, Serializable, Comparable<LogLevel>

public enum LogLevel
extends Enum<LogLevel>
implements SchedulerEnumeration<LogLevel>

Specifies what log level should be logged to the log file. (Character Enumeration)

Enum Constant Summary

Enum Constants

Enum Constant	Description
Debug	Debug level logging
Error	Error level logging
Fatal	Fatal level logging
Info	Information level logging
None	No logging
Trace	Trace level logging
Warn	Warning level logging

Field Summary

Fields

Modifier and Type	Field	Description
static char	DebugCode	The char returned from Debug.getCodeEx().
static char	ErrorCode	The char returned from Error.getCodeEx().
static char	FatalCode	The char returned from Fatal.getCodeEx().
static char	InfoCode	The char returned from Info.getCodeEx().
static char	NoneCode	The char returned from None.getCodeEx().
static char	TraceCode	The char returned from Trace.getCodeEx().
static char	WarnCode	The char returned from Warn.getCodeEx().

Method Summary

Modifier and Type	Method	Description
char	getCodeEx()	Get the code that is used to represent this enumeration in the database.
Character	getCodeExCharacter()	Get the code that is used to represent this enumeration in the database.
String	getCodeExString()	Get the code that is used to represent this enumeration in the database.
Character	getCodeExValue()	Return the code for the enumeration item as the database type of this enumeration.
String	getDescriptionKey()	Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.
String	getTranslationEN()	Get the English name of this enumeration.
String	getTranslationKey()	Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.
static LogLevel	safeValueOf(String value)	Helper function to return the LogLevel represented by value.
static LogLevel	valueOf(char code)	Helper function to return the LogLevel represented by code.
static LogLevel	valueOf(Character code)	Helper function to return the LogLevel represented by code.
static LogLevel	valueOf(String name)	Returns the enum constant of this type with the specified name.
static LogLevel	valueOfCode(String code)	Helper function to return the LogLevel represented by code.
static LogLevel[]	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

Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration

name, ordinal

Methods inherited from interface java.lang.Comparable

compareTo

Enum Constant Detail

Trace

public static final LogLevel Trace

Trace level logging

Debug

public static final LogLevel Debug

Debug level logging

Info

public static final LogLevel Info

Information level logging

Warn

public static final LogLevel Warn

Warning level logging

Error

public static final LogLevel Error

Error level logging

Fatal

public static final LogLevel Fatal

Fatal level logging

None

public static final LogLevel None

No logging

Field Detail

TraceCode

public static final char TraceCode

The char returned from Trace.getCodeEx().

See Also:

Trace, Constant Field Values

DebugCode

public static final char DebugCode

The char returned from Debug.getCodeEx().

See Also:

Debug, Constant Field Values

InfoCode

public static final char InfoCode

The char returned from Info.getCodeEx().

See Also:

Info, Constant Field Values

WarnCode

public static final char WarnCode

The char returned from Warn.getCodeEx().

See Also:

Warn, Constant Field Values

ErrorCode

public static final char ErrorCode

The char returned from Error.getCodeEx().

See Also:

Error, Constant Field Values

FatalCode

public static final char FatalCode

The char returned from Fatal.getCodeEx().

See Also:

Fatal, Constant Field Values

NoneCode

public static final char NoneCode

The char returned from None.getCodeEx().

See Also:

None, Constant Field Values

Method Detail

values

public static LogLevel[] 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 (LogLevel c : LogLevel.values())
    System.out.println(c);

Returns:

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

valueOf

public static LogLevel 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

valueOfCode

public static LogLevel valueOfCode(String code)

Helper function to return the LogLevel represented by code. code must be a single character. If code is null, longer than one character, empty, or not a valid code then this method will return null.

Parameters:

code - A string with one character that is one of the codes for LogLevel

Returns:

The LogLevel corresponding to code, or null, if code is null, longer than one character, or not a valid code

safeValueOf

public static LogLevel safeValueOf(String value)

Helper function to return the LogLevel represented by value. If value is null, or not a valid LogLevel enumeration then this method will return null.

The main difference between this method and valueOf(String), is that this method will return null when passed an invalid value, valueOf(String) will throw an IllegalArgumentException.

Parameters:

value - The string value that corresponds to the requested enumeration value

Returns:

The LogLevel corresponding to value, or null, if value is null, or not a valid enumeration

See Also:

valueOf(String)

valueOf

public static LogLevel valueOf(Character code)

Helper function to return the LogLevel represented by code. If code is null, or not a valid LogLevel code then this method will return null.

Parameters:

code - Character that is one of the codes for HandlerAction

Returns:

The LogLevel corresponding to code, or null, if code is null, or not a valid code

valueOf

public static LogLevel valueOf(char code)

Helper function to return the LogLevel represented by code. If code is not a valid LogLevel code then this method will return null.

Parameters:

code - char that is one of the codes for HandlerAction

Returns:

The LogLevel corresponding to code, or null, if code is not a valid code

getCodeEx

public char getCodeEx()

Description copied from interface: SchedulerEnumeration

Get the code that is used to represent this enumeration in the database.

Specified by:

getCodeEx in interface SchedulerEnumeration<LogLevel>

Returns:

the database code for the enumeration

getCodeExValue

public Character getCodeExValue()

Description copied from interface: BaseSchedulerEnumeration

Return the code for the enumeration item as the database type of this enumeration.

Specified by:

getCodeExValue in interface BaseSchedulerEnumeration<LogLevel,Character>

Returns:

the enumeration code

getCodeExCharacter

public Character getCodeExCharacter()

Description copied from interface: SchedulerEnumeration

Get the code that is used to represent this enumeration in the database.

Specified by:

getCodeExCharacter in interface SchedulerEnumeration<LogLevel>

Returns:

the database code for the enumeration

getTranslationKey

public String getTranslationKey()

Description copied from interface: BaseSchedulerEnumeration

Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.

Specified by:

getTranslationKey in interface BaseSchedulerEnumeration<LogLevel,Character>

Returns:

the key.

getTranslationEN

public String getTranslationEN()

Description copied from interface: BaseSchedulerEnumeration

Get the English name of this enumeration.

Specified by:

getTranslationEN in interface BaseSchedulerEnumeration<LogLevel,Character>

Returns:

the English name of this enumeration.

getDescriptionKey

public String getDescriptionKey()

Description copied from interface: BaseSchedulerEnumeration

Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.

Specified by:

getDescriptionKey in interface BaseSchedulerEnumeration<LogLevel,Character>

Returns:

the key that can be passed to SchedulerSession.translateField(String) to retrieve the translated description.

getCodeExString

public String getCodeExString()

Description copied from interface: SchedulerEnumeration

Get the code that is used to represent this enumeration in the database.

Specified by:

getCodeExString in interface SchedulerEnumeration<LogLevel>

Returns:

the database code for the enumeration