Log4j 1.3alpha-7

org.apache.log4j
Class SimpleLayout

java.lang.Object
  extended byorg.apache.log4j.spi.ComponentBase
      extended byorg.apache.log4j.Layout
          extended byorg.apache.log4j.SimpleLayout
All Implemented Interfaces:
Component, OptionHandler

public class SimpleLayout
extends Layout

SimpleLayout consists of the level 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ü

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
SimpleLayout()
           
 
Method Summary
 void activateOptions()
          Activate the options that were previously set with calls to option setters.
 void format(Writer output, LoggingEvent event)
          Writes the log statement in a format consisting of the level, followed by " - " and then the message.
 
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

SimpleLayout

public SimpleLayout()
Method Detail

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 void format(Writer output,
                   LoggingEvent event)
            throws IOException
Writes the log statement in a format consisting of the level, followed by " - " and then the message. For example,
 INFO - "A message"
         

The category parameter is ignored.

Specified by:
format in class Layout
Parameters:
event - The LoggingEvent to format and write
output - The java.io.Writer to write to
Throws:
IOException

Log4j 1.3alpha-7

Copyright 2000-2005 Apache Software Foundation.