Top Description Fields Constructors Methods
org.jboss.logmanager.formatters

public Class MultistepFormatter

extends ExtFormatter
Class Inheritance
Known Direct Subclasses
org.jboss.logmanager.formatters.PatternFormatter
Static Imports
java.lang.Math.max
A formatter which formats a record in a series of steps.

Field Summary

Modifier and TypeField and Description
private volatile int
builderLength

private volatile boolean
callerCalculationRequired

private static final FormatStep[]
EMPTY_STEPS

private volatile FormatStep[]
steps

Constructor Summary

AccessConstructor and Description
public
MultistepFormatter(final FormatStep[]
the steps to execute to format the record
steps)

Construct a new instance.

public
MultistepFormatter()

Construct a new instance.

Method Summary

Modifier and TypeMethod and Description
private void
calculateBuilderLength()

public String
format(final ExtLogRecord
the log record
record)

Implements abstract org.jboss.logmanager.ExtFormatter.format.

Format a message using an extended log record.

public FormatStep[]

Returns:

a copy of the format steps
getSteps()

Get a copy of the format steps.

public boolean
isCallerCalculationRequired()

Overrides org.jboss.logmanager.ExtFormatter.isCallerCalculationRequired.

Determines whether or not this formatter will require caller, source level, information when a log record is formatted.

public void
setSteps(final FormatStep[]
the new format steps
steps)

Assign new format steps.

Inherited from org.jboss.logmanager.ExtFormatter:
formatformatMessageformatMessageLegacyformatMessageNoneformatMessagePrintfwrap

Field Detail

builderLengthback to summary
private volatile int builderLength
callerCalculationRequiredback to summary
private volatile boolean callerCalculationRequired
EMPTY_STEPSback to summary
private static final FormatStep[] EMPTY_STEPS
stepsback to summary
private volatile FormatStep[] steps

Constructor Detail

MultistepFormatterback to summary
public MultistepFormatter(final FormatStep[] steps)

Construct a new instance.

Parameters
steps:FormatStep[]

the steps to execute to format the record

MultistepFormatterback to summary
public MultistepFormatter()

Construct a new instance.

Method Detail

calculateBuilderLengthback to summary
private void calculateBuilderLength()
formatback to summary
public String format(final ExtLogRecord record)

Implements abstract org.jboss.logmanager.ExtFormatter.format.

Doc from org.jboss.logmanager.ExtFormatter.format.

Format a message using an extended log record.

Parameters
record:ExtLogRecord

the log record

Returns:String

the formatted message

getStepsback to summary
public FormatStep[] getSteps()

Get a copy of the format steps.

Returns:FormatStep[]

a copy of the format steps

isCallerCalculationRequiredback to summary
public boolean isCallerCalculationRequired()

Overrides org.jboss.logmanager.ExtFormatter.isCallerCalculationRequired.

Doc from org.jboss.logmanager.ExtFormatter.isCallerCalculationRequired.

Determines whether or not this formatter will require caller, source level, information when a log record is formatted.

Returns:boolean

true if the formatter will need caller information, otherwise false

Annotations
@Override
setStepsback to summary
public void setSteps(final FormatStep[] steps)

Assign new format steps.

Parameters
steps:FormatStep[]

the new format steps