Package org.apache.log4j
Class Layout
- java.lang.Object
-
- org.apache.log4j.Layout
-
- All Implemented Interfaces:
OptionHandler
- Direct Known Subclasses:
DateLayout
,EnhancedPatternLayout
,HTMLLayout
,PatternLayout
,SimpleLayout
,XMLLayout
public abstract class Layout extends java.lang.Object implements OptionHandler
Extend this abstract class to create your own log layout format.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
LINE_SEP
static int
LINE_SEP_LEN
-
Constructor Summary
Constructors Constructor Description Layout()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract java.lang.String
format(LoggingEvent event)
Implement this method to create your own layout format.java.lang.String
getContentType()
Returns the content type output by this layout.java.lang.String
getFooter()
Returns the footer for the layout format.java.lang.String
getHeader()
Returns the header for the layout format.abstract boolean
ignoresThrowable()
If the layout handles the throwable object contained withinLoggingEvent
, then the layout should returnfalse
.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.log4j.spi.OptionHandler
activateOptions
-
-
-
-
Method Detail
-
format
public abstract java.lang.String format(LoggingEvent event)
Implement this method to create your own layout format.
-
getContentType
public java.lang.String getContentType()
Returns the content type output by this layout. The base class returns "text/plain".
-
getHeader
public java.lang.String getHeader()
Returns the header for the layout format. The base class returnsnull
.
-
getFooter
public java.lang.String getFooter()
Returns the footer for the layout format. The base class returnsnull
.
-
ignoresThrowable
public abstract boolean ignoresThrowable()
If the layout handles the throwable object contained withinLoggingEvent
, then the layout should returnfalse
. Otherwise, if the layout ignores throwable object, then the layout should returntrue
. If ignoresThrowable is true, the appender is responsible for rendering the throwable.The
SimpleLayout
,TTCCLayout
,PatternLayout
all returntrue
. TheXMLLayout
returnsfalse
.- Since:
- 0.8.4
-
-