Public Member Functions

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

A string based interface to configure package components.

Constructor & Destructor Documentation

◆ ~OptionHandler()

virtual log4cxx::spi::OptionHandler::~OptionHandler ( )

inlinevirtual

Member Function Documentation

◆ activateOptions()

virtual void log4cxx::spi::OptionHandler::activateOptions ( helpers::Pool & p )

pure virtual

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.

Implemented in log4cxx::AppenderSkeleton, log4cxx::FMTLayout, log4cxx::HTMLLayout, log4cxx::JSONLayout, log4cxx::rolling::FilterBasedTriggeringPolicy, log4cxx::rolling::ManualTriggeringPolicy, log4cxx::rolling::SizeBasedTriggeringPolicy, log4cxx::rolling::TimeBasedRollingPolicy, log4cxx::SimpleLayout, log4cxx::xml::XMLLayout, log4cxx::ConsoleAppender, log4cxx::db::DBAppender, log4cxx::db::ODBCAppender, log4cxx::FileAppender, log4cxx::filter::ExpressionFilter, log4cxx::helpers::OnlyOnceErrorHandler, log4cxx::net::SMTPAppender, log4cxx::net::SocketAppenderSkeleton, log4cxx::net::SyslogAppender, log4cxx::net::TelnetAppender, log4cxx::nt::NTEventLogAppender, log4cxx::PatternLayout, log4cxx::rolling::FixedWindowRollingPolicy, log4cxx::rolling::RollingPolicyBase, log4cxx::spi::Filter, log4cxx::varia::FallbackErrorHandler, log4cxx::rolling::MultiprocessRollingFileAppender, log4cxx::rolling::RollingFileAppender, and log4cxx::WriterAppender.

◆ setOption()

virtual void log4cxx::spi::OptionHandler::setOption ( const LogString & option,

const LogString & value

)

pure virtual

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.

Implemented in log4cxx::FMTLayout, log4cxx::SimpleLayout, log4cxx::AppenderSkeleton, log4cxx::AsyncAppender, log4cxx::ConsoleAppender, log4cxx::db::DBAppender, log4cxx::db::ODBCAppender, log4cxx::FileAppender, log4cxx::filter::LevelMatchFilter, log4cxx::filter::LevelRangeFilter, log4cxx::filter::LocationInfoFilter, log4cxx::filter::LoggerMatchFilter, log4cxx::filter::MapFilter, log4cxx::filter::StringMatchFilter, log4cxx::helpers::OnlyOnceErrorHandler, log4cxx::HTMLLayout, log4cxx::JSONLayout, log4cxx::net::SMTPAppender, log4cxx::net::SocketAppenderSkeleton, log4cxx::net::SyslogAppender, log4cxx::net::TelnetAppender, log4cxx::nt::NTEventLogAppender, log4cxx::PatternLayout, log4cxx::rolling::FilterBasedTriggeringPolicy, log4cxx::rolling::FixedWindowRollingPolicy, log4cxx::rolling::ManualTriggeringPolicy, log4cxx::rolling::RollingFileAppender, log4cxx::rolling::RollingPolicyBase, log4cxx::rolling::SizeBasedTriggeringPolicy, log4cxx::rolling::TimeBasedRollingPolicy, log4cxx::spi::Filter, log4cxx::varia::FallbackErrorHandler, log4cxx::WriterAppender, and log4cxx::xml::XMLLayout.

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

optionhandler.h