log4cxx::pattern::LiteralPatternConverter Class Reference

Formats a string literal. More...

#include <literalpatternconverter.h>

Inheritance diagram for log4cxx::pattern::LiteralPatternConverter:

Public Member Functions
	LiteralPatternConverter (const LogString &literal)
void	format (const spi::LoggingEventPtr &event, LogString &toAppendTo, helpers::Pool &p) const override
void	format (const helpers::ObjectPtr &obj, LogString &toAppendTo, helpers::Pool &p) const override
void	format (const spi::LoggingEventPtr &event, LogString &toAppendTo) const
	Formats an event into a string buffer. More...
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
Public Member Functions inherited from log4cxx::pattern::LoggingEventPatternConverter
void	format (const spi::LoggingEventPtr &event, LogString &toAppendTo) const
	Formats an event into a string buffer. More...
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. More...
void	format (const helpers::ObjectPtr &obj, LogString &toAppendTo) const
	Formats an object into a string buffer. More...
virtual void	format (const helpers::ObjectPtr &obj, LogString &toAppendTo, helpers::Pool &p) const=0
Public Member Functions inherited from log4cxx::pattern::PatternConverter
void	format (const helpers::ObjectPtr &obj, LogString &toAppendTo) const
	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 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...
const FormattingInfo &	getFormattingInfo () const
	Provides a minimum width, a maximum width and the alignment. More...
void	setFormattingInfo (const FormattingInfoPtr &newValue)
	Use newValue for the minimum width, a maximum width and the alignment. More...
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 LogString &literal)

Additional Inherited Members
Protected Member Functions inherited from log4cxx::pattern::LoggingEventPatternConverter
	LoggingEventPatternConverter (const LogString &name, const LogString &style)
	Constructs an instance of LoggingEventPatternConverter. More...
	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. More...
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. More...

Detailed Description

Formats a string literal.

Constructor & Destructor Documentation

LiteralPatternConverter()

log4cxx::pattern::LiteralPatternConverter::LiteralPatternConverter

(

const LogString &

literal

)

Member Function Documentation

format() [1/5]

void log4cxx::pattern::LoggingEventPatternConverter::format

override

format() [2/5]

void log4cxx::pattern::LiteralPatternConverter::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.

format() [3/5]

void log4cxx::pattern::LoggingEventPatternConverter::format

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/5]

void log4cxx::pattern::LiteralPatternConverter::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.

format() [5/5]

virtual void log4cxx::pattern::LoggingEventPatternConverter::format

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.

newInstance()

static PatternConverterPtr log4cxx::pattern::LiteralPatternConverter::newInstance ( const LogString &  literal )

static

---

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

• literalpatternconverter.h