Modifier and Type	Class and Description
public static enum	FormatStep.ItemType An enumeration of the types of items that can be rendered.

Method Summary

Modifier and Type	Method and Description
public int	Returns: an estimate estimateLength() Emit an estimate of the length of data which this step will produce.
public default FormatStep.ItemType	Returns: the item type getItemType() Get the item type of this step.
public default boolean	Returns: `true` if caller information is required, otherwise `false` isCallerInformationRequired() Indicates whether or not caller information is required for this format step.
public void	render(StringBuilder the string builder to append to builder, ExtLogRecord the record being rendered record) Render a part of the log record.
public default void	render(Formatter the formatter to render to formatter, StringBuilder the string builder to append to builder, ExtLogRecord the record being rendered record) Render a part of the log record to the given formatter.

Method Detail

estimateLength	back to summary
public int estimateLength() Emit an estimate of the length of data which this step will produce. The more accurate the estimate, the more likely the format operation will be performant. Returns:int an estimate

estimateLength

back to summary

public int estimateLength()

Emit an estimate of the length of data which this step will produce. The more accurate the estimate, the more likely the format operation will be performant.

Returns:int: an estimate

getItemType	back to summary
public default FormatStep.ItemType getItemType() Get the item type of this step. Returns:FormatStep.ItemType the item type

getItemType

back to summary

public default FormatStep.ItemType getItemType()

Get the item type of this step.

Returns:FormatStep.ItemType: the item type

isCallerInformationRequired back to summary

isCallerInformationRequired	back to summary
public default boolean isCallerInformationRequired() Indicates whether or not caller information is required for this format step. Returns:boolean `true` if caller information is required, otherwise `false`

public default boolean isCallerInformationRequired()

Indicates whether or not caller information is required for this format step.

Returns:boolean: true if caller information is required, otherwise false

render	back to summary
public void render(StringBuilder builder, ExtLogRecord record) Render a part of the log record. Parameters builder:StringBuilder the string builder to append to record:ExtLogRecord the record being rendered

render

back to summary

public void render(StringBuilder builder, ExtLogRecord record)

Render a part of the log record.

Parameters

builder:StringBuilder: the string builder to append to
record:ExtLogRecord: the record being rendered

render	back to summary
public default void render(Formatter formatter, StringBuilder builder, ExtLogRecord record) Render a part of the log record to the given formatter. Parameters formatter:Formatter the formatter to render to builder:StringBuilder the string builder to append to record:ExtLogRecord the record being rendered

render

back to summary

public default void render(Formatter formatter, StringBuilder builder, ExtLogRecord record)

Render a part of the log record to the given formatter.

Parameters

formatter:Formatter: the formatter to render to
builder:StringBuilder: the string builder to append to
record:ExtLogRecord: the record being rendered

org.jboss.logmanager.formatters back to summary

public final Enum FormatStep.ItemType

Class Inheritance

extends Enum<FormatStep.ItemType>

java.lang.Object
java.lang.Enum
org.jboss.logmanager.formatters.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.

Field Summary

Modifier and Type	Field and Description
public static final FormatStep.ItemType	CATEGORY
public static final FormatStep.ItemType	COMPOUND A compound step.
public static final FormatStep.ItemType	DATE
public static final FormatStep.ItemType	EXCEPTION_TRACE
public static final FormatStep.ItemType	GENERIC An item of unknown kind.
public static final FormatStep.ItemType	HOST_NAME
public static final FormatStep.ItemType	LEVEL A log level.
public static final FormatStep.ItemType	LINE_SEPARATOR
public static final FormatStep.ItemType	MDC
public static final FormatStep.ItemType	MESSAGE The log message without the exception trace.
public static final FormatStep.ItemType	NDC
public static final FormatStep.ItemType	PROCESS_ID
public static final FormatStep.ItemType	PROCESS_NAME
public static final FormatStep.ItemType	RELATIVE_TIME
public static final FormatStep.ItemType	RESOURCE_KEY
public static final FormatStep.ItemType	SOURCE_CLASS_NAME
public static final FormatStep.ItemType	SOURCE_FILE_NAME
public static final FormatStep.ItemType	SOURCE_LINE_NUMBER
public static final FormatStep.ItemType	SOURCE_METHOD_NAME
public static final FormatStep.ItemType	SOURCE_MODULE_NAME
public static final FormatStep.ItemType	SOURCE_MODULE_VERSION
public static final FormatStep.ItemType	SYSTEM_PROPERTY
public static final FormatStep.ItemType	TEXT
public static final FormatStep.ItemType	THREAD_ID
public static final FormatStep.ItemType	THREAD_NAME

Constructor Summary

Access	Constructor and Description
private	ItemType()

Method Summary

Modifier and Type	Method and Description
public static FormatStep.ItemType	valueOf(String name)
public static FormatStep.ItemType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CATEGORY	back to summary
public static final FormatStep.ItemType CATEGORY

COMPOUND	back to summary
public static final FormatStep.ItemType COMPOUND A compound step.

DATE	back to summary
public static final FormatStep.ItemType DATE

EXCEPTION_TRACE	back to summary
public static final FormatStep.ItemType EXCEPTION_TRACE

GENERIC	back to summary
public static final FormatStep.ItemType GENERIC An item of unknown kind.

HOST_NAME	back to summary
public static final FormatStep.ItemType HOST_NAME

LEVEL	back to summary
public static final FormatStep.ItemType LEVEL A log level.

LINE_SEPARATOR	back to summary
public static final FormatStep.ItemType LINE_SEPARATOR

MDC	back to summary
public static final FormatStep.ItemType MDC

MESSAGE	back to summary
public static final FormatStep.ItemType MESSAGE The log message without the exception trace.

NDC	back to summary
public static final FormatStep.ItemType NDC

PROCESS_ID	back to summary
public static final FormatStep.ItemType PROCESS_ID

PROCESS_NAME	back to summary
public static final FormatStep.ItemType PROCESS_NAME

RELATIVE_TIME	back to summary
public static final FormatStep.ItemType RELATIVE_TIME

RESOURCE_KEY	back to summary
public static final FormatStep.ItemType RESOURCE_KEY

SOURCE_CLASS_NAME	back to summary
public static final FormatStep.ItemType SOURCE_CLASS_NAME

SOURCE_FILE_NAME	back to summary
public static final FormatStep.ItemType SOURCE_FILE_NAME

SOURCE_LINE_NUMBER	back to summary
public static final FormatStep.ItemType SOURCE_LINE_NUMBER

SOURCE_METHOD_NAME	back to summary
public static final FormatStep.ItemType SOURCE_METHOD_NAME

SOURCE_MODULE_NAME	back to summary
public static final FormatStep.ItemType SOURCE_MODULE_NAME

SOURCE_MODULE_VERSION	back to summary
public static final FormatStep.ItemType SOURCE_MODULE_VERSION

SYSTEM_PROPERTY	back to summary
public static final FormatStep.ItemType SYSTEM_PROPERTY

TEXT	back to summary
public static final FormatStep.ItemType TEXT

THREAD_ID	back to summary
public static final FormatStep.ItemType THREAD_ID

THREAD_NAME	back to summary
public static final FormatStep.ItemType THREAD_NAME

Constructor Detail

ItemType	back to summary
private ItemType()

Method Detail

valueOf	back to summary
public static FormatStep.ItemType valueOf(String name)

values	back to summary
public static FormatStep.ItemType[] values()

public Interface FormatStep

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum FormatStep.ItemType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail