Apache log4cxx  Version 0.12.0
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

void format (const log4cxx::spi::LoggingEventPtr &event, LogString &toAppendTo, log4cxx::helpers::Pool &p) const
 Formats an event into a string buffer. More...
 
- Public Member Functions inherited from log4cxx::pattern::LoggingEventPatternConverter
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
 

Static Public Member Functions

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

Additional Inherited Members

- Protected Member Functions inherited from log4cxx::pattern::LoggingEventPatternConverter
 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 ()
 
- 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

Formats the message of an logging event.

Member Function Documentation

◆ format()

void log4cxx::pattern::MessagePatternConverter::format ( const log4cxx::spi::LoggingEventPtr event,
LogString toAppendTo,
log4cxx::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: