Build 1.0_r1(from source)

java.util.logging
Class Formatter

java.lang.Object
  extended by 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 sometime used to wrap a set of records. The getHead and getTail methods are presented for this purpose.


Constructor Summary
protected Formatter()
          Constructs a Formatter object.
 
Method Summary
abstract  String format(LogRecord r)
          Formats 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)
Formats a LogRecord object into a string representation. The resulted string is usually localized and includes the message field of the supplied LogRecord object.

Parameters:
r - the log record to be formatted into a string
Returns:
the string resulted from the formatting

formatMessage

public String formatMessage(LogRecord r)
Formats a LogRecord object into a localized string representation. This method can be regarded as a convenience for subclasses of Formatter to use.

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

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 the empty string.

Parameters:
h - the target handler
Returns:
the head string used to wrap a set of log records

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

Build 1.0_r1(from source)

Please submit a feedback, bug or feature