<!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"/>
<title>Apache log4cxx: PropertySetter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache log4cxx <span id="projectnumber">Version 0.10.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main 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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classlog4cxx_1_1config_1_1_property_setter.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>PropertySetter Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::config::PropertySetter" -->
<p>General purpose Object property setter.
<a href="#_details">More...</a></p>
<p><a href="classlog4cxx_1_1config_1_1_property_setter-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1config_1_1_property_setter.html#af02b3cb9fb5e7d1cd28d93f8cb0572f2">PropertySetter</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">helpers::ObjectPtr</a> &<a class="el" href="classlog4cxx_1_1config_1_1_property_setter.html#a9056a7c31a16198262c90fcb9399f01f">obj</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="classlog4cxx_1_1config_1_1_property_setter.html" title="General purpose Object property setter.">PropertySetter</a> for the specified Object. <a href="#af02b3cb9fb5e7d1cd28d93f8cb0572f2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1config_1_1_property_setter.html#a8f9db4120bd4c628b3f727479c8fd7dc">setProperties</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_properties.html">helpers::Properties</a> &properties, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &prefix, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the properites for the object that match the <code>prefix</code> passed as parameter. <a href="#a8f9db4120bd4c628b3f727479c8fd7dc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1config_1_1_property_setter.html#a1d1d0de0225d4ec80ebe061120dd3bbb">setProperty</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &option, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &value, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a property on this PropertySetter's Object. <a href="#a1d1d0de0225d4ec80ebe061120dd3bbb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1config_1_1_property_setter.html#a510cfd675a8b6e6fad560339f2921369">activate</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p)</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1config_1_1_property_setter.html#a6b2c1e67c10ede44f15686c72c7461a8">setProperties</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">helpers::ObjectPtr</a> &<a class="el" href="classlog4cxx_1_1config_1_1_property_setter.html#a9056a7c31a16198262c90fcb9399f01f">obj</a>, <a class="el" href="classlog4cxx_1_1helpers_1_1_properties.html">helpers::Properties</a> &properties, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &prefix, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the properties of an object passed as a parameter in one go. <a href="#a6b2c1e67c10ede44f15686c72c7461a8"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">helpers::ObjectPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1config_1_1_property_setter.html#a9056a7c31a16198262c90fcb9399f01f">obj</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>General purpose Object property setter. </p>
<p>Clients repeatedly invokes <a class="el" href="classlog4cxx_1_1config_1_1_property_setter.html#a1d1d0de0225d4ec80ebe061120dd3bbb">setProperty(name,value)</a> in order to invoke setters on the Object specified in the constructor.</p>
<p>Usage: </p>
<pre>
<a class="el" href="classlog4cxx_1_1config_1_1_property_setter.html" title="General purpose Object property setter.">PropertySetter</a> ps(anObject);
ps.set("name", "Joe");
ps.set("age", "32");
ps.set("isMale", "true");
</pre><p> will cause the invocations anObject->setOption("name", "Joe"), anObject->setOption("age", "32") and anObject->setOption("isMale", "true") if the <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html" title="A string based interface to configure package components.">spi::OptionHandler</a> interface is supported by anObject. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af02b3cb9fb5e7d1cd28d93f8cb0572f2"></a><!-- doxytag: member="log4cxx::config::PropertySetter::PropertySetter" ref="af02b3cb9fb5e7d1cd28d93f8cb0572f2" args="(const helpers::ObjectPtr &obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1config_1_1_property_setter.html">PropertySetter</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">helpers::ObjectPtr</a> & </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new <a class="el" href="classlog4cxx_1_1config_1_1_property_setter.html" title="General purpose Object property setter.">PropertySetter</a> for the specified Object. </p>
<p>This is done in prepartion for invoking <a class="el" href="classlog4cxx_1_1config_1_1_property_setter.html#a1d1d0de0225d4ec80ebe061120dd3bbb" title="Set a property on this PropertySetter's Object.">setProperty</a> one or more times.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td>the object for which to set properties </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a510cfd675a8b6e6fad560339f2921369"></a><!-- doxytag: member="log4cxx::config::PropertySetter::activate" ref="a510cfd675a8b6e6fad560339f2921369" args="(log4cxx::helpers::Pool &p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void activate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a8f9db4120bd4c628b3f727479c8fd7dc"></a><!-- doxytag: member="log4cxx::config::PropertySetter::setProperties" ref="a8f9db4120bd4c628b3f727479c8fd7dc" args="(helpers::Properties &properties, const LogString &prefix, log4cxx::helpers::Pool &p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setProperties </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_properties.html">helpers::Properties</a> & </td>
<td class="paramname"><em>properties</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>prefix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td>
<td class="paramname"><em>p</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the properites for the object that match the <code>prefix</code> passed as parameter. </p>
</div>
</div>
<a class="anchor" id="a6b2c1e67c10ede44f15686c72c7461a8"></a><!-- doxytag: member="log4cxx::config::PropertySetter::setProperties" ref="a6b2c1e67c10ede44f15686c72c7461a8" args="(const helpers::ObjectPtr &obj, helpers::Properties &properties, const LogString &prefix, log4cxx::helpers::Pool &p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void setProperties </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">helpers::ObjectPtr</a> & </td>
<td class="paramname"><em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_properties.html">helpers::Properties</a> & </td>
<td class="paramname"><em>properties</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>prefix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td>
<td class="paramname"><em>p</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the properties of an object passed as a parameter in one go. </p>
<p>The <code>properties</code> are parsed relative to a <code>prefix</code>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td>The object to configure. </td></tr>
<tr><td class="paramname">properties</td><td>A java.util.Properties containing keys and values. </td></tr>
<tr><td class="paramname">prefix</td><td>Only keys having the specified prefix will be set. </td></tr>
<tr><td class="paramname">p</td><td>pool to use for any allocations required during call. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1d1d0de0225d4ec80ebe061120dd3bbb"></a><!-- doxytag: member="log4cxx::config::PropertySetter::setProperty" ref="a1d1d0de0225d4ec80ebe061120dd3bbb" args="(const LogString &option, const LogString &value, log4cxx::helpers::Pool &p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setProperty </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </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> & </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td>
<td class="paramname"><em>p</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a property on this PropertySetter's Object. </p>
<p>If the underlying Object supports the <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html" title="A string based interface to configure package components.">spi::OptionHandler</a> interface, the <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#a8f2ae2ded63f80c627269c99b20c19ee">setOption</a> method is called.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">option</td><td>name of the property </td></tr>
<tr><td class="paramname">value</td><td>String value of the property </td></tr>
<tr><td class="paramname">p</td><td>pool to use for any allocations required during call. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a9056a7c31a16198262c90fcb9399f01f"></a><!-- doxytag: member="log4cxx::config::PropertySetter::obj" ref="a9056a7c31a16198262c90fcb9399f01f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">helpers::ObjectPtr</a> <a class="el" href="classlog4cxx_1_1config_1_1_property_setter.html#a9056a7c31a16198262c90fcb9399f01f">obj</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="propertysetter_8h.html">propertysetter.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelog4cxx.html">log4cxx</a> </li>
<li class="navelem"><a class="el" href="namespacelog4cxx_1_1config.html">config</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1config_1_1_property_setter.html">PropertySetter</a> </li>
<!--
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>
