|
|
|
OptionHandler Class ReferenceInheritance diagram for OptionHandler:
[legend]Collaboration diagram for OptionHandler:
[legend]List of all members.
|
Public Member Functions |
| virtual void | activateOptions ()=0 |
| virtual void | setOption (const String &option, const String &value)=0 |
Detailed Description
A string based interface to configure package components.
Member Function Documentation
| virtual void activateOptions |
( |
|
) |
[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 AppenderSkeleton, ConsoleAppender, DailyRollingFileAppender, FileAppender, DateLayout, OnlyOnceErrorHandler, HTMLLayout, SMTPAppender, SocketAppender, SocketHubAppender, SyslogAppender, TelnetAppender, XMLSocketAppender, NTEventLogAppender, PatternLayout, SimpleLayout, Filter, FallbackErrorHandler, and XMLLayout. |
| virtual void setOption |
( |
const String & |
option, |
|
|
const String & |
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 AppenderSkeleton, ConsoleAppender, DailyRollingFileAppender, ODBCAppender, FileAppender, DateLayout, OnlyOnceErrorHandler, HTMLLayout, SMTPAppender, SocketAppender, SocketHubAppender, SyslogAppender, TelnetAppender, XMLSocketAppender, NTEventLogAppender, PatternLayout, RollingFileAppender, SimpleLayout, Filter, FallbackErrorHandler, and XMLLayout. |
The documentation for this class was generated from the following file:
|
|
|
Copyright © 1999-2004, Apache Software Foundation
|
