APIdia Launch Partner
Top Description Constructors Methods
java.util.logging

public abstract Class Formatter

extends Object
Class Inheritance
Known Direct Subclasses
java.util.logging.SimpleFormatter, java.util.logging.XMLFormatter
A Formatter provides support for formatting LogRecords.

Typically each logging Handler will have a Formatter associated with it. The Formatter takes a LogRecord and converts it to a string.

Some formatters (such as the XMLFormatter) need to wrap head and tail strings around a set of formatted records. The getHeader and getTail methods can be used to obtain these strings.

Since
1.4

Constructor Summary

AccessConstructor and Description
protected
Formatter()

Construct a new formatter.

Method Summary

Modifier and TypeMethod and Description
public abstract String

Returns:

the formatted log record
format(LogRecord
the log record to be formatted.
record)

Format the given log record and return the formatted string.

public String

Returns:

a localized and formatted message
formatMessage(LogRecord
the log record containing the raw message
record)

Localize and format the message string from a log record.

public String

Returns:

header string
getHead(Handler
The target handler (can be null)
h)

Return the header string for a set of formatted records.

public String

Returns:

tail string
getTail(Handler
The target handler (can be null)
h)

Return the tail string for a set of formatted records.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Formatterback to summary
protected Formatter()

Construct a new formatter.

Method Detail

formatback to summary
public abstract String format(LogRecord record)

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

formatMessageback to summary
public String formatMessage(LogRecord record)

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

getHeadback to summary
public String getHead(Handler h)

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

getTailback to summary
public String getTail(Handler h)

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