Log4j 1.1b7

org.apache.log4j.xml
Class XMLLayout

java.lang.Object
  |
  +--org.apache.log4j.Layout
        |
        +--org.apache.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://jakarta.apache.org/log4j">
  &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
          Deprecated. Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.
 
Fields inherited from class org.apache.log4j.Layout
LINE_SEP, LINE_SEP_LEN
 
Constructor Summary
XMLLayout()
           
 
Method Summary
 void activateOptions()
          Activate the options that were previously set with calls to option setters.
 String format(LoggingEvent event)
          Formats a LoggingEvent in conformance with the log4j.dtd.
 boolean getLocationInfo()
          Returns the current value of the LocationInfo option.
 String[] getOptionStrings()
          Return list of strings that the OptionHandler instance recognizes.
 boolean ignoresThrowable()
          The XMLLayout prints and does not ignore exceptions.
 void setLocationInfo(boolean flag)
          The LocationInfo option takes a boolean value.
 void setOption(String key, String value)
          Deprecated. Use the setter method for the option directly instead of the generic setOption method.
 
Methods inherited from class org.apache.log4j.Layout
getContentType, getFooter, getHeader
 
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
Deprecated. Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.

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

getOptionStrings

public String[] getOptionStrings()
Deprecated. We now use JavaBeans introspection to configure components. Options strings are no longer needed.

Description copied from interface: OptionHandler
Return list of strings that the OptionHandler instance recognizes.

setOption

public void setOption(String key,
                      String value)
Deprecated. Use the setter method for the option directly instead of the generic setOption method.

The XMLLayout specific options are:

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


setLocationInfo

public void setLocationInfo(boolean flag)
The LocationInfo option takes a boolean value. By default, it is set to false which means there will be no location information output by this layout. If the the option is set to true, then the file name and line number of the statement at the origin of the log statement will be output.

If you are embedding this layout within an SMTPAppender then make sure to set the LocationInfo option of that appender as well.


getLocationInfo

public boolean getLocationInfo()
Returns the current value of the LocationInfo option.

activateOptions

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

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

ignoresThrowable

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

Log4j 1.1b7

Please notify me about new log4j releases.