Apache log4cxx (Incubating)  Version 0.10.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups
Layout Class Referenceabstract

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

Inheritance diagram for Layout:
OptionHandler ObjectImpl Object Object DateLayout HTMLLayout PatternLayout SimpleLayout XMLLayout TTCCLayout

Public Member Functions

virtual ~Layout ()
 
void addRef () const
 
void releaseRef () const
 
virtual void format (LogString &output, const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool) const =0
 Implement this method to create your own layout format. More...
 
virtual LogString getContentType () const
 Returns the content type output by this layout. More...
 
virtual void appendHeader (LogString &output, log4cxx::helpers::Pool &p)
 Append the header for the layout format. More...
 
virtual void appendFooter (LogString &output, log4cxx::helpers::Pool &p)
 Append the footer for the layout format. More...
 
virtual bool ignoresThrowable () const =0
 If the layout handles the throwable object contained within LoggingEvent, then the layout should return false. More...
 
- Public Member Functions inherited from OptionHandler
virtual ~OptionHandler ()
 
virtual void activateOptions (log4cxx::helpers::Pool &p)=0
 Activate the options that were previously set with calls to option setters. More...
 
virtual void setOption (const LogString &option, const LogString &value)=0
 Set option to value. More...
 
- Public Member Functions inherited from Object
virtual const helpers::ClassgetClass () const
 
virtual ~Object ()
 
virtual bool instanceof (const Class &clazz) const =0
 
virtual const void * cast (const Class &clazz) const =0
 
- Public Member Functions inherited from ObjectImpl
 ObjectImpl ()
 
virtual ~ObjectImpl ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
static const helpers::ClassgetStaticClass ()
 
static const
log4cxx::helpers::ClassRegistration
registerClass ()
 
- Protected Attributes inherited from ObjectImpl
unsigned int volatile ref
 

Detailed Description

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

Constructor & Destructor Documentation

virtual ~Layout ( )
virtual

Member Function Documentation

void addRef ( ) const
virtual

Reimplemented from ObjectImpl.

virtual void appendFooter ( LogString output,
log4cxx::helpers::Pool p 
)
virtual

Append the footer for the layout format.

The base class does nothing.

Reimplemented in HTMLLayout.

virtual void appendHeader ( LogString output,
log4cxx::helpers::Pool p 
)
virtual

Append the header for the layout format.

The base class does nothing.

Reimplemented in HTMLLayout.

virtual void format ( LogString output,
const spi::LoggingEventPtr event,
log4cxx::helpers::Pool pool 
) const
pure virtual

Implement this method to create your own layout format.

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

virtual LogString getContentType ( ) const
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 PatternLayout, TTCCLayout, XMLLayout, HTMLLayout, and SimpleLayout.

void releaseRef ( ) const
virtual

Reimplemented from ObjectImpl.


The documentation for this class was generated from the following file: