log4cxx::pattern::ThrowableInformationPatternConverter Class Reference

Outputs the ThrowableInformation portion of the LoggingiEvent as a full stacktrace unless this converter's option is 'short', where it just outputs the first line of the trace. More...

#include <throwableinformationpatternconverter.h>

Inheritance diagram for log4cxx::pattern::ThrowableInformationPatternConverter:

Public Member Functions
	ThrowableInformationPatternConverter (bool shortReport)
void	format (const spi::LoggingEventPtr &event, LogString &toAppendTo, helpers::Pool &p) const override
	Formats an event into a string buffer.
bool	handlesThrowable () const override
	This converter obviously handles throwables.
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 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
	DECLARE_LOG4CXX_PATTERN (PatternConverter)
	BEGIN_LOG4CXX_CAST_MAP ()
	LOG4CXX_CAST_ENTRY (PatternConverter)
	END_LOG4CXX_CAST_MAP ()
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::Class &	getClass () 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)
	Gets an instance of the class.

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

Outputs the ThrowableInformation portion of the LoggingiEvent as a full stacktrace unless this converter's option is 'short', where it just outputs the first line of the trace.

Constructor & Destructor Documentation

ThrowableInformationPatternConverter()

log4cxx::pattern::ThrowableInformationPatternConverter::ThrowableInformationPatternConverter

(

bool

shortReport

)

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

obj	event to format, may not be null.
toAppendTo	string buffer to which the formatted event will be appended. May not be null.
p	pool for any allocations necessary during formatting.

Reimplemented from log4cxx::pattern::LoggingEventPatternConverter.

format() [2/3]

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

overridevirtual

Formats an event into a string buffer.

Parameters

event	event to format, may not be null.
toAppendTo	string buffer to which the formatted event will be appended. May not be null.
p	pool 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

event	event to format, may not be null.
toAppendTo	string buffer to which the formatted event will be appended. May not be null.
p	pool for memory allocations needing during format.

Implements log4cxx::pattern::LoggingEventPatternConverter.

handlesThrowable()

bool log4cxx::pattern::ThrowableInformationPatternConverter::handlesThrowable ( ) const

overridevirtual

This converter obviously handles throwables.

Returns

true.

Reimplemented from log4cxx::pattern::LoggingEventPatternConverter.

newInstance()

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

static

Gets an instance of the class.

Parameters

options

pattern options, may be null. If first element is "short", only the first line of the throwable will be formatted.

Returns

instance of class.

---

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

• throwableinformationpatternconverter.h