log4cxx::pattern::LoggingEventPatternConverter Class Reference

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:

Public Member Functions
void	format (const spi::LoggingEventPtr &event, LogString &toAppendTo) const
	Formats an event into a string buffer.
virtual void	format (const spi::LoggingEventPtr &event, LogString &toAppendTo, helpers::Pool &p) const =0
void	format (const helpers::ObjectPtr &obj, LogString &toAppendTo, helpers::Pool &p) const override
virtual bool	handlesThrowable () const
	Normally pattern converters are not meant to handle Exceptions although few pattern converters might.
void	format (const helpers::ObjectPtr &obj, LogString &toAppendTo) const
	Formats an object into a string buffer.
Public Member Functions inherited from log4cxx::pattern::PatternConverter
void	format (const helpers::ObjectPtr &obj, LogString &toAppendTo) const
	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.
const FormattingInfo &	getFormattingInfo () const
	Provides a minimum width, a maximum width and the alignment.
void	setFormattingInfo (const FormattingInfoPtr &newValue)
	Use newValue for the minimum width, a maximum width and the alignment.
Public Member Functions inherited from log4cxx::helpers::Object
virtual	~Object ()
virtual const helpers::Class &	getClass () const =0
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.
	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 ()

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.

Detailed Description

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

Constructor & Destructor Documentation

LoggingEventPatternConverter() [1/2]

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

protected

Constructs an instance of LoggingEventPatternConverter.

Parameters

name	name of converter.
style	CSS style for output.

LoggingEventPatternConverter() [2/2]

log4cxx::pattern::LoggingEventPatternConverter::LoggingEventPatternConverter ( std::unique_ptr< PatternConverterPrivate > priv )

protected

Member Function Documentation

format() [1/4]

void log4cxx::pattern::PatternConverter::format	(	const helpers::ObjectPtr &	obj,
		LogString &	toAppendTo ) const

Formats an object into a string buffer.

Parameters

obj	holds the attributes, may not be null.
toAppendTo	string buffer to which the formatted event will be appended. May not be null.

format() [2/4]

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

overridevirtual

Deprecated

The pool parameter is not used and will be removed in a future version. Implement this method for now, but plan to migrate to format() without a helpers::Pool parameter.

Implements log4cxx::pattern::PatternConverter.

Reimplemented in log4cxx::pattern::MDCPatternConverter, log4cxx::pattern::MessagePatternConverter, log4cxx::pattern::MethodLocationPatternConverter, log4cxx::pattern::NDCPatternConverter, log4cxx::pattern::PropertiesPatternConverter, log4cxx::pattern::RelativeTimePatternConverter, log4cxx::pattern::ShortFileLocationPatternConverter, log4cxx::pattern::ThreadPatternConverter, log4cxx::pattern::ThreadUsernamePatternConverter, and log4cxx::pattern::ThrowableInformationPatternConverter.

format() [3/4]

void log4cxx::pattern::LoggingEventPatternConverter::format	(	const spi::LoggingEventPtr &	event,
		LogString &	toAppendTo ) const

Formats an event into a string buffer.

Parameters

event	holds the attributes, may not be null.
toAppendTo	string buffer to which the formatted event will be appended. May not be null.

format() [4/4]

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

pure virtual

Deprecated

The pool parameter is not used and will be removed in a future version. Implement this method for now, but plan to migrate to format() without a helpers::Pool parameter.

Implemented in log4cxx::pattern::ClassNamePatternConverter, log4cxx::pattern::ColorEndPatternConverter, log4cxx::pattern::ColorStartPatternConverter, log4cxx::pattern::DatePatternConverter, log4cxx::pattern::FileLocationPatternConverter, log4cxx::pattern::FullLocationPatternConverter, log4cxx::pattern::LevelPatternConverter, log4cxx::pattern::LineLocationPatternConverter, log4cxx::pattern::LineSeparatorPatternConverter, log4cxx::pattern::LiteralPatternConverter, log4cxx::pattern::LoggerPatternConverter, log4cxx::pattern::MDCPatternConverter, log4cxx::pattern::MessagePatternConverter, log4cxx::pattern::MethodLocationPatternConverter, log4cxx::pattern::NDCPatternConverter, log4cxx::pattern::PropertiesPatternConverter, log4cxx::pattern::RelativeTimePatternConverter, log4cxx::pattern::ShortFileLocationPatternConverter, log4cxx::pattern::ThreadPatternConverter, log4cxx::pattern::ThreadUsernamePatternConverter, and log4cxx::pattern::ThrowableInformationPatternConverter.

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:

• loggingeventpatternconverter.h