XMLFormatter

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

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

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 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