Apache log4cxx  Version 0.12.0
log4cxx::pattern::LoggingEventPatternConverter Class Referenceabstract

LoggingEventPatternConverter is a base class for pattern converters that can format information from instances of LoggingEvent. More...

#include <loggingeventpatternconverter.h>

Inheritance diagram for log4cxx::pattern::LoggingEventPatternConverter:
log4cxx::pattern::PatternConverter log4cxx::helpers::Object log4cxx::pattern::DatePatternConverter log4cxx::pattern::FileLocationPatternConverter log4cxx::pattern::FullLocationPatternConverter log4cxx::pattern::LevelPatternConverter log4cxx::pattern::LineLocationPatternConverter log4cxx::pattern::LineSeparatorPatternConverter log4cxx::pattern::LiteralPatternConverter log4cxx::pattern::MessagePatternConverter log4cxx::pattern::MethodLocationPatternConverter log4cxx::pattern::NamePatternConverter log4cxx::pattern::NDCPatternConverter log4cxx::pattern::PropertiesPatternConverter log4cxx::pattern::RelativeTimePatternConverter log4cxx::pattern::ThreadPatternConverter log4cxx::pattern::ThrowableInformationPatternConverter

Public Member Functions

virtual void format (const log4cxx::spi::LoggingEventPtr &event, LogString &toAppendTo, log4cxx::helpers::Pool &p) const =0
 Formats an event into a string buffer. More...
 
void format (const log4cxx::helpers::ObjectPtr &obj, LogString &toAppendTo, log4cxx::helpers::Pool &p) const
 Formats an object into a string buffer. More...
 
virtual bool handlesThrowable () const
 Normally pattern converters are not meant to handle Exceptions although few pattern converters might. More...
 
- Public Member Functions inherited from log4cxx::pattern::PatternConverter
 DECLARE_LOG4CXX_PATTERN (PatternConverter)
 
 BEGIN_LOG4CXX_CAST_MAP ()
 
 LOG4CXX_CAST_ENTRY (PatternConverter)
 
 END_LOG4CXX_CAST_MAP ()
 
LogString getName () const
 This method returns the name of the conversion pattern. More...
 
virtual LogString getStyleClass (const log4cxx::helpers::ObjectPtr &e) const
 This method returns the CSS style class that should be applied to the LoggingEvent passed as parameter, which can be null. More...
 
- Public Member Functions inherited from log4cxx::helpers::Object
virtual ~Object ()
 
virtual bool instanceof (const Class &clazz) const =0
 
virtual const void * cast (const Class &clazz) const =0
 

Protected Member Functions

 LoggingEventPatternConverter (const LogString &name, const LogString &style)
 Constructs an instance of LoggingEventPatternConverter. More...
 
- Protected Member Functions inherited from log4cxx::pattern::PatternConverter
 PatternConverter (const LogString &name, const LogString &style)
 Create a new pattern converter. More...
 
virtual ~PatternConverter ()
 

Additional Inherited Members

- Static Protected Member Functions inherited from log4cxx::pattern::PatternConverter
static void append (LogString &toAppendTo, const std::string &src)
 Appends content in the locale code page to a LogString. More...
 

Detailed Description

LoggingEventPatternConverter is a base class for pattern converters that can format information from instances of LoggingEvent.

Constructor & Destructor Documentation

◆ LoggingEventPatternConverter()

log4cxx::pattern::LoggingEventPatternConverter::LoggingEventPatternConverter ( const LogString name,
const LogString style 
)
protected

Constructs an instance of LoggingEventPatternConverter.

Parameters
namename of converter.
styleCSS style for output.

Member Function Documentation

◆ format() [1/2]

◆ format() [2/2]

void log4cxx::pattern::LoggingEventPatternConverter::format ( const log4cxx::helpers::ObjectPtr obj,
LogString toAppendTo,
log4cxx::helpers::Pool p 
) const
virtual

Formats an object into a string buffer.

Parameters
objevent to format, may not be null.
toAppendTostring buffer to which the formatted event will be appended. May not be null.
ppool for any allocations necessary during formatting.

Implements log4cxx::pattern::PatternConverter.

◆ handlesThrowable()

virtual bool log4cxx::pattern::LoggingEventPatternConverter::handlesThrowable ( ) const
virtual

Normally pattern converters are not meant to handle Exceptions although few pattern converters might.

By examining the return values for this method, the containing layout will determine whether it handles throwables or not.

Returns
true if this PatternConverter handles throwables

Reimplemented in log4cxx::pattern::ThrowableInformationPatternConverter.


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