Formatter (Java SE 9 & JDK 9 ) (original) (raw)

• java.lang.Object

• • java.util.logging.Formatter

• Direct Known Subclasses:
  [SimpleFormatter](../../../java/util/logging/SimpleFormatter.html "class in java.util.logging"), [XMLFormatter](../../../java/util/logging/XMLFormatter.html "class in java.util.logging")

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

  All Methods Instance Methods Abstract Methods Concrete Methods

  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 inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../java/lang/Object.html#clone--), [equals](../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../java/lang/Object.html#finalize--), [getClass](../../../java/lang/Object.html#getClass--), [hashCode](../../../java/lang/Object.html#hashCode--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [toString](../../../java/lang/Object.html#toString--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`

• • Constructor Detail

     * #### Formatter  
     protected Formatter​()  
     Construct a new formatter.  

  • Method Detail

    * #### format  
    public abstract [String](../../../java/lang/String.html "class in java.lang") format​([LogRecord](../../../java/util/logging/LogRecord.html "class in java.util.logging") 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(java.util.logging.LogRecord)](../../../java/util/logging/Formatter.html#formatMessage-java.util.logging.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](../../../java/lang/String.html "class in java.lang") getHead​([Handler](../../../java/util/logging/Handler.html "class in java.util.logging") 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](../../../java/lang/String.html "class in java.lang") getTail​([Handler](../../../java/util/logging/Handler.html "class in java.util.logging") 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](../../../java/lang/String.html "class in java.lang") formatMessage​([LogRecord](../../../java/util/logging/LogRecord.html "class in java.util.logging") 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

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.