Skip to content

Most visited

Recently visited

navigation

Formatter

public abstract class Formatter
extends Object

java.lang.Object
   ↳ java.util.logging.Formatter
Known Direct Subclasses


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.

Summary

Protected constructors

Formatter()

Construct a new formatter.

Public methods

abstract String format(LogRecord record)

Format the given log record and return the formatted string.

String formatMessage(LogRecord record)

Localize and format the message string from a log record.

String getHead(Handler h)

Return the header string for a set of formatted records.

String getTail(Handler h)

Return the tail string for a set of formatted records.

Inherited methods

From class java.lang.Object

Protected constructors

Formatter

Added in API level 1
Formatter ()

Construct a new formatter.

Public methods

format

Added in API level 1
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 formatMessage(LogRecord) convenience method to localize and format the message field.

Parameters
record LogRecord: the log record to be formatted.
Returns
String the formatted log record

formatMessage

Added in API level 1
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 "{0" then 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

Added in API level 1
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

getTail

Added in API level 1
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
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.