|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.logging.Formatter
public abstract class Formatter
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 Summary | |
---|---|
protected |
Formatter()
Construct a new formatter. |
Method Summary | |
---|---|
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 |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected Formatter()
Method Detail |
---|
public abstract String format(LogRecord record)
The resulting formatted String will normally include a localized and formated version of the LogRecord's message field. The Formatter.formatMessage convenience method can (optionally) be used 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 overriden 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 overriden 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
|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 1993, 2010, Oracle and/or its affiliates. All rights reserved.