Modifier and Type	Class and Description
public abstract static class	ExtFormatter.Delegating A base class for formatters which wrap other formatters.
pack-priv static class	ExtFormatter.WrappedFormatter

Access	Constructor and Description
public	ExtFormatter() Construct a new instance.

Method Summary

Modifier and Type	Method and Description
public final String	format(final LogRecord the log record to be formatted. record) Implements abstract java.util.logging.Formatter.format. Format the given log record and return the formatted string.
public abstract String	Returns: the formatted message format(ExtLogRecord the log record record) Format a message using an extended log record.
public String	formatMessage(LogRecord the log record containing the raw message record) Overrides java.util.logging.Formatter.formatMessage. Localize and format the message string from a log record.
protected String	Returns: the formatted string formatMessageLegacy(LogRecord the record to format record) Format the message text as if there are no parameters.
protected String	Returns: the formatted string formatMessageNone(LogRecord the record to format record) Format the message text as if there are no parameters.
protected String	Returns: the formatted string formatMessagePrintf(LogRecord the record to format record) Format the message text as if there are no parameters.
public boolean	Returns: `true` if the formatter will need caller information, otherwise `false` isCallerCalculationRequired() Determines whether or not this formatter will require caller, source level, information when a log record is formatted.
public static ExtFormatter	Returns: the extended formatter (not `null`) wrap(Formatter the formatter to wrap (must not be `null`) formatter, boolean `true` to replace message formatting, `false` to let the original formatter do it formatMessages) Wrap an existing formatter with an `ExtFormatter`, optionally replacing message formatting with the default extended message formatting capability.

Inherited from java.util.logging.Formatter:: getHead getTail

Constructor Detail

ExtFormatter	back to summary
public ExtFormatter() Construct a new instance.

Method Detail

format back to summary

format	back to summary
public final String format(final LogRecord record) Implements abstract java.util.logging.Formatter.format. Doc from java.util.logging.Formatter.format. Format the given log record and return the formatted string. The resulting formatted String will normally include a localized and formatted version of the LogRecord's message field. It is recommended to use the `Formatter#formatMessage` convenience method to localize and format the message field. Parameters record:LogRecord the log record to be formatted. Returns:String the formatted log record

public final String format(final LogRecord record)

Implements abstract java.util.logging.Formatter.format.

Doc from java.util.logging.Formatter.format.

Format the given log record and return the formatted string.

The resulting formatted String will normally include a localized and formatted version of the LogRecord's message field. It is recommended to use the Formatter#formatMessage convenience method to localize and format the message field.

Parameters

record:LogRecord: the log record to be formatted.

Returns:String

the formatted log record

format	back to summary
public abstract String format(ExtLogRecord record) Format a message using an extended log record. Parameters record:ExtLogRecord the log record Returns:String the formatted message

format

back to summary

public abstract String format(ExtLogRecord record)

Format a message using an extended log record.

Parameters

record:ExtLogRecord: the log record

Returns:String

the formatted message

formatMessage	back to summary
public String formatMessage(LogRecord record) Overrides java.util.logging.Formatter.formatMessage. Doc from java.util.logging.Formatter.formatMessage. Localize and format the message string from a log record. This method is provided as a convenience for Formatter subclasses to use when they are performing formatting. The message string is first localized to a format string using the record's ResourceBundle. (If there is no ResourceBundle, or if the message key is not found, then the key is used as the format string.) The format String uses java.text style formatting. If there are no parameters, no formatter is used. Otherwise, if the string contains "{<digit>" where <digit> is in [0-9], java.text.MessageFormat is used to format the string. Otherwise no formatting is performed. Parameters record:LogRecord the log record containing the raw message Returns:String a localized and formatted message Annotations @Override

formatMessage

back to summary

public String formatMessage(LogRecord record)

Overrides java.util.logging.Formatter.formatMessage.

Doc from java.util.logging.Formatter.formatMessage.

Localize and format the message string from a log record. This method is provided as a convenience for Formatter subclasses to use when they are performing formatting.

The message string is first localized to a format string using the record's ResourceBundle. (If there is no ResourceBundle, or if the message key is not found, then the key is used as the format string.) The format String uses java.text style formatting.

If there are no parameters, no formatter is used.
Otherwise, if the string contains "{<digit>" where <digit> is in [0-9], java.text.MessageFormat is used to format the string.
Otherwise no formatting is performed.

Parameters

record:LogRecord: the log record containing the raw message

Returns:String

a localized and formatted message

Annotations

@Override

formatMessageLegacy back to summary

formatMessageLegacy	back to summary
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:LogRecord the record to format Returns:String the formatted string

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:LogRecord: the record to format

Returns:String

the formatted string

formatMessageNone back to summary

formatMessageNone	back to summary
protected String formatMessageNone(LogRecord record) Format the message text as if there are no parameters. The default implementation delegates to `record.getMessage()`. Parameters record:LogRecord the record to format Returns:String the formatted string

protected String formatMessageNone(LogRecord record)

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

Parameters

record:LogRecord: the record to format

Returns:String

the formatted string

formatMessagePrintf back to summary

formatMessagePrintf	back to summary
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:LogRecord the record to format Returns:String the formatted string

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:LogRecord: the record to format

Returns:String

the formatted string

isCallerCalculationRequired back to summary

isCallerCalculationRequired	back to summary
public boolean 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` See Also `LogRecord#getSourceClassName()`, `ExtLogRecord#getSourceFileName()`, `ExtLogRecord#getSourceLineNumber()`, `LogRecord#getSourceMethodName()`

public boolean 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
See Also: LogRecord#getSourceClassName(), ExtLogRecord#getSourceFileName(), ExtLogRecord#getSourceLineNumber(), LogRecord#getSourceMethodName()

wrap back to summary

wrap	back to summary
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:Formatter the formatter to wrap (must not be `null`) formatMessages:boolean `true` to replace message formatting, `false` to let the original formatter do it Returns:ExtFormatter the extended formatter (not `null`)

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:Formatter: the formatter to wrap (must not be null)
formatMessages:boolean: true to replace message formatting, false to let the original formatter do it

Returns:ExtFormatter

the extended formatter (not null)

org.jboss.logmanager back to summary

public abstract Class ExtFormatter.Delegating

Class Inheritance

extends ExtFormatter

java.lang.Object
java.util.logging.Formatter
org.jboss.logmanager.ExtFormatter
org.jboss.logmanager.ExtFormatter.Delegating

Known Direct Subclasses

org.jboss.logmanager.formatters.TextBannerFormatter

A base class for formatters which wrap other formatters.

Field Summary

Modifier and Type	Field and Description
protected final ExtFormatter	delegate The delegate formatter.

Constructor Summary

Access	Constructor and Description
public	Delegating(final ExtFormatter the delegate formatter (must not be `null`) delegate) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
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 String	formatMessage(final LogRecord the log record containing the raw message record) Overrides org.jboss.logmanager.ExtFormatter.formatMessage. Localize and format the message string from a log record.
public String	getHead(final Handler The target handler (can be null) h) Overrides java.util.logging.Formatter.getHead. Return the header string for a set of formatted records.
public String	getTail(final Handler The target handler (can be null) h) Overrides java.util.logging.Formatter.getTail. Return the tail string for a set of formatted records.
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.

Inherited from org.jboss.logmanager.ExtFormatter:: format formatMessageLegacy formatMessageNone formatMessagePrintf wrap

Field Detail

delegate	back to summary
protected final ExtFormatter delegate The delegate formatter.

Constructor Detail

Delegating back to summary

Delegating	back to summary
public Delegating(final ExtFormatter delegate) Construct a new instance. Parameters delegate:ExtFormatter the delegate formatter (must not be `null`)

public Delegating(final ExtFormatter delegate)

Construct a new instance.

Parameters

delegate:ExtFormatter: the delegate formatter (must not be null)

Method Detail

format	back 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

format

back 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

formatMessage	back to summary
public String formatMessage(final LogRecord record) Overrides org.jboss.logmanager.ExtFormatter.formatMessage. Doc from java.util.logging.Formatter.formatMessage. Localize and format the message string from a log record. This method is provided as a convenience for Formatter subclasses to use when they are performing formatting. The message string is first localized to a format string using the record's ResourceBundle. (If there is no ResourceBundle, or if the message key is not found, then the key is used as the format string.) The format String uses java.text style formatting. If there are no parameters, no formatter is used. Otherwise, if the string contains "{<digit>" where <digit> is in [0-9], java.text.MessageFormat is used to format the string. Otherwise no formatting is performed. Parameters record:LogRecord the log record containing the raw message Returns:String a localized and formatted message

formatMessage

back to summary

public String formatMessage(final LogRecord record)

Overrides org.jboss.logmanager.ExtFormatter.formatMessage.

Doc from java.util.logging.Formatter.formatMessage.

Localize and format the message string from a log record. This method is provided as a convenience for Formatter subclasses to use when they are performing formatting.

If there are no parameters, no formatter is used.
Otherwise, if the string contains "{<digit>" where <digit> is in [0-9], java.text.MessageFormat is used to format the string.
Otherwise no formatting is performed.

Parameters

record:LogRecord: the log record containing the raw message

Returns:String

a localized and formatted message

getHead	back to summary
public String getHead(final Handler h) Overrides java.util.logging.Formatter.getHead. Doc from java.util.logging.Formatter.getHead. Return the header string for a set of formatted records. This base class returns an empty string, but this may be overridden by subclasses. Parameters h:Handler The target handler (can be null) Returns:String header string

getHead

back to summary

public String getHead(final Handler h)

Overrides java.util.logging.Formatter.getHead.

Doc from java.util.logging.Formatter.getHead.

Return the header string for a set of formatted records.

This base class returns an empty string, but this may be overridden by subclasses.

Parameters

h:Handler: The target handler (can be null)

Returns:String

header string

getTail	back to summary
public String getTail(final Handler h) Overrides java.util.logging.Formatter.getTail. Doc from java.util.logging.Formatter.getTail. Return the tail string for a set of formatted records. This base class returns an empty string, but this may be overridden by subclasses. Parameters h:Handler The target handler (can be null) Returns:String tail string

getTail

back to summary

public String getTail(final Handler h)

Overrides java.util.logging.Formatter.getTail.

Doc from java.util.logging.Formatter.getTail.

Return the tail string for a set of formatted records.

This base class returns an empty string, but this may be overridden by subclasses.

Parameters

h:Handler: The target handler (can be null)

Returns:String

tail string

isCallerCalculationRequired back to summary

isCallerCalculationRequired	back 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`

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

org.jboss.logmanager back to summary

pack-priv Class ExtFormatter.WrappedFormatter

Class Inheritance

extends ExtFormatter

java.lang.Object
java.util.logging.Formatter
org.jboss.logmanager.ExtFormatter
org.jboss.logmanager.ExtFormatter.WrappedFormatter

Field Summary

Modifier and Type	Field and Description
private final boolean	formatMessages
private final Formatter	formatter

Constructor Summary

Access	Constructor and Description
pack-priv	WrappedFormatter(Formatter formatter, boolean formatMessages)

Method Summary

Modifier and Type	Method and Description
public String	format(ExtLogRecord the log record record) Implements abstract org.jboss.logmanager.ExtFormatter.format. Format a message using an extended log record.
public String	formatMessage(LogRecord the log record containing the raw message record) Overrides org.jboss.logmanager.ExtFormatter.formatMessage. Localize and format the message string from a log record.
public String	getHead(Handler The target handler (can be null) h) Overrides java.util.logging.Formatter.getHead. Return the header string for a set of formatted records.
public String	getTail(Handler The target handler (can be null) h) Overrides java.util.logging.Formatter.getTail. Return the tail string for a set of formatted records.

Inherited from org.jboss.logmanager.ExtFormatter:: format formatMessageLegacy formatMessageNone formatMessagePrintf isCallerCalculationRequired wrap

Field Detail

formatMessages	back to summary
private final boolean formatMessages

formatter	back to summary
private final Formatter formatter

Constructor Detail

WrappedFormatter	back to summary
pack-priv WrappedFormatter(Formatter formatter, boolean formatMessages)

Method Detail

format	back to summary
public String format(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 Annotations @Override

format

back to summary

public String format(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

Annotations

@Override

formatMessage	back to summary
public String formatMessage(LogRecord record) Overrides org.jboss.logmanager.ExtFormatter.formatMessage. Doc from java.util.logging.Formatter.formatMessage. Localize and format the message string from a log record. This method is provided as a convenience for Formatter subclasses to use when they are performing formatting. The message string is first localized to a format string using the record's ResourceBundle. (If there is no ResourceBundle, or if the message key is not found, then the key is used as the format string.) The format String uses java.text style formatting. If there are no parameters, no formatter is used. Otherwise, if the string contains "{<digit>" where <digit> is in [0-9], java.text.MessageFormat is used to format the string. Otherwise no formatting is performed. Parameters record:LogRecord the log record containing the raw message Returns:String a localized and formatted message Annotations @Override

formatMessage

back to summary

public String formatMessage(LogRecord record)

Overrides org.jboss.logmanager.ExtFormatter.formatMessage.

Doc from java.util.logging.Formatter.formatMessage.

Localize and format the message string from a log record. This method is provided as a convenience for Formatter subclasses to use when they are performing formatting.

If there are no parameters, no formatter is used.
Otherwise, if the string contains "{<digit>" where <digit> is in [0-9], java.text.MessageFormat is used to format the string.
Otherwise no formatting is performed.

Parameters

record:LogRecord: the log record containing the raw message

Returns:String

a localized and formatted message

Annotations

@Override

getHead	back to summary
public String getHead(Handler h) Overrides java.util.logging.Formatter.getHead. Doc from java.util.logging.Formatter.getHead. Return the header string for a set of formatted records. This base class returns an empty string, but this may be overridden by subclasses. Parameters h:Handler The target handler (can be null) Returns:String header string Annotations @Override

getHead

back to summary

public String getHead(Handler h)

Overrides java.util.logging.Formatter.getHead.

Doc from java.util.logging.Formatter.getHead.

Return the header string for a set of formatted records.

This base class returns an empty string, but this may be overridden by subclasses.

Parameters

h:Handler: The target handler (can be null)

Returns:String

header string

Annotations

@Override

getTail	back to summary
public String getTail(Handler h) Overrides java.util.logging.Formatter.getTail. Doc from java.util.logging.Formatter.getTail. Return the tail string for a set of formatted records. This base class returns an empty string, but this may be overridden by subclasses. Parameters h:Handler The target handler (can be null) Returns:String tail string Annotations @Override

getTail

back to summary

public String getTail(Handler h)

Overrides java.util.logging.Formatter.getTail.

Doc from java.util.logging.Formatter.getTail.

Return the tail string for a set of formatted records.

This base class returns an empty string, but this may be overridden by subclasses.

Parameters

h:Handler: The target handler (can be null)

Returns:String

tail string

Annotations

@Override

public abstract Class ExtFormatter

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public abstract Class ExtFormatter.Delegating

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class ExtFormatter.WrappedFormatter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail