A string based interface to configure package components. More...

#include <optionhandler.h>

Inheritance diagram for log4cxx::spi::OptionHandler:

Public Member Functions
virtual	~OptionHandler ()
void	activateOptions ()
virtual void	activateOptions (helpers::Pool &)=0
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() [1/2]

void log4cxx::spi::OptionHandler::activateOptions ( )

◆ activateOptions() [2/2]

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

pure virtual

Deprecated: The pool parameter is not used and will be removed in a future version. Implement this method for now, but plan to migrate to activateOptions() without parameters.

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

◆ 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::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::FMTLayout, 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::SimpleLayout, 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