Module org.jboss.logmanager

Package org.jboss.logmanager

Class ExtFormatter

java.lang.Object

java.util.logging.Formatter

org.jboss.logmanager.ExtFormatter

Direct Known Subclasses:

ExtFormatter.Delegating, MultistepFormatter, StructuredFormatter

public abstract class ExtFormatter
extends Formatter

A formatter which handles ExtLogRecord instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExtFormatter.Delegating	A base class for formatters which wrap other formatters.

Constructor Summary

Constructors

Constructor	Description
ExtFormatter()	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
String	format(LogRecord record)
abstract String	format(ExtLogRecord record)	Format a message using an extended log record.
String	formatMessage(LogRecord record)
protected String	formatMessageLegacy(LogRecord record)	Format the message text as if there are no parameters.
protected String	formatMessageNone(LogRecord record)	Format the message text as if there are no parameters.
protected String	formatMessagePrintf(LogRecord record)	Format the message text as if there are no parameters.
boolean	isCallerCalculationRequired()	Determines whether or not this formatter will require caller, source level, information when a log record is formatted.
static ExtFormatter	wrap(Formatter formatter, boolean formatMessages)	Wrap an existing formatter with an ExtFormatter, optionally replacing message formatting with the default extended message formatting capability.

Methods inherited from class java.util.logging.Formatter

getHead, getTail

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtFormatter

public ExtFormatter()

Construct a new instance.

Method Detail

wrap

public static ExtFormatter wrap(Formatter formatter,
                                boolean formatMessages)

Wrap an existing formatter with an ExtFormatter, optionally replacing message formatting with the default extended message formatting capability.

Parameters:

formatter - the formatter to wrap (must not be null)

formatMessages - true to replace message formatting, false to let the original formatter do it

Returns:

the extended formatter (not null)

format

public final String format(LogRecord record)

Specified by:

format in class Formatter

format

public abstract String format(ExtLogRecord record)

Format a message using an extended log record.

Parameters:

record - the log record

Returns:

the formatted message

formatMessage

public String formatMessage(LogRecord record)

Overrides:

formatMessage in class Formatter

isCallerCalculationRequired

public boolean isCallerCalculationRequired()

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

Returns:

true if the formatter will need caller information, otherwise false

See Also:

LogRecord.getSourceClassName(), ExtLogRecord.getSourceFileName(), ExtLogRecord.getSourceLineNumber(), LogRecord.getSourceMethodName()

formatMessageNone

protected String formatMessageNone(LogRecord record)

Format the message text as if there are no parameters. The default implementation delegates to record.getMessage().

Parameters:

record - the record to format

Returns:

the formatted string

formatMessageLegacy

protected String formatMessageLegacy(LogRecord record)

Format the message text as if there are no parameters. The default implementation delegates to MessageFormat.format(record.getMessage(),record.getParameters()).

Parameters:

record - the record to format

Returns:

the formatted string

formatMessagePrintf

protected String formatMessagePrintf(LogRecord record)

Format the message text as if there are no parameters. The default implementation delegates to String.format(record.getMessage(),record.getParameters()).

Parameters:

record - the record to format

Returns:

the formatted string