Apache Log4cxx: log4cxx::Layout Class Reference (original) (raw)
Extend this abstract class to create your own log layout format. More...
#include <[layout.h](layout%5F8h%5Fsource.html)>

| Public Member Functions | |
|---|---|
| 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 |
Extend this abstract class to create your own log layout format.
| virtual log4cxx::Layout::~Layout ( ) | virtual |
|---|
◆ appendFooter()
Append the footer for the layout format.
The base class does nothing.
Reimplemented in log4cxx::HTMLLayout.
◆ appendHeader()
Append the header for the layout format.
The base class does nothing.
Reimplemented in log4cxx::HTMLLayout.
◆ format()
◆ getContentType()
| virtual LogString log4cxx::Layout::getContentType ( ) const | virtual |
|---|
◆ getFormattedEventCharacterCount()
| size_t log4cxx::Layout::getFormattedEventCharacterCount ( ) const | protected |
|---|
The expected length of a formatted event excluding the message text.
◆ ignoresThrowable()
| virtual bool log4cxx::Layout::ignoresThrowable ( ) const | pure virtual |
|---|
The documentation for this class was generated from the following file:
Public Member Functions inherited from