Apache log4cxx  Version 0.12.0
log4cxx::JSONLayout Class Reference

This layout outputs events in a JSON dictionary. More...

#include <jsonlayout.h>

Inheritance diagram for log4cxx::JSONLayout:
log4cxx::Layout log4cxx::spi::OptionHandler log4cxx::helpers::Object log4cxx::helpers::Object

Public Member Functions

 JSONLayout ()
 
void setLocationInfo (bool locationInfoFlag)
 The LocationInfo option takes a boolean value. More...
 
bool getLocationInfo () const
 Returns the current value of the LocationInfo option. More...
 
void setPrettyPrint (bool prettyPrintFlag)
 The PrettyPrint option takes a boolean value. More...
 
bool getPrettyPrint () const
 Returns the current value of the PrettyPrint option. More...
 
virtual LogString getContentType () const
 Returns the content type output by this layout, i.e "application/json". More...
 
virtual void activateOptions (log4cxx::helpers::Pool &)
 No options to activate. More...
 
virtual void setOption (const LogString &option, const LogString &value)
 Set options. More...
 
virtual void format (LogString &output, const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool) const
 Implement this method to create your own layout format. More...
 
virtual bool ignoresThrowable () const
 The JSON layout handles the throwable contained in logging events. More...
 
- Public Member Functions inherited from log4cxx::Layout
virtual ~Layout ()
 
virtual void appendHeader (LogString &output, log4cxx::helpers::Pool &p)
 Append the header for the layout format. More...
 
virtual void appendFooter (LogString &output, log4cxx::helpers::Pool &p)
 Append the footer for the layout format. More...
 
- Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual ~OptionHandler ()
 
- Public Member Functions inherited from log4cxx::helpers::Object
virtual ~Object ()
 
virtual bool instanceof (const Class &clazz) const =0
 
virtual const void * cast (const Class &clazz) const =0
 

Protected Member Functions

void appendQuotedEscapedString (LogString &buf, const LogString &input) const
 
void appendSerializedMDC (LogString &buf, const spi::LoggingEventPtr &event) const
 
void appendSerializedNDC (LogString &buf, const spi::LoggingEventPtr &event) const
 
void appendSerializedLocationInfo (LogString &buf, const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p) const
 

Protected Attributes

LogString ppIndentL1
 
LogString ppIndentL2
 

Detailed Description

This layout outputs events in a JSON dictionary.

Constructor & Destructor Documentation

◆ JSONLayout()

log4cxx::JSONLayout::JSONLayout ( )

Member Function Documentation

◆ activateOptions()

virtual void log4cxx::JSONLayout::activateOptions ( log4cxx::helpers::Pool )
inlinevirtual

No options to activate.

Implements log4cxx::spi::OptionHandler.

◆ appendQuotedEscapedString()

void log4cxx::JSONLayout::appendQuotedEscapedString ( LogString buf,
const LogString input 
) const
protected

◆ appendSerializedLocationInfo()

void log4cxx::JSONLayout::appendSerializedLocationInfo ( LogString buf,
const spi::LoggingEventPtr event,
log4cxx::helpers::Pool p 
) const
protected

◆ appendSerializedMDC()

void log4cxx::JSONLayout::appendSerializedMDC ( LogString buf,
const spi::LoggingEventPtr event 
) const
protected

◆ appendSerializedNDC()

void log4cxx::JSONLayout::appendSerializedNDC ( LogString buf,
const spi::LoggingEventPtr event 
) const
protected

◆ format()

virtual void log4cxx::JSONLayout::format ( LogString output,
const spi::LoggingEventPtr event,
log4cxx::helpers::Pool pool 
) const
virtual

Implement this method to create your own layout format.

Implements log4cxx::Layout.

◆ getContentType()

virtual LogString log4cxx::JSONLayout::getContentType ( ) const
inlinevirtual

Returns the content type output by this layout, i.e "application/json".

Reimplemented from log4cxx::Layout.

◆ getLocationInfo()

bool log4cxx::JSONLayout::getLocationInfo ( ) const
inline

Returns the current value of the LocationInfo option.

◆ getPrettyPrint()

bool log4cxx::JSONLayout::getPrettyPrint ( ) const
inline

Returns the current value of the PrettyPrint option.

◆ ignoresThrowable()

virtual bool log4cxx::JSONLayout::ignoresThrowable ( ) const
inlinevirtual

The JSON layout handles the throwable contained in logging events.

Hence, this method return false.

Implements log4cxx::Layout.

◆ setLocationInfo()

void log4cxx::JSONLayout::setLocationInfo ( bool  locationInfoFlag)
inline

The LocationInfo option takes a boolean value.

By default, it is set to false which means there will be no location information output by this layout. If the the option is set to true, then the file name and line number of the statement at the origin of the log statement will be output.

◆ setOption()

virtual void log4cxx::JSONLayout::setOption ( const LogString option,
const LogString value 
)
virtual

Set options.

Implements log4cxx::spi::OptionHandler.

◆ setPrettyPrint()

void log4cxx::JSONLayout::setPrettyPrint ( bool  prettyPrintFlag)
inline

The PrettyPrint option takes a boolean value.

By default, it is set to false which means output by this layout will be one line per log event. If the option is set to true, then then each log event will produce multiple lines, each indented for readability.

Member Data Documentation

◆ ppIndentL1

LogString log4cxx::JSONLayout::ppIndentL1
protected

◆ ppIndentL2

LogString log4cxx::JSONLayout::ppIndentL2
protected

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