Module org.jboss.logmanager

Package org.jboss.logmanager.formatters

Class XmlFormatter

java.lang.Object

java.util.logging.Formatter

org.jboss.logmanager.ExtFormatter

org.jboss.logmanager.formatters.StructuredFormatter

org.jboss.logmanager.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.formatters.StructuredFormatter

StructuredFormatter.ExceptionOutputType, StructuredFormatter.Generator, StructuredFormatter.Key

Nested classes/interfaces inherited from class org.jboss.logmanager.ExtFormatter

ExtFormatter.Delegating

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_NAMESPACE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected StructuredFormatter.Generator	createGenerator(Writer writer)	Creates the generator used to create the structured data.
String	getNamespaceUri()	Returns the namespace URI used for each record if isPrintNamespace() is true.
boolean	isPrettyPrint()	Indicates whether or not pretty printing is enabled.
boolean	isPrintNamespace()	Indicates whether or not the name space should be written on the <record/>.
void	setNamespaceUri(String namespaceUri)	Sets the namespace URI used for each record if isPrintNamespace() is true.
void	setPrettyPrint(boolean prettyPrint)	Turns on or off pretty printing.
void	setPrintNamespace(boolean printNamespace)	Turns on or off the printing of the namespace for each <record/>.

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

after, before, format, getDateTimeFormatter, getExceptionOutputType, getKey, getKeyOverrides, getMetaData, getRecordDelimiter, getZoneId, isCallerCalculationRequired, isDetailedExceptionOutputType, isFormattedExceptionOutputType, isPrintDetails, setDateFormat, setExceptionOutputType, setMetaData, setPrintDetails, setRecordDelimiter, setZoneId

Methods inherited from class org.jboss.logmanager.ExtFormatter

format, formatMessage, formatMessageLegacy, formatMessageNone, formatMessagePrintf, wrap

Methods inherited from class java.util.logging.Formatter

getHead, getTail

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_NAMESPACE

public static final String DEFAULT_NAMESPACE

See Also:

Constant Field Values

Constructor Detail

XmlFormatter

public XmlFormatter()

Creates a new XML formatter.

XmlFormatter

public XmlFormatter(String keyOverrides)

Creates a new XML formatter.

If the keyOverrides is empty the default namespace will be used.

Parameters:

keyOverrides - a string representation of a map to override keys

See Also:

PropertyValues.stringToEnumMap(Class, String)

XmlFormatter

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

Creates a new XML formatter.

If the keyOverrides is empty the default namespace will be used.

Parameters:

keyOverrides - a map of overrides for the default keys

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

Turns on or off pretty printing.

Parameters:

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

isPrintNamespace

public boolean isPrintNamespace()

Indicates whether or not the name space should be written on the <record/>.

Returns:

true if the name space should be written for each record

setPrintNamespace

public void setPrintNamespace(boolean printNamespace)

Turns on or off the printing of the namespace for each <record/>. This is set to false by default.

Parameters:

printNamespace - true if the name space should be written for each record

getNamespaceUri

public String getNamespaceUri()

Returns the namespace URI used for each record if isPrintNamespace() is true.

Returns:

the namespace URI, may be null if explicitly set to null

setNamespaceUri

public void setNamespaceUri(String namespaceUri)

Sets the namespace URI used for each record if isPrintNamespace() is true.

Parameters:

namespaceUri - the namespace to use or null if no namespace URI should be used regardless of the isPrintNamespace() value

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