log4cxx::pattern::NDCPatternConverter Class Reference

Return the event's NDC in a StringBuffer. More...

#include <ndcpatternconverter.h>

Inheritance diagram for log4cxx::pattern::NDCPatternConverter:

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

Static Public Member Functions
static PatternConverterPtr	newInstance (const std::vector< LogString > &options)
	Obtains an instance of NDCPatternConverter.

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

Return the event's NDC in a StringBuffer.

Constructor & Destructor Documentation

NDCPatternConverter()

log4cxx::pattern::NDCPatternConverter::NDCPatternConverter

(

)

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.

Reimplemented from log4cxx::pattern::LoggingEventPatternConverter.

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]

void log4cxx::pattern::NDCPatternConverter::format ( const spi::LoggingEventPtr & event, 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::LoggingEventPatternConverter.

newInstance()

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

static

Obtains an instance of NDCPatternConverter.

Parameters

options

options, may be null.

Returns

instance of NDCPatternConverter.

---

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

• ndcpatternconverter.h