blob: 0915732b79d1b6b37b96af34bdbadaf2d165e34f [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Apache log4cxx: OptionHandler Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="http://logging.apache.org/log4cxx">Apache log4cxx</a>
&#160;<span id="projectnumber">Version 0.10.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classlog4cxx_1_1spi_1_1_option_handler.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classlog4cxx_1_1spi_1_1_option_handler-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">OptionHandler Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A string based interface to configure package components.
<a href="classlog4cxx_1_1spi_1_1_option_handler.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for OptionHandler:</div>
<div class="dyncontent">
<div class="center">
<img src="classlog4cxx_1_1spi_1_1_option_handler.png" usemap="#OptionHandler_map" alt=""/>
<map id="OptionHandler_map" name="OptionHandler_map">
<area href="classlog4cxx_1_1helpers_1_1_object.html" title="base class for java-like objects. " alt="Object" shape="rect" coords="626,0,795,24"/>
<area href="classlog4cxx_1_1_appender.html" title="Implement this interface for your own strategies for outputting log statements. " alt="Appender" shape="rect" coords="0,112,169,136"/>
<area href="classlog4cxx_1_1_layout.html" title="Extend this abstract class to create your own log layout format. " alt="Layout" shape="rect" coords="179,112,348,136"/>
<area href="classlog4cxx_1_1rolling_1_1_rolling_policy.html" title="A RollingPolicy is responsible for performing the rolling over of the active log file. " alt="RollingPolicy" shape="rect" coords="537,112,706,136"/>
<area href="classlog4cxx_1_1rolling_1_1_triggering_policy.html" title="A TriggeringPolicy controls the conditions under which rollover occurs. " alt="TriggeringPolicy" shape="rect" coords="716,112,885,136"/>
<area href="classlog4cxx_1_1spi_1_1_error_handler.html" title="Appenders may delegate their error handling to ErrorHandlers. " alt="ErrorHandler" shape="rect" coords="1074,112,1243,136"/>
<area href="classlog4cxx_1_1spi_1_1_filter.html" title="Users should extend this class to implement customized logging event filtering. " alt="Filter" shape="rect" coords="1432,112,1601,136"/>
<area href="classlog4cxx_1_1_appender_skeleton.html" title="Implementation base class for all appenders. " alt="AppenderSkeleton" shape="rect" coords="0,168,169,192"/>
<area href="classlog4cxx_1_1helpers_1_1_date_layout.html" title="This abstract layout takes care of all the date related options and formatting work. " alt="DateLayout" shape="rect" coords="358,168,527,192"/>
<area href="classlog4cxx_1_1_h_t_m_l_layout.html" title="This layout outputs events in a HTML table. " alt="HTMLLayout" shape="rect" coords="358,224,527,248"/>
<area href="classlog4cxx_1_1_pattern_layout.html" title="A flexible layout configurable with pattern string. " alt="PatternLayout" shape="rect" coords="358,280,527,304"/>
<area href="classlog4cxx_1_1_simple_layout.html" title="SimpleLayout consists of the level of the log statement, followed by &quot; - &quot; and then the log message i..." alt="SimpleLayout" shape="rect" coords="358,336,527,360"/>
<area href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html" title="The output of the XMLLayout consists of a series of log4j:event elements. " alt="XMLLayout" shape="rect" coords="358,392,527,416"/>
<area href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html" title="Implements methods common to most, it not all, rolling policies. " alt="RollingPolicyBase" shape="rect" coords="537,168,706,192"/>
<area href="classlog4cxx_1_1rolling_1_1_filter_based_triggering_policy.html" title="FilterBasedTriggeringPolicy determines if rolling should be triggered by evaluating the current messa..." alt="FilterBasedTriggeringPolicy" shape="rect" coords="895,168,1064,192"/>
<area href="classlog4cxx_1_1rolling_1_1_manual_triggering_policy.html" title="ManualTriggeringPolicy only rolls over on explicit calls to RollingFileAppender.rollover(). " alt="ManualTriggeringPolicy" shape="rect" coords="895,224,1064,248"/>
<area href="classlog4cxx_1_1rolling_1_1_size_based_triggering_policy.html" title="SizeBasedTriggeringPolicy looks at size of the file being currently written to. " alt="SizeBasedTriggeringPolicy" shape="rect" coords="895,280,1064,304"/>
<area href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html" title="TimeBasedRollingPolicy is both easy to configure and quite powerful. " alt="TimeBasedRollingPolicy" shape="rect" coords="895,336,1064,360"/>
<area href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html" title="The OnlyOnceErrorHandler implements log4cxx&#39;s default error handling policy which consists of emittin..." alt="OnlyOnceErrorHandler" shape="rect" coords="1253,168,1422,192"/>
<area href="classlog4cxx_1_1varia_1_1_fallback_error_handler.html" title="The FallbackErrorHandler implements the ErrorHandler interface such that a secondary appender may be ..." alt="FallbackErrorHandler" shape="rect" coords="1253,224,1422,248"/>
<area href="classlog4cxx_1_1filter_1_1_and_filter.html" title="A filter that &#39;and&#39;s the results of any number of contained filters together. " alt="AndFilter" shape="rect" coords="1611,168,1780,192"/>
<area href="classlog4cxx_1_1filter_1_1_deny_all_filter.html" title="This filter drops all logging events. " alt="DenyAllFilter" shape="rect" coords="1611,224,1780,248"/>
<area href="classlog4cxx_1_1filter_1_1_expression_filter.html" title="A filter supporting complex expressions - supports both infix and postfix expressions (infix expressi..." alt="ExpressionFilter" shape="rect" coords="1611,280,1780,304"/>
<area href="classlog4cxx_1_1filter_1_1_level_match_filter.html" title="This is a very simple filter based on level matching. " alt="LevelMatchFilter" shape="rect" coords="1611,336,1780,360"/>
<area href="classlog4cxx_1_1filter_1_1_level_range_filter.html" title="This is a very simple filter based on level matching, which can be used to reject messages with prior..." alt="LevelRangeFilter" shape="rect" coords="1611,392,1780,416"/>
<area href="classlog4cxx_1_1filter_1_1_location_info_filter.html" title="Location information is usually specified at the appender level - all events associated with an appen..." alt="LocationInfoFilter" shape="rect" coords="1611,448,1780,472"/>
<area href="classlog4cxx_1_1filter_1_1_map_filter.html" alt="MapFilter" shape="rect" coords="1611,504,1780,528"/>
<area href="classlog4cxx_1_1filter_1_1_property_filter.html" title="NOTE: This filter modifies logging events by adding properties to the event. " alt="PropertyFilter" shape="rect" coords="1611,560,1780,584"/>
<area href="classlog4cxx_1_1filter_1_1_string_match_filter.html" title="This is a very simple filter based on string matching. " alt="StringMatchFilter" shape="rect" coords="1611,616,1780,640"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad773ac49843844af53fe553912ed63e5"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#ad773ac49843844af53fe553912ed63e5">~OptionHandler</a> ()</td></tr>
<tr class="separator:ad773ac49843844af53fe553912ed63e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af04d4bfbd66b46083b1aa042fdafbb06"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#af04d4bfbd66b46083b1aa042fdafbb06">activateOptions</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &amp;p)=0</td></tr>
<tr class="memdesc:af04d4bfbd66b46083b1aa042fdafbb06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Activate the options that were previously set with calls to option setters. <a href="#af04d4bfbd66b46083b1aa042fdafbb06">More...</a><br /></td></tr>
<tr class="separator:af04d4bfbd66b46083b1aa042fdafbb06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f2ae2ded63f80c627269c99b20c19ee"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#a8f2ae2ded63f80c627269c99b20c19ee">setOption</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;option, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;value)=0</td></tr>
<tr class="memdesc:a8f2ae2ded63f80c627269c99b20c19ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set <code>option</code> to <code>value</code>. <a href="#a8f2ae2ded63f80c627269c99b20c19ee">More...</a><br /></td></tr>
<tr class="separator:a8f2ae2ded63f80c627269c99b20c19ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classlog4cxx_1_1helpers_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classlog4cxx_1_1helpers_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classlog4cxx_1_1helpers_1_1_object.html">Object</a></td></tr>
<tr class="memitem:ae7b62e37794f297c0cede40ed0e84fcd inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classlog4cxx_1_1helpers_1_1_class.html">helpers::Class</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#ae7b62e37794f297c0cede40ed0e84fcd">getClass</a> () const </td></tr>
<tr class="separator:ae7b62e37794f297c0cede40ed0e84fcd inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5cc4f9ba1ea5c2f25bc4b1f0dac5dc5 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#ab5cc4f9ba1ea5c2f25bc4b1f0dac5dc5">~Object</a> ()</td></tr>
<tr class="separator:ab5cc4f9ba1ea5c2f25bc4b1f0dac5dc5 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac82ce1688acb6704813967344dda7bff inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#ac82ce1688acb6704813967344dda7bff">addRef</a> () const =0</td></tr>
<tr class="separator:ac82ce1688acb6704813967344dda7bff inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad54d5773a0683bffdf4132da4dee6d76 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#ad54d5773a0683bffdf4132da4dee6d76">releaseRef</a> () const =0</td></tr>
<tr class="separator:ad54d5773a0683bffdf4132da4dee6d76 inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ab1bb19059c1de23f8a35cdbc0b6a5c inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#a0ab1bb19059c1de23f8a35cdbc0b6a5c">instanceof</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_class.html">Class</a> &amp;clazz) const =0</td></tr>
<tr class="separator:a0ab1bb19059c1de23f8a35cdbc0b6a5c inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04b3422e17b0a882538bbc99833ab9df inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#a04b3422e17b0a882538bbc99833ab9df">cast</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_class.html">Class</a> &amp;clazz) const =0</td></tr>
<tr class="separator:a04b3422e17b0a882538bbc99833ab9df inherit pub_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classlog4cxx_1_1helpers_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classlog4cxx_1_1helpers_1_1_object')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classlog4cxx_1_1helpers_1_1_object.html">Object</a></td></tr>
<tr class="memitem:a0bdbda4effe8938c1aca6d4397e5a39d inherit pub_static_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classlog4cxx_1_1helpers_1_1_class.html">helpers::Class</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#a0bdbda4effe8938c1aca6d4397e5a39d">getStaticClass</a> ()</td></tr>
<tr class="separator:a0bdbda4effe8938c1aca6d4397e5a39d inherit pub_static_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50ec9288d0b7e3140dee8e24ee74a212 inherit pub_static_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classlog4cxx_1_1helpers_1_1_class_registration.html">log4cxx::helpers::ClassRegistration</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_object.html#a50ec9288d0b7e3140dee8e24ee74a212">registerClass</a> ()</td></tr>
<tr class="separator:a50ec9288d0b7e3140dee8e24ee74a212 inherit pub_static_methods_classlog4cxx_1_1helpers_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A string based interface to configure package components. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ad773ac49843844af53fe553912ed63e5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html">OptionHandler</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af04d4bfbd66b46083b1aa042fdafbb06"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void activateOptions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &amp;&#160;</td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Activate the options that were previously set with calls to option setters. </p>
<p>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.</p>
<p>For example, the <a class="el" href="classlog4cxx_1_1_file_appender.html" title="FileAppender appends log events to a file. ">FileAppender</a> has the <a class="el" href="classlog4cxx_1_1_file_appender.html#a6a6c98222ccf2072dad5a434f9336930">File</a> and <a class="el" href="classlog4cxx_1_1_file_appender.html#a78ebca211ceb3a0b2960a48092089906">Append</a> options both of which are ambigous until the other is also set. </p>
<p>Implemented in <a class="el" href="classlog4cxx_1_1_pattern_layout.html#af1f3ced78d335ec9c2b800d6d5aa3ef8">PatternLayout</a>, <a class="el" href="classlog4cxx_1_1_daily_rolling_file_appender.html#a580abdcb8fd42d07eaf679166f77bc34">DailyRollingFileAppender</a>, <a class="el" href="classlog4cxx_1_1db_1_1_o_d_b_c_appender.html#af1f3ced78d335ec9c2b800d6d5aa3ef8">ODBCAppender</a>, <a class="el" href="classlog4cxx_1_1rolling_1_1_time_based_rolling_policy.html#a580abdcb8fd42d07eaf679166f77bc34">TimeBasedRollingPolicy</a>, <a class="el" href="classlog4cxx_1_1_file_appender.html#aa3df68f8aae152299471992071e202f5">FileAppender</a>, <a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html#af1f3ced78d335ec9c2b800d6d5aa3ef8">SocketHubAppender</a>, <a class="el" href="classlog4cxx_1_1spi_1_1_filter.html#aa3df68f8aae152299471992071e202f5">Filter</a>, <a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html#a580abdcb8fd42d07eaf679166f77bc34">XMLLayout</a>, <a class="el" href="classlog4cxx_1_1rolling_1_1_filter_based_triggering_policy.html#a580abdcb8fd42d07eaf679166f77bc34">FilterBasedTriggeringPolicy</a>, <a class="el" href="classlog4cxx_1_1_appender_skeleton.html#abe1aa95ede9cc9d0609905154129c0ba">AppenderSkeleton</a>, <a class="el" href="classlog4cxx_1_1filter_1_1_expression_filter.html#aa3df68f8aae152299471992071e202f5">ExpressionFilter</a>, <a class="el" href="classlog4cxx_1_1_rolling_file_appender.html#a75035ac63aad24ddcbb340ddaba57f1c">RollingFileAppender</a>, <a class="el" href="classlog4cxx_1_1net_1_1_s_m_t_p_appender.html#af1f3ced78d335ec9c2b800d6d5aa3ef8">SMTPAppender</a>, <a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#abe1aa95ede9cc9d0609905154129c0ba">HTMLLayout</a>, <a class="el" href="classlog4cxx_1_1net_1_1_telnet_appender.html#aa3df68f8aae152299471992071e202f5">TelnetAppender</a>, <a class="el" href="classlog4cxx_1_1_writer_appender.html#a9fe8531491720e83f1d25862d918a37d">WriterAppender</a>, <a class="el" href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html#aa3df68f8aae152299471992071e202f5">FixedWindowRollingPolicy</a>, <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html#af04d4bfbd66b46083b1aa042fdafbb06">RollingPolicyBase</a>, <a class="el" href="classlog4cxx_1_1rolling_1_1_size_based_triggering_policy.html#a580abdcb8fd42d07eaf679166f77bc34">SizeBasedTriggeringPolicy</a>, <a class="el" href="classlog4cxx_1_1_simple_layout.html#abe1aa95ede9cc9d0609905154129c0ba">SimpleLayout</a>, <a class="el" href="classlog4cxx_1_1varia_1_1_fallback_error_handler.html#aa3df68f8aae152299471992071e202f5">FallbackErrorHandler</a>, <a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#aa3df68f8aae152299471992071e202f5">SyslogAppender</a>, <a class="el" href="classlog4cxx_1_1net_1_1_socket_appender_skeleton.html#aa3df68f8aae152299471992071e202f5">SocketAppenderSkeleton</a>, <a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#aa3df68f8aae152299471992071e202f5">OnlyOnceErrorHandler</a>, <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_file_appender_skeleton.html#a580abdcb8fd42d07eaf679166f77bc34">RollingFileAppenderSkeleton</a>, <a class="el" href="classlog4cxx_1_1rolling_1_1_manual_triggering_policy.html#a580abdcb8fd42d07eaf679166f77bc34">ManualTriggeringPolicy</a>, <a class="el" href="classlog4cxx_1_1_console_appender.html#aa3df68f8aae152299471992071e202f5">ConsoleAppender</a>, <a class="el" href="classlog4cxx_1_1filter_1_1_location_info_filter.html#a580abdcb8fd42d07eaf679166f77bc34">LocationInfoFilter</a>, <a class="el" href="classlog4cxx_1_1helpers_1_1_date_layout.html#af1f3ced78d335ec9c2b800d6d5aa3ef8">DateLayout</a>, and <a class="el" href="classlog4cxx_1_1nt_1_1_n_t_event_log_appender.html#af1f3ced78d335ec9c2b800d6d5aa3ef8">NTEventLogAppender</a>.</p>
</div>
</div>
<a class="anchor" id="a8f2ae2ded63f80c627269c99b20c19ee"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void setOption </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;&#160;</td>
<td class="paramname"><em>option</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;&#160;</td>
<td class="paramname"><em>value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set <code>option</code> to <code>value</code>. </p>
<p>The handling of each option depends on the <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html" title="A string based interface to configure package components. ">OptionHandler</a> instance. Some options may become active immediately whereas other may be activated only when <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#af04d4bfbd66b46083b1aa042fdafbb06" title="Activate the options that were previously set with calls to option setters. ">activateOptions</a> is called. </p>
<p>Implemented in <a class="el" href="classlog4cxx_1_1_pattern_layout.html#aee5023c29cca9dc68164b22a01cb7c6e">PatternLayout</a>, <a class="el" href="classlog4cxx_1_1_daily_rolling_file_appender.html#ac1d269357907e0809687a2bec962e1c8">DailyRollingFileAppender</a>, <a class="el" href="classlog4cxx_1_1_async_appender.html#ac1d269357907e0809687a2bec962e1c8">AsyncAppender</a>, <a class="el" href="classlog4cxx_1_1_writer_appender.html#ac1d269357907e0809687a2bec962e1c8">WriterAppender</a>, <a class="el" href="classlog4cxx_1_1db_1_1_o_d_b_c_appender.html#aee5023c29cca9dc68164b22a01cb7c6e">ODBCAppender</a>, <a class="el" href="classlog4cxx_1_1_file_appender.html#ac1d269357907e0809687a2bec962e1c8">FileAppender</a>, <a class="el" href="classlog4cxx_1_1net_1_1_socket_appender_skeleton.html#ac1d269357907e0809687a2bec962e1c8">SocketAppenderSkeleton</a>, <a class="el" href="classlog4cxx_1_1net_1_1_socket_hub_appender.html#aee5023c29cca9dc68164b22a01cb7c6e">SocketHubAppender</a>, <a class="el" href="classlog4cxx_1_1spi_1_1_filter.html#ac1d269357907e0809687a2bec962e1c8">Filter</a>, <a class="el" href="classlog4cxx_1_1xml_1_1_x_m_l_layout.html#aee5023c29cca9dc68164b22a01cb7c6e">XMLLayout</a>, <a class="el" href="classlog4cxx_1_1rolling_1_1_filter_based_triggering_policy.html#ac1d269357907e0809687a2bec962e1c8">FilterBasedTriggeringPolicy</a>, <a class="el" href="classlog4cxx_1_1_appender_skeleton.html#aee5023c29cca9dc68164b22a01cb7c6e">AppenderSkeleton</a>, <a class="el" href="classlog4cxx_1_1_h_t_m_l_layout.html#aee5023c29cca9dc68164b22a01cb7c6e">HTMLLayout</a>, <a class="el" href="classlog4cxx_1_1net_1_1_telnet_appender.html#aee5023c29cca9dc68164b22a01cb7c6e">TelnetAppender</a>, <a class="el" href="classlog4cxx_1_1_rolling_file_appender.html#aee5023c29cca9dc68164b22a01cb7c6e">RollingFileAppender</a>, <a class="el" href="classlog4cxx_1_1net_1_1_s_m_t_p_appender.html#aee5023c29cca9dc68164b22a01cb7c6e">SMTPAppender</a>, <a class="el" href="classlog4cxx_1_1rolling_1_1_fixed_window_rolling_policy.html#ac1d269357907e0809687a2bec962e1c8">FixedWindowRollingPolicy</a>, <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_policy_base.html#aee5023c29cca9dc68164b22a01cb7c6e">RollingPolicyBase</a>, <a class="el" href="classlog4cxx_1_1filter_1_1_level_range_filter.html#aee5023c29cca9dc68164b22a01cb7c6e">LevelRangeFilter</a>, <a class="el" href="classlog4cxx_1_1rolling_1_1_size_based_triggering_policy.html#ac1d269357907e0809687a2bec962e1c8">SizeBasedTriggeringPolicy</a>, <a class="el" href="classlog4cxx_1_1_simple_layout.html#a91b2dd02b1392a02b110894e801514b7">SimpleLayout</a>, <a class="el" href="classlog4cxx_1_1varia_1_1_fallback_error_handler.html#ac1d269357907e0809687a2bec962e1c8">FallbackErrorHandler</a>, <a class="el" href="classlog4cxx_1_1net_1_1_syslog_appender.html#ac1d269357907e0809687a2bec962e1c8">SyslogAppender</a>, <a class="el" href="classlog4cxx_1_1filter_1_1_level_match_filter.html#aee5023c29cca9dc68164b22a01cb7c6e">LevelMatchFilter</a>, <a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#ac1d269357907e0809687a2bec962e1c8">OnlyOnceErrorHandler</a>, <a class="el" href="classlog4cxx_1_1filter_1_1_string_match_filter.html#aee5023c29cca9dc68164b22a01cb7c6e">StringMatchFilter</a>, <a class="el" href="classlog4cxx_1_1rolling_1_1_manual_triggering_policy.html#ac1d269357907e0809687a2bec962e1c8">ManualTriggeringPolicy</a>, <a class="el" href="classlog4cxx_1_1_console_appender.html#ac1d269357907e0809687a2bec962e1c8">ConsoleAppender</a>, <a class="el" href="classlog4cxx_1_1nt_1_1_n_t_event_log_appender.html#aee5023c29cca9dc68164b22a01cb7c6e">NTEventLogAppender</a>, and <a class="el" href="classlog4cxx_1_1helpers_1_1_date_layout.html#aee5023c29cca9dc68164b22a01cb7c6e">DateLayout</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="optionhandler_8h.html">optionhandler.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
</body>
</html>