|
Oracle Java ME Embedded | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.oracle.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 java.lang.String |
format(LogRecord record)
Format the given log record and return the formatted string. |
java.lang.String |
formatMessage(LogRecord record)
Localize and format the message string from a log record. |
java.lang.String |
getHead(Handler h)
Return the header string for a set of formatted records. |
java.lang.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 java.lang.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(com.oracle.util.logging.LogRecord)
convenience method to localize and format the message field.
record
- the log record to be formatted.
public java.lang.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 java.lang.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 java.lang.String formatMessage(LogRecord record)
On CLDC the formating and localization is implementation-dependent.
record
- the log record containing the raw message
|
Oracle Java ME Embedded | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |