Formatter

public abstract class Formatter extends Object

Known Direct Subclasses SimpleFormatter, XMLFormatter SimpleFormatter Print a brief summary of the LogRecord in a human readable format.  XMLFormatter Format a LogRecord into a standard XML format.

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.

Protected Constructor Summary

Formatter() Construct a new formatter.

Public Method Summary

abstract String	format(LogRecord record) Format the given log record and return the formatted string.
synchronized 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 Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Protected Constructors

protected Formatter ()

Construct a new formatter.

Public Methods

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

Parameters

record	the log record to be formatted.

Returns

• the formatted log record

public synchronized 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	the log record containing the raw message

Returns

• a localized and formatted message

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	The target handler (can be null)

Returns

• header string

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	The target handler (can be null)

Returns

• tail string