Log4j 0.9.1

org.log4j.xml
Class XMLLayout

java.lang.Object
  |
  +--org.log4j.Layout
        |
        +--org.log4j.xml.XMLLayout
All Implemented Interfaces:
OptionHandler

public class XMLLayout
extends Layout

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 xmlns:log4j="http://log4j.org">
  &data;
</log4j:eventSet>

This approach enforces the independence of the XMLLayout and the appender where it is embedded.

Since:
0.9.0
Author:
Ceki Gülcü

Field Summary
static String LOCATION_INFO_OPTION
          This is a string constant to name the option for setting the location information flag.
 
Fields inherited from class org.log4j.Layout
LINE_SEP, LINE_SEP_LEN
 
Constructor Summary
XMLLayout()
           
 
Method Summary
 void activateOptions()
          Activate the options that were previously set with calls to setOption.
 String format(LoggingEvent event)
          Formats a LoggingEvent in conformance with the log4j.dtd.
 String[] getOptionStrings()
          Return list of strings that the OptionHandler instance recognizes.
 boolean ignoresThrowable()
          The XMLLayout prints and does not ignore exceptions.
 void setOption(String key, String value)
          The XMLLayout specific options are:
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOCATION_INFO_OPTION

public static final String LOCATION_INFO_OPTION
This is a string constant to name the option for setting the location information flag. Current value of this string constant is LocationInfo.

See the setOption(java.lang.String, java.lang.String) method for the meaning of this option.

Note all option keys are case sensitive.

Constructor Detail

XMLLayout

public XMLLayout()
Method Detail

activateOptions

public void activateOptions()
Description copied from interface: OptionHandler
Activate the options that were previously set with calls to setOption.

This allows to defer activiation of the options until all options have been set. This is required for components which have related options that remain ambigous until all are set.

For example, the FileAppender has the "File" and "Append" options both of which are ambigous until the other is also set.


format

public String format(LoggingEvent event)
Formats a LoggingEvent in conformance with the log4j.dtd.
Overrides:
format in class Layout

getOptionStrings

public String[] getOptionStrings()
Description copied from interface: OptionHandler
Return list of strings that the OptionHandler instance recognizes.

ignoresThrowable

public boolean ignoresThrowable()
The XMLLayout prints and does not ignore exceptions. Hence the return value false.
Overrides:
ignoresThrowable in class Layout

setOption

public void setOption(String key,
                      String value)
The XMLLayout specific options are:

The LocationInfo option takes a boolean value. If true, the oupyt will include location information. By default no location information is sent to the server.


Log4j 0.9.1

Please notify me about new log4j releases.