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

#include <patternconverter.h>

Inheritance diagram for log4cxx::pattern::PatternConverter:
log4cxx::helpers::Object log4cxx::pattern::IntegerPatternConverter log4cxx::pattern::LoggingEventPatternConverter 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

 DECLARE_LOG4CXX_PATTERN (PatternConverter)
 
 BEGIN_LOG4CXX_CAST_MAP ()
 
 LOG4CXX_CAST_ENTRY (PatternConverter)
 
 END_LOG4CXX_CAST_MAP ()
 
virtual void format (const log4cxx::helpers::ObjectPtr &obj, LogString &toAppendTo, log4cxx::helpers::Pool &p) const =0
 Formats an object into a string buffer. More...
 
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

 PatternConverter (const LogString &name, const LogString &style)
 Create a new pattern converter. More...
 
virtual ~PatternConverter ()
 

Static Protected Member Functions

static void append (LogString &toAppendTo, const std::string &src)
 Appends content in the locale code page to a LogString. More...
 

Detailed Description

PatternConverter is an abstract class that provides the formatting functionality that derived classes need.

Conversion specifiers in a conversion patterns are parsed to individual PatternConverters. Each of which is responsible for converting an object in a converter specific manner.

Constructor & Destructor Documentation

◆ PatternConverter()

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

Create a new pattern converter.

Parameters
namename for pattern converter.
styleCSS style for formatted output.

◆ ~PatternConverter()

virtual log4cxx::pattern::PatternConverter::~PatternConverter ( )
protectedvirtual

Member Function Documentation

◆ append()

static void log4cxx::pattern::PatternConverter::append ( LogString toAppendTo,
const std::string &  src 
)
staticprotected

Appends content in the locale code page to a LogString.

Parameters
toAppendTostring to which content is appended.
srccontent.

◆ BEGIN_LOG4CXX_CAST_MAP()

log4cxx::pattern::PatternConverter::BEGIN_LOG4CXX_CAST_MAP ( )

◆ DECLARE_LOG4CXX_PATTERN()

log4cxx::pattern::PatternConverter::DECLARE_LOG4CXX_PATTERN ( PatternConverter  )

◆ END_LOG4CXX_CAST_MAP()

log4cxx::pattern::PatternConverter::END_LOG4CXX_CAST_MAP ( )

◆ format()

virtual void log4cxx::pattern::PatternConverter::format ( const log4cxx::helpers::ObjectPtr obj,
LogString toAppendTo,
log4cxx::helpers::Pool p 
) const
pure 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.

Implemented in log4cxx::pattern::DatePatternConverter, log4cxx::pattern::LiteralPatternConverter, log4cxx::pattern::LineSeparatorPatternConverter, log4cxx::pattern::LoggingEventPatternConverter, and log4cxx::pattern::IntegerPatternConverter.

◆ getName()

LogString log4cxx::pattern::PatternConverter::getName ( ) const

This method returns the name of the conversion pattern.

The name can be useful to certain Layouts such as HTMLLayout.

Returns
the name of the conversion pattern

◆ getStyleClass()

virtual LogString log4cxx::pattern::PatternConverter::getStyleClass ( const log4cxx::helpers::ObjectPtr e) const
virtual

This method returns the CSS style class that should be applied to the LoggingEvent passed as parameter, which can be null.

This information is currently used only by HTMLLayout.

Parameters
enull values are accepted
Returns
the name of the conversion pattern

Reimplemented in log4cxx::pattern::LevelPatternConverter.

◆ LOG4CXX_CAST_ENTRY()

log4cxx::pattern::PatternConverter::LOG4CXX_CAST_ENTRY ( PatternConverter  )

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