org.wildfly.swarm.config.logging

Class XmlFormatter<T extends XmlFormatter<T>>

java.lang.Object

org.wildfly.swarm.config.logging.XmlFormatter<T>

public class XmlFormatter<T extends XmlFormatter<T>>
extends Object

A formatter that formats log messages in XML.

Constructor Summary

Constructors

Constructor and Description
XmlFormatter(String key)

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a property change listener
String	dateFormat() The date/time format pattern.
T	dateFormat(String value) The date/time format pattern.
ExceptionOutputType	exceptionOutputType() Indicates how the cause of the logged message, if one is available, will be added to the XML output.
T	exceptionOutputType(ExceptionOutputType value) Indicates how the cause of the logged message, if one is available, will be added to the XML output.
String	getKey()
T	keyOverride(String key, Object value) Allows the names of the keys for the XML properties to be overridden.
Map	keyOverrides() Allows the names of the keys for the XML properties to be overridden.
T	keyOverrides(Map value) Allows the names of the keys for the XML properties to be overridden.
Map	metaData() Sets the meta data to use in the XML format.
T	metaData(Map value) Sets the meta data to use in the XML format.
T	metaDatum(String key, Object value) Sets the meta data to use in the XML format.
String	namespaceUri() Sets the namespace URI used for each record if print-namespace attribute is true.
T	namespaceUri(String value) Sets the namespace URI used for each record if print-namespace attribute is true.
Boolean	prettyPrint() Indicates whether or not pretty printing should be used when formatting.
T	prettyPrint(Boolean value) Indicates whether or not pretty printing should be used when formatting.
Boolean	printDetails() Sets whether or not details should be printed.
T	printDetails(Boolean value) Sets whether or not details should be printed.
Boolean	printNamespace() Turns on or off the printing of the namespace for each .
T	printNamespace(Boolean value) Turns on or off the printing of the namespace for each .
String	recordDelimiter() The value to be used to indicate the end of a record.
T	recordDelimiter(String value) The value to be used to indicate the end of a record.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a property change listener
String	zoneId() The zone ID for formatting the date and time.
T	zoneId(String value) The zone ID for formatting the date and time.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlFormatter

public XmlFormatter(String key)

Method Detail

getKey

public String getKey()

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Adds a property change listener

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes a property change listener

dateFormat

public String dateFormat()

The date/time format pattern. The pattern must be a valid java.time.format.DateTimeFormatter.ofPattern() pattern. The default pattern is an ISO-8601 extended offset date-time format.

dateFormat

public T dateFormat(String value)

The date/time format pattern. The pattern must be a valid java.time.format.DateTimeFormatter.ofPattern() pattern. The default pattern is an ISO-8601 extended offset date-time format.

exceptionOutputType

public ExceptionOutputType exceptionOutputType()

Indicates how the cause of the logged message, if one is available, will be added to the XML output.

exceptionOutputType

public T exceptionOutputType(ExceptionOutputType value)

Indicates how the cause of the logged message, if one is available, will be added to the XML output.

keyOverrides

public Map keyOverrides()

Allows the names of the keys for the XML properties to be overridden.

keyOverrides

public T keyOverrides(Map value)

Allows the names of the keys for the XML properties to be overridden.

keyOverride

public T keyOverride(String key,
                     Object value)

Allows the names of the keys for the XML properties to be overridden.

metaData

public Map metaData()

Sets the meta data to use in the XML format. Properties will be added to each log message.

metaData

public T metaData(Map value)

Sets the meta data to use in the XML format. Properties will be added to each log message.

metaDatum

public T metaDatum(String key,
                   Object value)

Sets the meta data to use in the XML format. Properties will be added to each log message.

namespaceUri

public String namespaceUri()

Sets the namespace URI used for each record if print-namespace attribute is true. Note that if no namespace-uri is defined and there are overridden keys no namespace will be written regardless if the print-namespace attribute is set to true.

namespaceUri

public T namespaceUri(String value)

Sets the namespace URI used for each record if print-namespace attribute is true. Note that if no namespace-uri is defined and there are overridden keys no namespace will be written regardless if the print-namespace attribute is set to true.

prettyPrint

public Boolean prettyPrint()

Indicates whether or not pretty printing should be used when formatting.

prettyPrint

public T prettyPrint(Boolean value)

Indicates whether or not pretty printing should be used when formatting.

printDetails

public Boolean printDetails()

Sets whether or not details should be printed. Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name, source module name, source module version and source line number.

printDetails

public T printDetails(Boolean value)

Sets whether or not details should be printed. Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name, source module name, source module version and source line number.

printNamespace

public Boolean printNamespace()

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

printNamespace

public T printNamespace(Boolean value)

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

recordDelimiter

public String recordDelimiter()

The value to be used to indicate the end of a record. If set to null no delimiter will be used at the end of the record. The default value is a line feed.

recordDelimiter

public T recordDelimiter(String value)

The value to be used to indicate the end of a record. If set to null no delimiter will be used at the end of the record. The default value is a line feed.

zoneId

public String zoneId()

The zone ID for formatting the date and time. The system default is used if left undefined.

zoneId

public T zoneId(String value)

The zone ID for formatting the date and time. The system default is used if left undefined.