PropertiesPatternConverter Class Reference

Able to handle the contents of the LoggingEvent's Property bundle and either output the entire contents of the properties in a similar format to the java.util.Hashtable.toString(), or to output the value of a specific key within the property bundle when this pattern converter has the option set. More...

Inherits LoggingEventPatternConverter.

List of all members.

Public Member Functions
void	format (const log4cxx::spi::LoggingEventPtr &event, LogString &toAppendTo, log4cxx::helpers::Pool &p) const
	Formats an event into a string buffer.
Static Public Member Functions
static PatternConverterPtr	newInstance (const std::vector< LogString > &options)
	Obtains an instance of PropertiesPatternConverter.

---

Detailed Description

Able to handle the contents of the LoggingEvent's Property bundle and either output the entire contents of the properties in a similar format to the java.util.Hashtable.toString(), or to output the value of a specific key within the property bundle when this pattern converter has the option set.

---

Member Function Documentation

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

static PatternConverterPtr newInstance

(

const std::vector< LogString > &

options

)

[static]

Obtains an instance of PropertiesPatternConverter.

Parameters:

options

options, may be null or first element contains name of property to format.

Returns:

instance of PropertiesPatternConverter.

---

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

• propertiespatternconverter.h