log4shib::PatternLayout Class Reference

PatternLayout is a simple fixed format Layout implementation. More...

#include <PatternLayout.hh>

Inheritance diagram for log4shib::PatternLayout:

log4shib::Layout List of all members.

Public Member Functions

 PatternLayout ()
virtual ~PatternLayout ()
virtual std::string format (const LoggingEvent &event)
 Formats the LoggingEvent in the style set by the setConversionPattern call.
virtual void setConversionPattern (const std::string &conversionPattern) throw (ConfigureFailure)
 Sets the format of log lines handled by this PatternLayout.
virtual std::string getConversionPattern () const
virtual void clearConversionPattern ()

Static Public Attributes

static const char * DEFAULT_CONVERSION_PATTERN = "%m%n"
 The default conversion pattern.
static const char * SIMPLE_CONVERSION_PATTERN = "%p - %m%n"
 A conversion pattern equivalent to the SimpleLayout.
static const char * BASIC_CONVERSION_PATTERN = "%R %p %c %x: %m%n"
 A conversion pattern equivalent to the BasicLayout.
static const char * TTCC_CONVERSION_PATTERN = "%r [%t] %p %c %x - %m%n"
 A conversion pattern equivalent to the TTCCLayout.

Classes

class  PatternComponent

Detailed Description

PatternLayout is a simple fixed format Layout implementation.


Constructor & Destructor Documentation

log4shib::PatternLayout::PatternLayout (  ) 

log4shib::PatternLayout::~PatternLayout (  )  [virtual]


Member Function Documentation

void log4shib::PatternLayout::clearConversionPattern (  )  [virtual]

std::string log4shib::PatternLayout::format ( const LoggingEvent event  )  [virtual]

Formats the LoggingEvent in the style set by the setConversionPattern call.

By default, set to "%m%n"

Implements log4shib::Layout.

std::string log4shib::PatternLayout::getConversionPattern (  )  const [virtual]

void log4shib::PatternLayout::setConversionPattern ( const std::string &  conversionPattern  )  throw (ConfigureFailure) [virtual]

Sets the format of log lines handled by this PatternLayout.

By default, set to "%m%n". Format characters are as follows:

Parameters:
conversionPattern the conversion pattern
Exceptions:
ConfigureFailure if the pattern is invalid


Member Data Documentation

const char * log4shib::PatternLayout::BASIC_CONVERSION_PATTERN = "%R %p %c %x: %m%n" [static]

A conversion pattern equivalent to the BasicLayout.

const char * log4shib::PatternLayout::DEFAULT_CONVERSION_PATTERN = "%m%n" [static]

The default conversion pattern.

const char * log4shib::PatternLayout::SIMPLE_CONVERSION_PATTERN = "%p - %m%n" [static]

A conversion pattern equivalent to the SimpleLayout.

const char * log4shib::PatternLayout::TTCC_CONVERSION_PATTERN = "%r [%t] %p %c %x - %m%n" [static]

A conversion pattern equivalent to the TTCCLayout.

Note: TTCCLayout is in log4j but not log4shib.


The documentation for this class was generated from the following files:
Generated on 10 Jul 2018 for log4shib by  doxygen 1.4.7