log4cxx::SimpleLayout Class Reference

SimpleLayout consists of the level of the log statement, followed by " - " and then the log message itself. More...

#include <simplelayout.h>

Inheritance diagram for log4cxx::SimpleLayout:

Public Member Functions
void	format (LogString &output, const spi::LoggingEventPtr &event, helpers::Pool &pool) const override
	Returns the log statement in a format consisting of the level, followed by " - " and then the message.
bool	ignoresThrowable () const override
	The SimpleLayout does not handle the throwable contained within LoggingEvents.
void	activateOptions (helpers::Pool &) override
	Activate the options that were previously set with calls to option setters.
void	setOption (const LogString &, const LogString &) override
	Set option to value.
Public Member Functions inherited from log4cxx::Layout
virtual	~Layout ()
virtual void	format (LogString &output, const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &pool) const =0
	Implement this method to create your own layout format.
virtual LogString	getContentType () const
	Returns the content type output by this layout.
virtual void	appendHeader (LogString &output, log4cxx::helpers::Pool &p)
	Append the header for the layout format.
virtual void	appendFooter (LogString &output, log4cxx::helpers::Pool &p)
	Append the footer for the layout format.
virtual bool	ignoresThrowable () const =0
	If the layout handles the throwable object contained within LoggingEvent, then the layout should return false.
Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual	~OptionHandler ()
virtual void	activateOptions (helpers::Pool &p)=0
	Activate the options that were previously set with calls to option setters.
virtual void	setOption (const LogString &option, const LogString &value)=0
	Set option to value.
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

Detailed Description

SimpleLayout consists of the level of the log statement, followed by " - " and then the log message itself.

For example,

        DEBUG - Hello world

PatternLayout offers a much more powerful alternative.

Member Function Documentation

activateOptions()

void log4cxx::SimpleLayout::activateOptions ( helpers::Pool &  p )

inlineoverridevirtual

Activate the options that were previously set with calls to option setters.

This allows to defer activiation of the options until all options have been set. This is required for components which have related options that remain ambigous until all are set.

For example, the FileAppender has the File and Append options both of which are ambigous until the other is also set.

Implements log4cxx::spi::OptionHandler.

format()

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

overridevirtual

Returns the log statement in a format consisting of the level, followed by " - " and then the message.

For example,

 INFO - "A message"

Returns

A byte array in SimpleLayout format.

Implements log4cxx::Layout.

ignoresThrowable()

bool log4cxx::SimpleLayout::ignoresThrowable ( ) const

inlineoverridevirtual

The SimpleLayout does not handle the throwable contained within LoggingEvents.

Thus, it returns true.

Implements log4cxx::Layout.

setOption()

void log4cxx::SimpleLayout::setOption ( const LogString &  option, const LogString &  value  )

inlineoverridevirtual

Set option to value.

The handling of each option depends on the OptionHandler instance. Some options may become active immediately whereas other may be activated only when activateOptions is called.

Implements log4cxx::spi::OptionHandler.

---

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

• simplelayout.h