Class Formatter

java.lang.Object
java.util.logging.Formatter
Direct Known Subclasses:
SimpleFormatter, XMLFormatter
public abstract class Formatter extends Object
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.

Since:
1.4

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Formatter()
    Construct a new formatter.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

    • Formatter

      protected Formatter()
      Construct a new formatter.

  • Method Details

    • format

      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

    • getHead

      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

    • getTail

      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

    • formatMessage

      public 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 "{<digit>" where <digit> is in [0-9], 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