Package org.jboss.logmanager.formatters

Class CompoundFormatStep

java.lang.Object

org.jboss.logmanager.formatters.CompoundFormatStep

All Implemented Interfaces:

FormatStep

public class CompoundFormatStep
extends Object
implements FormatStep

A compound format step. Create via FormatStep.createCompoundStep(FormatStep...).

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.logmanager.formatters.FormatStep

FormatStep.ItemType

Field Summary

Fields inherited from interface org.jboss.logmanager.formatters.FormatStep

NO_STEPS, NULL_STEP

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CompoundFormatStep(FormatStep[] clonedSteps)

Method Summary

Modifier and Type	Method	Description
int	childStepCount()
FormatStep[]	childSteps()	Get child steps that compose this step.
int	estimateLength()	Emit an estimate of the length of data which this step will produce.
FormatStep	getChildStep(int idx)
FormatStep.ItemType	getItemType()	Get the item type of this step.
boolean	isCallerInformationRequired()	Indicates whether or not caller information is required for this format step.
void	render(StringBuilder builder, ExtLogRecord record)	Render a part of the log record.
void	render(Formatter formatter, StringBuilder builder, ExtLogRecord record)	Render a part of the log record to the given formatter.

Methods inherited from interface org.jboss.logmanager.formatters.FormatStep

createCompoundStep

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CompoundFormatStep

protected CompoundFormatStep(FormatStep[] clonedSteps)

Method Detail

render

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

Description copied from interface: FormatStep

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

Specified by:

render in interface FormatStep

Parameters:

formatter - the formatter to render to

builder - the string builder to append to

record - the record being rendered

render

public void render(StringBuilder builder,
                   ExtLogRecord record)

Description copied from interface: FormatStep

Render a part of the log record.

Specified by:

render in interface FormatStep

Parameters:

builder - the string builder to append to

record - the record being rendered

estimateLength

public int estimateLength()

Description copied from interface: FormatStep

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.

Specified by:

estimateLength in interface FormatStep

Returns:

an estimate

isCallerInformationRequired

public boolean isCallerInformationRequired()

Description copied from interface: FormatStep

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

Specified by:

isCallerInformationRequired in interface FormatStep

Returns:

true if caller information is required, otherwise false

getItemType

public FormatStep.ItemType getItemType()

Description copied from interface: FormatStep

Get the item type of this step.

Specified by:

getItemType in interface FormatStep

Returns:

the item type

childStepCount

public int childStepCount()

Specified by:

childStepCount in interface FormatStep

getChildStep

public FormatStep getChildStep(int idx)

Specified by:

getChildStep in interface FormatStep

childSteps

public FormatStep[] childSteps()

Description copied from interface: FormatStep

Get child steps that compose this step.

Specified by:

childSteps in interface FormatStep

Returns:

the child steps (not null)