Layout Class Reference

Inheritance diagram for Layout:

OptionHandler ObjectImpl Object Object DateLayout HTMLLayout PatternLayout SimpleLayout XMLLayout TTCCLayout List of all members.

Public Member Functions

virtual void format (ostream &output, const spi::LoggingEventPtr &event) const =0
virtual String getContentType () const
virtual void appendHeader (ostream &output)
virtual void appendFooter (ostream &output)
virtual bool ignoresThrowable () const =0

Detailed Description

Extend this abstract class to create your own log layout format.


Member Function Documentation

virtual void appendFooter ( ostream &  output  )  [inline, virtual]

Append the footer for the layout format. The base class does nothing.

Reimplemented in HTMLLayout.

virtual void appendHeader ( ostream &  output  )  [inline, virtual]

Append the header for the layout format. The base class does nothing.

Reimplemented in HTMLLayout.

virtual void format ( ostream &  output,
const spi::LoggingEventPtr event 
) const [pure virtual]

Implement this method to create your own layout format.

Implemented in HTMLLayout, PatternLayout, SimpleLayout, TTCCLayout, and XMLLayout.

virtual String getContentType (  )  const [inline, virtual]

Returns the content type output by this layout. The base class returns "text/plain".

Reimplemented in HTMLLayout.

virtual bool ignoresThrowable (  )  const [pure virtual]

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.

Implemented in HTMLLayout, PatternLayout, SimpleLayout, TTCCLayout, and XMLLayout.


The documentation for this class was generated from the following file:
Generated on Sat Feb 9 16:52:11 2008 for log4cxx by  doxygen 1.4.7