Package org.jboss.logmanager.formatters

Enum FormatStep.ItemType

java.lang.Object

java.lang.Enum<FormatStep.ItemType>

org.jboss.logmanager.formatters.FormatStep.ItemType

All Implemented Interfaces:

Serializable, Comparable<FormatStep.ItemType>

Enclosing interface:

FormatStep

public static enum FormatStep.ItemType
extends Enum<FormatStep.ItemType>

An enumeration of the types of items that can be rendered. Note that this enumeration may be expanded in the future, so unknown values should be handled gracefully as if GENERIC were used.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CATEGORY
COMPOUND	A compound step.
DATE
EXCEPTION_TRACE
GENERIC	An item of unknown kind.
HOST_NAME
LEVEL	A log level.
LINE_SEPARATOR
MDC
MESSAGE	The log message without the exception trace.
NDC
PROCESS_ID
PROCESS_NAME
RELATIVE_TIME
RESOURCE_KEY
SOURCE_CLASS_NAME
SOURCE_FILE_NAME
SOURCE_LINE_NUMBER
SOURCE_METHOD_NAME
SOURCE_MODULE_NAME
SOURCE_MODULE_VERSION
SYSTEM_PROPERTY
TEXT
THREAD_ID
THREAD_NAME

Method Summary

Modifier and Type	Method	Description
static FormatStep.ItemType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FormatStep.ItemType[]	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

GENERIC

public static final FormatStep.ItemType GENERIC

An item of unknown kind.

COMPOUND

public static final FormatStep.ItemType COMPOUND

A compound step.

LEVEL

public static final FormatStep.ItemType LEVEL

A log level.

SOURCE_CLASS_NAME

public static final FormatStep.ItemType SOURCE_CLASS_NAME

DATE

public static final FormatStep.ItemType DATE

SOURCE_FILE_NAME

public static final FormatStep.ItemType SOURCE_FILE_NAME

HOST_NAME

public static final FormatStep.ItemType HOST_NAME

SOURCE_LINE_NUMBER

public static final FormatStep.ItemType SOURCE_LINE_NUMBER

LINE_SEPARATOR

public static final FormatStep.ItemType LINE_SEPARATOR

CATEGORY

public static final FormatStep.ItemType CATEGORY

MDC

public static final FormatStep.ItemType MDC

MESSAGE

public static final FormatStep.ItemType MESSAGE

The log message without the exception trace.

EXCEPTION_TRACE

public static final FormatStep.ItemType EXCEPTION_TRACE

SOURCE_METHOD_NAME

public static final FormatStep.ItemType SOURCE_METHOD_NAME

SOURCE_MODULE_NAME

public static final FormatStep.ItemType SOURCE_MODULE_NAME

SOURCE_MODULE_VERSION

public static final FormatStep.ItemType SOURCE_MODULE_VERSION

NDC

public static final FormatStep.ItemType NDC

PROCESS_ID

public static final FormatStep.ItemType PROCESS_ID

PROCESS_NAME

public static final FormatStep.ItemType PROCESS_NAME

RELATIVE_TIME

public static final FormatStep.ItemType RELATIVE_TIME

RESOURCE_KEY

public static final FormatStep.ItemType RESOURCE_KEY

SYSTEM_PROPERTY

public static final FormatStep.ItemType SYSTEM_PROPERTY

TEXT

public static final FormatStep.ItemType TEXT

THREAD_ID

public static final FormatStep.ItemType THREAD_ID

THREAD_NAME

public static final FormatStep.ItemType THREAD_NAME

Method Detail

values

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

Returns:

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

valueOf

public static FormatStep.ItemType 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