org.apache.log.format

Class XMLFormatter

public class XMLFormatter extends Object implements Formatter

Basic XML formatter that writes out a basic XML-ified log event. Note that this formatter assumes that the category and context values will produce strings that do not need to be escaped in XML.

Author: Peter Donald

Field Summary
static StringEOL
booleanm_printCategory
booleanm_printContext
booleanm_printException
booleanm_printMessage
booleanm_printNumericTime
booleanm_printPriority
booleanm_printRelativeTime
booleanm_printTime
Method Summary
Stringformat(LogEvent event)
Format log event into string.
voidsetPrintCategory(boolean printCategory)
Print out category field to log.
voidsetPrintContext(boolean printContext)
Print out context field to log.
voidsetPrintException(boolean printException)
Print out exception field to log.
voidsetPrintMessage(boolean printMessage)
Print out message field to log.
voidsetPrintPriority(boolean printPriority)
Print out priority field to log.
voidsetPrintRelativeTime(boolean printRelativeTime)
Print out relativeTime field to log.
voidsetPrintTime(boolean printTime)
Print out time field to log.

Field Detail

EOL

private static final String EOL

m_printCategory

private boolean m_printCategory

m_printContext

private boolean m_printContext

m_printException

private boolean m_printException

m_printMessage

private boolean m_printMessage

m_printNumericTime

private boolean m_printNumericTime

m_printPriority

private boolean m_printPriority

m_printRelativeTime

private boolean m_printRelativeTime

m_printTime

private boolean m_printTime

Method Detail

format

public String format(LogEvent event)
Format log event into string.

Parameters: event the event

Returns: the formatted string

setPrintCategory

public void setPrintCategory(boolean printCategory)
Print out category field to log.

Parameters: printCategory true to print category, false otherwise

setPrintContext

public void setPrintContext(boolean printContext)
Print out context field to log.

Parameters: printContext true to print context, false otherwise

setPrintException

public void setPrintException(boolean printException)
Print out exception field to log.

Parameters: printException true to print exception, false otherwise

setPrintMessage

public void setPrintMessage(boolean printMessage)
Print out message field to log.

Parameters: printMessage true to print message, false otherwise

setPrintPriority

public void setPrintPriority(boolean printPriority)
Print out priority field to log.

Parameters: printPriority true to print priority, false otherwise

setPrintRelativeTime

public void setPrintRelativeTime(boolean printRelativeTime)
Print out relativeTime field to log.

Parameters: printRelativeTime true to print relativeTime, false otherwise

setPrintTime

public void setPrintTime(boolean printTime)
Print out time field to log.

Parameters: printTime true to print time, false otherwise