Apache log4cxx (Incubating)  Version 0.10.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups
OptionHandler Class Referenceabstract

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

Inheritance diagram for OptionHandler:
Object Appender Layout RollingPolicy TriggeringPolicy ErrorHandler Filter AppenderSkeleton DateLayout HTMLLayout PatternLayout SimpleLayout XMLLayout RollingPolicyBase FilterBasedTriggeringPolicy ManualTriggeringPolicy SizeBasedTriggeringPolicy TimeBasedRollingPolicy OnlyOnceErrorHandler FallbackErrorHandler AndFilter DenyAllFilter ExpressionFilter LevelMatchFilter LevelRangeFilter LocationInfoFilter MapFilter PropertyFilter StringMatchFilter

Public Member Functions

virtual ~OptionHandler ()
 
virtual void activateOptions (log4cxx::helpers::Pool &p)=0
 Activate the options that were previously set with calls to option setters. More...
 
virtual void setOption (const LogString &option, const LogString &value)=0
 Set option to value. More...
 
- Public Member Functions inherited from Object
virtual const helpers::ClassgetClass () const
 
virtual ~Object ()
 
virtual void addRef () const =0
 
virtual void releaseRef () const =0
 
virtual bool instanceof (const Class &clazz) const =0
 
virtual const void * cast (const Class &clazz) const =0
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
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 ( )
inlinevirtual

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.

Implemented in PatternLayout, DailyRollingFileAppender, ODBCAppender, TimeBasedRollingPolicy, FileAppender, SocketHubAppender, Filter, XMLLayout, FilterBasedTriggeringPolicy, AppenderSkeleton, ExpressionFilter, RollingFileAppender, SMTPAppender, HTMLLayout, TelnetAppender, WriterAppender, FixedWindowRollingPolicy, RollingPolicyBase, SizeBasedTriggeringPolicy, SimpleLayout, FallbackErrorHandler, SyslogAppender, SocketAppenderSkeleton, OnlyOnceErrorHandler, RollingFileAppenderSkeleton, ManualTriggeringPolicy, ConsoleAppender, LocationInfoFilter, DateLayout, and NTEventLogAppender.


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