org.jboss.logmanager.ext.formatters

Class XmlFormatter

java.lang.Object

java.util.logging.Formatter

org.jboss.logmanager.ExtFormatter

org.jboss.logmanager.ext.formatters.StructuredFormatter

org.jboss.logmanager.ext.formatters.XmlFormatter

public class XmlFormatter
extends StructuredFormatter

A formatter that outputs the record in XML format.

The details include;

• source class name
• source file name
• source method name
• source line number

Author:

James R. Perkins

Nested Class Summary

Nested classes/interfaces inherited from class org.jboss.logmanager.ext.formatters.StructuredFormatter

StructuredFormatter.Generator, StructuredFormatter.Key

Field Summary

Fields inherited from class org.jboss.logmanager.ext.formatters.StructuredFormatter

DEFAULT_DATE_FORMAT

Constructor Summary

Constructors

Constructor and Description
XmlFormatter() Creates a new XML formatter
XmlFormatter(Map<StructuredFormatter.Key,String> keyOverrides) Creates a new XML formatter.

Method Summary

Modifier and Type	Method and Description
protected StructuredFormatter.Generator	createGenerator(Writer writer) Creates the generator used to create the structured data.
boolean	isPrettyPrint() Indicates whether or not pretty printing is enabled.
void	setPrettyPrint(boolean b) Turns on or off pretty printing.

Methods inherited from class org.jboss.logmanager.ext.formatters.StructuredFormatter

after, before, format, getDateFormat, getKey, getMetaData, isAppendEndOfLine, isPrintDetails, setAppendEndOfLine, setDateFormat, setMetaData, setPrintDetails

Methods inherited from class org.jboss.logmanager.ExtFormatter

format

Methods inherited from class java.util.logging.Formatter

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

Creates a new XML formatter

XmlFormatter

public XmlFormatter(Map<StructuredFormatter.Key,String> keyOverrides)

Creates a new XML formatter.

Parameters:

keyOverrides - a map of the default keys to override

Method Detail

isPrettyPrint

public boolean isPrettyPrint()

Indicates whether or not pretty printing is enabled.

Returns:

true if pretty printing is enabled, otherwise false

setPrettyPrint

public void setPrettyPrint(boolean b)

Turns on or off pretty printing.

Parameters:

b - true to turn on pretty printing or false to turn it off

createGenerator

protected StructuredFormatter.Generator createGenerator(Writer writer)
                                                 throws Exception

Description copied from class: StructuredFormatter

Creates the generator used to create the structured data.

Specified by:

createGenerator in class StructuredFormatter

Returns:

the generator to use

Throws:

Exception - if an error occurs creating the generator