XMLFormatter (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.util.logging
class XMLFormatter

java.lang.Object
  java.util.logging.Formatter
      java.util.logging.XMLFormatter

Most common way to construct:

XMLFormatter xmlfrmtr = new XMLFormatter();

Based on 12 examples

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.

Constructor Summary
`XMLFormatter()`

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.

Methods inherited from class java.util.logging.Formatter
`format, formatMessage, getHead, getTail`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

XMLFormatter

public XMLFormatter()

Method Detail

format

public String format(LogRecord record)

Format the given message to XML.

Overrides:: format in class Formatter
Parameters:: record - the log record to be formatted.
Returns:: a formatted log record

getHead

public String getHead(Handler h)

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

Overrides:: getHead in class Formatter
Parameters:: h - The target handler (can be null)
Returns:: a valid XML string

getTail

public String getTail(Handler h)

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

Overrides:: getTail in class Formatter
Parameters:: h - The target handler (can be null)
Returns:: a valid XML string