Apache Log4cxx  Version 1.8.0
log4cxx::pattern::MethodLocationPatternConverter Class Reference

Return the event's line location information in a StringBuffer. More...

#include <methodlocationpatternconverter.h>

Inheritance diagram for log4cxx::pattern::MethodLocationPatternConverter:
log4cxx::pattern::LoggingEventPatternConverter log4cxx::pattern::PatternConverter log4cxx::helpers::Object

Public Member Functions

 MethodLocationPatternConverter ()
 
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. 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
 
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::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 FormattingInfogetFormattingInfo () 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::ClassgetClass () 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 MethodLocationPatternConverter. More...
 

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

Return the event's line location information in a StringBuffer.

Constructor & Destructor Documentation

◆ MethodLocationPatternConverter()

log4cxx::pattern::MethodLocationPatternConverter::MethodLocationPatternConverter ( )

Member Function Documentation

◆ format() [1/6]

void log4cxx::pattern::PatternConverter::format

Formats an object into a string buffer.

Parameters
objholds the attributes, may not be null.
toAppendTostring buffer to which the formatted event will be appended. May not be null.

◆ format() [2/6]

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

◆ format() [3/6]

void log4cxx::pattern::LoggingEventPatternConverter::format
override

◆ format() [4/6]

void log4cxx::pattern::LoggingEventPatternConverter::format

Formats an event into a string buffer.

Parameters
eventholds the attributes, may not be null.
toAppendTostring buffer to which the formatted event will be appended. May not be null.

◆ format() [5/6]

void log4cxx::pattern::MethodLocationPatternConverter::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() [6/6]

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::MethodLocationPatternConverter::newInstance ( const std::vector< LogString > &  options)
static

Obtains an instance of MethodLocationPatternConverter.

Parameters
optionsoptions, may be null.
Returns
instance of MethodLocationPatternConverter.

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