Log4j 1.1b7

org.apache.log4j
Class SimpleLayout

java.lang.Object
  |
  +--org.apache.log4j.Layout
        |
        +--org.apache.log4j.SimpleLayout
All Implemented Interfaces:
OptionHandler

public class SimpleLayout
extends Layout

SimpleLayout consists of the priority of the log statement, followed by " - " and then the log message itself. For example,

DEBUG - Hello world

Since:
version 0.7.0

PatternLayout offers a much more powerful alternative.

Author:
Ceki Gülcü

Fields inherited from class org.apache.log4j.Layout
LINE_SEP, LINE_SEP_LEN
 
Constructor Summary
SimpleLayout()
           
 
Method Summary
 void activateOptions()
          Activate the options that were previously set with calls to option setters.
 String format(LoggingEvent event)
          Returns the log statement in a format consisting of the priority, followed by " - " and then the message.
 String[] getOptionStrings()
          Return list of strings that the OptionHandler instance recognizes.
 boolean ignoresThrowable()
          The SimpleLayout does not handle the throwable contained within LoggingEvents.
 void setOption(String option, String value)
          Set option to value.
 
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
 

Constructor Detail

SimpleLayout

public SimpleLayout()
Method Detail

getOptionStrings

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

setOption

public void setOption(String option,
                      String value)
Description copied from interface: OptionHandler
Set option to value.

The handling of each option depends on the OptionHandler instance. Some options may become active immediately whereas other may be activated only when OptionHandler.activateOptions() is called.


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)
Returns the log statement in a format consisting of the priority, followed by " - " and then the message. For example,
 INFO - "A message"

The category parameter is ignored.

Overrides:
format in class Layout
Returns:
A byte array in SimpleLayout format.

ignoresThrowable

public boolean ignoresThrowable()
The SimpleLayout does not handle the throwable contained within LoggingEvents. Thus, it returns true.
Overrides:
ignoresThrowable in class Layout
Since:
version 0.8.4

Log4j 1.1b7

Please notify me about new log4j releases.