org.apache.log4j

Class Layout

Implemented Interfaces:
OptionHandler
Known Direct Subclasses:
DateLayout, HTMLLayout, PatternLayout, SimpleLayout, XMLLayout

public abstract class Layout
extends Object
implements OptionHandler

Extend this abstract class to create your own log layout format.
Author:
Ceki Gülcü

Field Summary

static String
LINE_SEP
static int
LINE_SEP_LEN

Method Summary

abstract String
format(LoggingEvent event)
Implement this method to create your own layout format.
String
getContentType()
Returns the content type output by this layout.
String
getFooter()
Returns the footer for the layout format.
String
getHeader()
Returns the header for the layout format.
abstract boolean
ignoresThrowable()
If the layout handles the throwable object contained within LoggingEvent, then the layout should return false.

Field Details

LINE_SEP

public static final String LINE_SEP

LINE_SEP_LEN

public static final int LINE_SEP_LEN

Method Details

format

public abstract String format(LoggingEvent event)
Implement this method to create your own layout format.

getContentType

public String getContentType()
Returns the content type output by this layout. The base class returns "text/plain".

getFooter

public String getFooter()
Returns the footer for the layout format. The base class returns null.

getHeader

public String getHeader()
Returns the header for the layout format. The base class returns null.

ignoresThrowable

public abstract boolean ignoresThrowable()
If the layout handles the throwable object contained within LoggingEvent, then the layout should return false. Otherwise, if the layout ignores throwable object, then the layout should return true.

The SimpleLayout, TTCCLayout, PatternLayout all return true. The XMLLayout returns false.

Since:
0.8.4

Copyright 2000-2005 Apache Software Foundation.