XMLFormatter

AI-generated Key Takeaways

• XMLFormatter formats LogRecord data into a standard XML format as defined in the Java Logging APIs specification.

• It is recommended to use UTF-8 encoding with XMLFormatter, though other character encodings are supported.

• This class provides methods to format log records (format), get the header for a set of XML records (getHead), and get the tail for a set of XML records (getTail).

• XMLFormatter inherits methods from Formatter for general formatting and localization functionalities.

public class XMLFormatter extends Formatter

Format a LogRecord into a standard XML format.

The DTD specification is provided as Appendix A to the Java Logging APIs specification.

The XMLFormatter can be used with arbitrary character encodings, but it is recommended that it normally be used with UTF-8. The character encoding can be set on the output Handler.

Public Constructor Summary

XMLFormatter()

Public Method Summary

String	format(LogRecord record) Format the given message to XML.
String	getHead(Handler h) Return the header string for a set of XML formatted records.
String	getTail(Handler h) Return the tail string for a set of XML formatted records.

Inherited Method Summary

From class java.util.logging.Formatter

abstract String	format(LogRecord record) Format the given log record and return the formatted string.
synchronized 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.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Public Constructors

public XMLFormatter ()

Public Methods

public String format (LogRecord record)

Format the given message to XML.

This method can be overridden in a subclass. It is recommended to use the Formatter.formatMessage(LogRecord) convenience method to localize and format the message field.

Parameters

record	the log record to be formatted.

Returns

• a formatted log record

public String getHead (Handler h)

Return the header string for a set of XML formatted records.

Parameters

h	The target handler (can be null)

Returns

• a valid XML string

public String getTail (Handler h)

Return the tail string for a set of XML formatted records.

Parameters

h	The target handler (can be null)

Returns

• a valid XML string