Save This Page
Home » openjdk-7 » java » util » logging » [javadoc | source]
java.util.logging
abstract public class: Formatter [javadoc | source]
java.lang.Object
   java.util.logging.Formatter

Direct Known Subclasses:
    SimpleFormatter, 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.

Constructor:
 protected Formatter() 
Method from java.util.logging.Formatter Summary:
format,   formatMessage,   getHead,   getTail
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.util.logging.Formatter Detail:
 abstract public String format(LogRecord record)
    Format the given log record and return the formatted string.

    The resulting formatted String will normally include a localized and formated version of the LogRecord's message field. It is recommended to use the Formatter#formatMessage convenience method to localize and format the message field.

 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.

 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 overriden by subclasses.

 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 overriden by subclasses.