|
Log4j 1.3alpha-7 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.log4j.spi.ComponentBase
org.apache.log4j.Layout
org.apache.log4j.xml.XMLLayout
The output of the XMLLayout consists of a series of log4j:event elements as defined in the log4j.dtd . It does not output a complete well-formed XML file. The output is designed to be included as an external entity in a separate file to form a correct XML file.
For example, if abc
is the name of the file where the
XMLLayout ouput goes, then a well-formed XML file would be:
<?xml version="1.0" ?> <!DOCTYPE log4j:eventSet SYSTEM "log4j.dtd" [<!ENTITY data SYSTEM "abc">]> <log4j:eventSet version="1.2" xmlns:log4j="http://jakarta.apache.org/log4j/"> &data </log4j:eventSet>
This approach enforces the independence of the XMLLayout and the appender where it is embedded.
The version
attribute helps components to correctly intrepret
output generated by XMLLayout. The value of this attribute should be "1.1"
for output generated by log4j versions prior to log4j 1.2 (final release) and
"1.2" for relase 1.2 and later.
Contributors: Mathias Bogaert
Field Summary |
Fields inherited from class org.apache.log4j.Layout |
charArrayWriter, ignoresThrowable, LINE_SEP, LINE_SEP_LEN |
Fields inherited from class org.apache.log4j.spi.ComponentBase |
repository |
Constructor Summary | |
XMLLayout()
Default constructor. |
Method Summary | |
void |
activateOptions()
No options to activate. |
void |
format(Writer output,
LoggingEvent event)
Formats a LoggingEvent in conformance with the log4j.dtd. |
boolean |
getLocationInfo()
Returns the current value of the LocationInfo option. |
void |
setLocationInfo(boolean flag)
The LocationInfo option takes a boolean value. |
Methods inherited from class org.apache.log4j.Layout |
format, getContentType, getFooter, getHeader, ignoresThrowable, setFooter, setHeader, setIgnoresThrowable |
Methods inherited from class org.apache.log4j.spi.ComponentBase |
getLogger, getLoggerRepository, getNonFloodingLogger, resetErrorCount, setLoggerRepository |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public XMLLayout()
Method Detail |
public void setLocationInfo(boolean flag)
If you are embedding this layout within an SMTPAppender
then make sure to set the
LocationInfo option of that appender as well.
public boolean getLocationInfo()
public void activateOptions()
public void format(Writer output, LoggingEvent event) throws IOException
LoggingEvent
in conformance with the log4j.dtd.
format
in class Layout
IOException
|
Log4j 1.3alpha-7 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |