java.util.logging

Class Formatter

java.lang.Object

java.util.logging.Formatter

Direct Known Subclasses:

SimpleFormatter, XMLFormatter

public abstract class Formatter
extends Object

Formatter objects are used to format LogRecord objects into a string representation. Head and tail strings are sometimes used to wrap a set of records. The getHead and getTail methods are used for this purpose.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Formatter() Constructs a Formatter object.

Method Summary

Modifier and Type	Method and Description
abstract String	format(LogRecord r) Converts a LogRecord object into a string representation.
String	formatMessage(LogRecord r) Formats a LogRecord object into a localized string representation.
String	getHead(Handler h) Gets the head string used to wrap a set of log records.
String	getTail(Handler h) Gets the tail string used to wrap a set of log records.

Methods inherited from class java.lang.Object

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

Constructor Detail

Formatter

protected Formatter()

Constructs a Formatter object.

Method Detail

format

public abstract String format(LogRecord r)

Converts a LogRecord object into a string representation. The resulted string is usually localized and includes the message field of the record.

Parameters:

r - the log record to be formatted into a string.

Returns:

the formatted string.

formatMessage

public String formatMessage(LogRecord r)

Formats a LogRecord object into a localized string representation. This is a convenience method for subclasses of Formatter.

The message string is firstly localized using the ResourceBundle object associated with the supplied LogRecord.

Notice : if message contains "{0", then java.text.MessageFormat is used. Otherwise no formatting is performed.

Parameters:

r - the log record to be formatted.

Returns:

the string resulted from the formatting.

getHead

public String getHead(Handler h)

Gets the head string used to wrap a set of log records. This base class always returns an empty string.

Parameters:

h - the target handler.

Returns:

the head string used to wrap a set of log records, empty in this implementation.

getTail

public String getTail(Handler h)

Gets the tail string used to wrap a set of log records. This base class always returns the empty string.

Parameters:

h - the target handler.

Returns:

the tail string used to wrap a set of log records, empty in this implementation.