Added in API level 1

XMLFormatter

open class XMLFormatter : 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.

Summary

Public constructors

Public methods
open String!
format(record: LogRecord!)

Format the given message to XML.

open String!

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

open String!

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

Inherited functions
String! formatMessage(record: LogRecord!)

Localize and format the message string from a log record. This method is provided as a convenience for Formatter subclasses to use when they are performing formatting.

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.

  • If there are no parameters, no formatter is used.
  • Otherwise, if the string contains "{0" then java.text.MessageFormat is used to format the string.
  • Otherwise no formatting is performed.

Public constructors

XMLFormatter

Added in API level 1
XMLFormatter()

Public methods

format

Added in API level 1
open fun format(record: LogRecord!): String!

Format the given message to XML.

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

Parameters
record LogRecord!: the log record to be formatted.
Return
String! a formatted log record

getHead

Added in API level 1
open fun getHead(h: Handler!): String!

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

Parameters
h Handler!: The target handler (can be null)
Return
String! a valid XML string

getTail

Added in API level 1
open fun getTail(h: Handler!): String!

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

Parameters
h Handler!: The target handler (can be null)
Return
String! a valid XML string