Apache Log4cxx  Version 1.2.0
Loading...
Searching...
No Matches
log4cxx::pattern::MessagePatternConverter Class Reference

Formats the message of an logging event. More...

#include <messagepatternconverter.h>

Inheritance diagram for log4cxx::pattern::MessagePatternConverter:
log4cxx::pattern::LoggingEventPatternConverter log4cxx::pattern::PatternConverter log4cxx::helpers::Object

Public Member Functions

 MessagePatternConverter ()
 
void format (const spi::LoggingEventPtr &event, LogString &toAppendTo, helpers::Pool &p) const override
 Formats an event into a string buffer.
 
virtual void format (const spi::LoggingEventPtr &event, LogString &toAppendTo, helpers::Pool &p) const=0
 Formats an event into a string buffer.
 
void format (const helpers::ObjectPtr &obj, LogString &toAppendTo, helpers::Pool &p) const override
 Formats an object into a string buffer.
 
- Public Member Functions inherited from log4cxx::pattern::LoggingEventPatternConverter
virtual void format (const spi::LoggingEventPtr &event, LogString &toAppendTo, helpers::Pool &p) const =0
 Formats an event into a string buffer.
 
void format (const helpers::ObjectPtr &obj, LogString &toAppendTo, helpers::Pool &p) const override
 Formats an object into a string buffer.
 
virtual bool handlesThrowable () const
 Normally pattern converters are not meant to handle Exceptions although few pattern converters might.
 
- Public Member Functions inherited from log4cxx::pattern::PatternConverter
virtual void format (const helpers::ObjectPtr &obj, LogString &toAppendTo, helpers::Pool &p) const =0
 Formats an object into a string buffer.
 
LogString getName () const
 This method returns the name of the conversion pattern.
 
virtual LogString getStyleClass (const 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.
 
- Public Member Functions inherited from log4cxx::helpers::Object
virtual ~Object ()
 
virtual const helpers::ClassgetClass () const =0
 
virtual bool instanceof (const Class &clazz) const =0
 
virtual const void * cast (const Class &clazz) const =0
 

Static Public Member Functions

static PatternConverterPtr newInstance (const std::vector< LogString > &options)
 Obtains an instance of pattern converter.
 

Additional Inherited Members

- Protected Member Functions inherited from log4cxx::pattern::LoggingEventPatternConverter
 LoggingEventPatternConverter (const LogString &name, const LogString &style)
 Constructs an instance of LoggingEventPatternConverter.
 
 LoggingEventPatternConverter (std::unique_ptr< PatternConverterPrivate > priv)
 
- Protected Member Functions inherited from log4cxx::pattern::PatternConverter
 PatternConverter (LOG4CXX_PRIVATE_PTR(PatternConverterPrivate) priv)
 
 PatternConverter (const LogString &name, const LogString &style)
 Create a new pattern converter.
 
virtual ~PatternConverter ()
 
- 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.
 

Detailed Description

Formats the message of an logging event.

Constructor & Destructor Documentation

◆ MessagePatternConverter()

log4cxx::pattern::MessagePatternConverter::MessagePatternConverter ( )

Member Function Documentation

◆ format() [1/3]

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

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.

Reimplemented from log4cxx::pattern::LoggingEventPatternConverter.

◆ format() [2/3]

void log4cxx::pattern::MessagePatternConverter::format ( const spi::LoggingEventPtr event,
LogString toAppendTo,
helpers::Pool p 
) const
overridevirtual

Formats an event into a string buffer.

Parameters
eventevent to format, may not be null.
toAppendTostring buffer to which the formatted event will be appended. May not be null.
ppool for memory allocations needing during format.

Implements log4cxx::pattern::LoggingEventPatternConverter.

◆ format() [3/3]

virtual void log4cxx::pattern::LoggingEventPatternConverter::format ( const spi::LoggingEventPtr event,
LogString toAppendTo,
helpers::Pool p 
) const
virtual

Formats an event into a string buffer.

Parameters
eventevent to format, may not be null.
toAppendTostring buffer to which the formatted event will be appended. May not be null.
ppool for memory allocations needing during format.

Implements log4cxx::pattern::LoggingEventPatternConverter.

◆ newInstance()

static PatternConverterPtr log4cxx::pattern::MessagePatternConverter::newInstance ( const std::vector< LogString > &  options)
static

Obtains an instance of pattern converter.

Parameters
optionsoptions, may be null.
Returns
instance of pattern converter.

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