SimpleFormatter
, XMLFormatter
public abstract class Formatter extends Object
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.
Modifier | Constructor | Description |
---|---|---|
protected |
Construct a new formatter. |
Modifier and Type | Method | Description |
---|---|---|
abstract String |
format |
Format the given log record and return the formatted string. |
String |
formatMessage |
Localize and format the message string from a log record. |
String |
getHead |
Return the header string for a set of formatted records. |
String |
getTail |
Return the tail string for a set of formatted records. |
protected Formatter()
public abstract String format(LogRecord record)
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)
convenience method to localize and format the message field.
record
- the log record to be formatted.public String getHead(Handler h)
This base class returns an empty string, but this may be overridden by subclasses.
h
- The target handler (can be null)public String getTail(Handler h)
This base class returns an empty string, but this may be overridden by subclasses.
h
- The target handler (can be null)public String formatMessage(LogRecord record)
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.
record
- the log record containing the raw message
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.logging/java/util/logging/Formatter.html