Classes | Public Member Functions | Static Public Member Functions

OptionHandler Class Reference

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

Inherits log4cxx::helpers::Object.

Inherited by Appender [virtual], Layout [virtual], RollingPolicy [virtual], TriggeringPolicy [virtual], ErrorHandler [virtual], and Filter [virtual].

List of all members.

Classes

class  ClazzOptionHandler

Public Member Functions

virtual const helpers::ClassgetClass () const
virtual ~OptionHandler ()
virtual void activateOptions (log4cxx::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.

Static Public Member Functions

static const helpers::ClassgetStaticClass ()
static const
log4cxx::helpers::ClassRegistration
registerClass ()

Detailed Description

A string based interface to configure package components.


Constructor & Destructor Documentation

virtual ~OptionHandler (  )  [inline, virtual]

Member Function Documentation

virtual void activateOptions ( log4cxx::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.

virtual const helpers::Class& getClass (  )  const [virtual]

Reimplemented from Object.

Reimplemented in RollingPolicy, and ErrorHandler.

static const helpers::Class& getStaticClass (  )  [static]

Reimplemented from Object.

Reimplemented in RollingPolicy, and ErrorHandler.

static const log4cxx::helpers::ClassRegistration& registerClass (  )  [static]

Reimplemented from Object.

Reimplemented in RollingPolicy, and ErrorHandler.

virtual void 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.


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