<!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: Hierarchy 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_1_hierarchy.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>Hierarchy Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::Hierarchy" --><!-- doxytag: inherits="log4cxx::spi::LoggerRepository,log4cxx::helpers::ObjectImpl" -->
<p>This class is specialized in retrieving loggers by name and also maintaining the logger hierarchy.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1spi_1_1_logger_repository.html">log4cxx::spi::LoggerRepository</a>, and <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html">log4cxx::helpers::ObjectImpl</a>.</p>
<p><a href="classlog4cxx_1_1_hierarchy-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_1_hierarchy.html#aa3a1845805c30320383a1202f81c731c">Hierarchy</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new logger hierarchy. <a href="#aa3a1845805c30320383a1202f81c731c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_hierarchy.html#ac0fda715d59b7e9ccf3ff8a818418083">~Hierarchy</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_hierarchy.html#a0198815940c2715c84b0e04828cf8dfa">addRef</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_hierarchy.html#a55c31efee1904916b999395fa4d46a24">releaseRef</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_hierarchy.html#a83cc9e427184e7f39af6935e2565715a">addHierarchyEventListener</a> (const spi::HierarchyEventListenerPtr &listener)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_hierarchy.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This call will clear all logger definitions from the internal hashtable. <a href="#ac8bb3912a3ce86b15842e79d0b421204"></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_1_hierarchy.html#a569b371f0b747d048f78062eba8d79b9">emitNoAppenderWarning</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LoggerPtr</a> &logger)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LoggerPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_hierarchy.html#a7204cf9ea148398ddcd737678e5886d0">exists</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the named logger exists in the hierarchy. <a href="#a7204cf9ea148398ddcd737678e5886d0"></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_1_hierarchy.html#ad868dcebe2b8e135985d6f5e57dd2387">setThreshold</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &levelStr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The string form of <a class="el" href="classlog4cxx_1_1_hierarchy.html#a7b0e4dbd708b9efaf0f34cb8d597226a">setThreshold</a>. <a href="#ad868dcebe2b8e135985d6f5e57dd2387"></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_1_hierarchy.html#a7b0e4dbd708b9efaf0f34cb8d597226a">setThreshold</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LevelPtr</a> &l)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable logging for logging requests with level <code>l</code> or higher. <a href="#a7b0e4dbd708b9efaf0f34cb8d597226a"></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_1_hierarchy.html#a3de757d6c800a7fb2e91e522b3229742">fireAddAppenderEvent</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LoggerPtr</a> &logger, const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">AppenderPtr</a> &appender)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_hierarchy.html#ad2c7afda988de425239b507fb2ab353a">fireRemoveAppenderEvent</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LoggerPtr</a> &logger, const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">AppenderPtr</a> &appender)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LevelPtr</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_hierarchy.html#a0bc4b2a92a56c9b1a1ea3a271ae1e330">getThreshold</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="classlog4cxx_1_1_level.html" title="Defines the minimum set of levels recognized by the system, that is OFF, FATAL, ERROR, WARN, INFO, DEBUG and ALL.">Level</a> representation of the <code>enable</code> state. <a href="#a0bc4b2a92a56c9b1a1ea3a271ae1e330"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LoggerPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_hierarchy.html#a8afdd945a1581f8531c268e480ab0d86">getLogger</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a new logger instance named as the first parameter using the default factory. <a href="#a8afdd945a1581f8531c268e480ab0d86"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LoggerPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_hierarchy.html#ae1a3bfe161fbfc71f7ec3dd46ecabf59">getLogger</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &name, const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggerFactoryPtr</a> &factory)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a new logger instance named as the first parameter using <code>factory</code>. <a href="#ae1a3bfe161fbfc71f7ec3dd46ecabf59"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacelog4cxx.html#a3c20da83ead0a801c0c4e4c82a31181a">LoggerList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_hierarchy.html#a8db06f5b97f9cd630e1a7b8abe13f30b">getCurrentLoggers</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns all the currently defined loggers in this hierarchy as a LoggerList. <a href="#a8db06f5b97f9cd630e1a7b8abe13f30b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LoggerPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_hierarchy.html#a6360b51681a428e7b664f7d3cd0edb8d">getRootLogger</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the root of this hierarchy. <a href="#a6360b51681a428e7b664f7d3cd0edb8d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_hierarchy.html#ae6770230869c415de618d72aa4bf0187">isDisabled</a> (int level) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method will return <code>true</code> if this repository is disabled for <code>level</code> object passed as parameter and <code>false</code> otherwise. <a href="#ae6770230869c415de618d72aa4bf0187"></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_1_hierarchy.html#a9081872e9bdc07e4f5b1c28e86eafed7">resetConfiguration</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset all values contained in this hierarchy instance to their default. <a href="#a9081872e9bdc07e4f5b1c28e86eafed7"></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_1_hierarchy.html#a7861ee1569802186a619778efc85af13">shutdown</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used by subclasses to add a renderer to the hierarchy passed as parameter. <a href="#a7861ee1569802186a619778efc85af13"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_hierarchy.html#ae83d15ae5dc58fcf661f92b6dfe8d11a">isConfigured</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_hierarchy.html#ad01ad09e8cca207486c1cc9a147fd881">setConfigured</a> (bool configured)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class is specialized in retrieving loggers by name and also maintaining the logger hierarchy. </p>
<p><em>The casual user does not have to deal with this class directly.</em></p>
<p>The structure of the logger hierarchy is maintained by the <a class="el" href="classlog4cxx_1_1_hierarchy.html#a8afdd945a1581f8531c268e480ab0d86" title="Return a new logger instance named as the first parameter using the default factory.">getLogger</a> method. The hierarchy is such that children link to their parent but parents do not have any pointers to their children. Moreover, loggers can be instantiated in any order, in particular descendant before ancestor.</p>
<p>In case a descendant is created before a particular ancestor, then it creates a provision node for the ancestor and adds itself to the provision node. Other descendants of the same ancestor add themselves to the previously created provision node. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa3a1845805c30320383a1202f81c731c"></a><!-- doxytag: member="log4cxx::Hierarchy::Hierarchy" ref="aa3a1845805c30320383a1202f81c731c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1_hierarchy.html">Hierarchy</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new logger hierarchy. </p>
</div>
</div>
<a class="anchor" id="ac0fda715d59b7e9ccf3ff8a818418083"></a><!-- doxytag: member="log4cxx::Hierarchy::~Hierarchy" ref="ac0fda715d59b7e9ccf3ff8a818418083" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classlog4cxx_1_1_hierarchy.html">Hierarchy</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a83cc9e427184e7f39af6935e2565715a"></a><!-- doxytag: member="log4cxx::Hierarchy::addHierarchyEventListener" ref="a83cc9e427184e7f39af6935e2565715a" args="(const spi::HierarchyEventListenerPtr &listener)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void addHierarchyEventListener </td>
<td>(</td>
<td class="paramtype">const spi::HierarchyEventListenerPtr & </td>
<td class="paramname"><em>listener</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0198815940c2715c84b0e04828cf8dfa"></a><!-- doxytag: member="log4cxx::Hierarchy::addRef" ref="a0198815940c2715c84b0e04828cf8dfa" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void addRef </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html#a0198815940c2715c84b0e04828cf8dfa">ObjectImpl</a>.</p>
</div>
</div>
<a class="anchor" id="ac8bb3912a3ce86b15842e79d0b421204"></a><!-- doxytag: member="log4cxx::Hierarchy::clear" ref="ac8bb3912a3ce86b15842e79d0b421204" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This call will clear all logger definitions from the internal hashtable. </p>
<p>Invoking this method will irrevocably mess up the logger hierarchy.</p>
<p>You should <em>really</em> know what you are doing before invoking this method. </p>
</div>
</div>
<a class="anchor" id="a569b371f0b747d048f78062eba8d79b9"></a><!-- doxytag: member="log4cxx::Hierarchy::emitNoAppenderWarning" ref="a569b371f0b747d048f78062eba8d79b9" args="(const LoggerPtr &logger)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void emitNoAppenderWarning </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LoggerPtr</a> & </td>
<td class="paramname"><em>logger</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_logger_repository.html#ab645697a704de65438e03a2c6db9e824">LoggerRepository</a>.</p>
</div>
</div>
<a class="anchor" id="a7204cf9ea148398ddcd737678e5886d0"></a><!-- doxytag: member="log4cxx::Hierarchy::exists" ref="a7204cf9ea148398ddcd737678e5886d0" args="(const LogString &name)" -->
<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">LoggerPtr</a> exists </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if the named logger exists in the hierarchy. </p>
<p>If so return its reference, otherwise returns <code>null</code>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the logger to search for. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_logger_repository.html#a4fa6ca63b28ba12443bed7a1084920dd">LoggerRepository</a>.</p>
</div>
</div>
<a class="anchor" id="a3de757d6c800a7fb2e91e522b3229742"></a><!-- doxytag: member="log4cxx::Hierarchy::fireAddAppenderEvent" ref="a3de757d6c800a7fb2e91e522b3229742" args="(const LoggerPtr &logger, const AppenderPtr &appender)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fireAddAppenderEvent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LoggerPtr</a> & </td>
<td class="paramname"><em>logger</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">AppenderPtr</a> & </td>
<td class="paramname"><em>appender</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_logger_repository.html#a79f2f99aeb1e0d627f6309bd215fef0b">LoggerRepository</a>.</p>
</div>
</div>
<a class="anchor" id="ad2c7afda988de425239b507fb2ab353a"></a><!-- doxytag: member="log4cxx::Hierarchy::fireRemoveAppenderEvent" ref="ad2c7afda988de425239b507fb2ab353a" args="(const LoggerPtr &logger, const AppenderPtr &appender)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fireRemoveAppenderEvent </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LoggerPtr</a> & </td>
<td class="paramname"><em>logger</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">AppenderPtr</a> & </td>
<td class="paramname"><em>appender</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a8db06f5b97f9cd630e1a7b8abe13f30b"></a><!-- doxytag: member="log4cxx::Hierarchy::getCurrentLoggers" ref="a8db06f5b97f9cd630e1a7b8abe13f30b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacelog4cxx.html#a3c20da83ead0a801c0c4e4c82a31181a">LoggerList</a> getCurrentLoggers </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns all the currently defined loggers in this hierarchy as a LoggerList. </p>
<p>The root logger is <em>not</em> included in the returned LoggerList. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_logger_repository.html#aa200048abe7ce6f9dc4334dc331e5f92">LoggerRepository</a>.</p>
</div>
</div>
<a class="anchor" id="a8afdd945a1581f8531c268e480ab0d86"></a><!-- doxytag: member="log4cxx::Hierarchy::getLogger" ref="a8afdd945a1581f8531c268e480ab0d86" args="(const LogString &name)" -->
<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">LoggerPtr</a> getLogger </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a new logger instance named as the first parameter using the default factory. </p>
<p>If a logger of that name already exists, then it will be returned. Otherwise, a new logger will be instantiated and then linked with its existing ancestors as well as children.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the logger to retrieve. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_logger_repository.html#a9c57bc493dd3488a37bc7214397655d0">LoggerRepository</a>.</p>
</div>
</div>
<a class="anchor" id="ae1a3bfe161fbfc71f7ec3dd46ecabf59"></a><!-- doxytag: member="log4cxx::Hierarchy::getLogger" ref="ae1a3bfe161fbfc71f7ec3dd46ecabf59" args="(const LogString &name, const spi::LoggerFactoryPtr &factory)" -->
<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">LoggerPtr</a> getLogger </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggerFactoryPtr</a> & </td>
<td class="paramname"><em>factory</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a new logger instance named as the first parameter using <code>factory</code>. </p>
<p>If a logger of that name already exists, then it will be returned. Otherwise, a new logger will be instantiated by the <code>factory</code> parameter and linked with its existing ancestors as well as children.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the logger to retrieve. </td></tr>
<tr><td class="paramname">factory</td><td>The factory that will make the new logger instance. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_logger_repository.html#ab1d1c9a45b0555504b0b49ac5b40c228">LoggerRepository</a>.</p>
</div>
</div>
<a class="anchor" id="a6360b51681a428e7b664f7d3cd0edb8d"></a><!-- doxytag: member="log4cxx::Hierarchy::getRootLogger" ref="a6360b51681a428e7b664f7d3cd0edb8d" args="() const " -->
<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">LoggerPtr</a> getRootLogger </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the root of this hierarchy. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_logger_repository.html#a32b9bff9546309e6be4b58989c1be96e">LoggerRepository</a>.</p>
</div>
</div>
<a class="anchor" id="a0bc4b2a92a56c9b1a1ea3a271ae1e330"></a><!-- doxytag: member="log4cxx::Hierarchy::getThreshold" ref="a0bc4b2a92a56c9b1a1ea3a271ae1e330" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LevelPtr</a>& getThreshold </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a <a class="el" href="classlog4cxx_1_1_level.html" title="Defines the minimum set of levels recognized by the system, that is OFF, FATAL, ERROR, WARN, INFO, DEBUG and ALL.">Level</a> representation of the <code>enable</code> state. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_logger_repository.html#a7991482241f670edbc4f4e7f5473bc5f">LoggerRepository</a>.</p>
</div>
</div>
<a class="anchor" id="ae83d15ae5dc58fcf661f92b6dfe8d11a"></a><!-- doxytag: member="log4cxx::Hierarchy::isConfigured" ref="ae83d15ae5dc58fcf661f92b6dfe8d11a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool isConfigured </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_logger_repository.html#a74ee52af71ff0e0b9efd1acd86b16164">LoggerRepository</a>.</p>
</div>
</div>
<a class="anchor" id="ae6770230869c415de618d72aa4bf0187"></a><!-- doxytag: member="log4cxx::Hierarchy::isDisabled" ref="ae6770230869c415de618d72aa4bf0187" args="(int level) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isDisabled </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>level</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method will return <code>true</code> if this repository is disabled for <code>level</code> object passed as parameter and <code>false</code> otherwise. </p>
<p>See also the <a class="el" href="classlog4cxx_1_1_hierarchy.html#a7b0e4dbd708b9efaf0f34cb8d597226a">setThreshold</a> method. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_logger_repository.html#a3feece6fce2e9cd1c24841f9d8ef4e9c">LoggerRepository</a>.</p>
</div>
</div>
<a class="anchor" id="a55c31efee1904916b999395fa4d46a24"></a><!-- doxytag: member="log4cxx::Hierarchy::releaseRef" ref="a55c31efee1904916b999395fa4d46a24" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void releaseRef </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html#a55c31efee1904916b999395fa4d46a24">ObjectImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a9081872e9bdc07e4f5b1c28e86eafed7"></a><!-- doxytag: member="log4cxx::Hierarchy::resetConfiguration" ref="a9081872e9bdc07e4f5b1c28e86eafed7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void resetConfiguration </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reset all values contained in this hierarchy instance to their default. </p>
<p>This removes all appenders from all categories, sets the level of all non-root categories to <code>null</code>, sets their additivity flag to <code>true</code> and sets the level of the root logger to DEBUG. Moreover, message disabling is set its default "off" value.</p>
<p>Existing categories are not removed. They are just reset.</p>
<p>This method should be used sparingly and with care as it will block all logging until it is completed. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_logger_repository.html#a653a2cdfcf377792cee27c264ff541d6">LoggerRepository</a>.</p>
</div>
</div>
<a class="anchor" id="ad01ad09e8cca207486c1cc9a147fd881"></a><!-- doxytag: member="log4cxx::Hierarchy::setConfigured" ref="ad01ad09e8cca207486c1cc9a147fd881" args="(bool configured)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void setConfigured </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>configured</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_logger_repository.html#aeb9c15bd158089d96ea972da63e3a622">LoggerRepository</a>.</p>
</div>
</div>
<a class="anchor" id="ad868dcebe2b8e135985d6f5e57dd2387"></a><!-- doxytag: member="log4cxx::Hierarchy::setThreshold" ref="ad868dcebe2b8e135985d6f5e57dd2387" args="(const LogString &levelStr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setThreshold </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>levelStr</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The string form of <a class="el" href="classlog4cxx_1_1_hierarchy.html#a7b0e4dbd708b9efaf0f34cb8d597226a">setThreshold</a>. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_logger_repository.html#aec6c487b28218e60bb199af63b8bd588">LoggerRepository</a>.</p>
</div>
</div>
<a class="anchor" id="a7b0e4dbd708b9efaf0f34cb8d597226a"></a><!-- doxytag: member="log4cxx::Hierarchy::setThreshold" ref="a7b0e4dbd708b9efaf0f34cb8d597226a" args="(const LevelPtr &l)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setThreshold </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LevelPtr</a> & </td>
<td class="paramname"><em>l</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enable logging for logging requests with level <code>l</code> or higher. </p>
<p>By default all levels are enabled.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">l</td><td>The minimum level for which logging requests are sent to their appenders. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_logger_repository.html#acf85d1a16a0a6d419ca59e817b68ba79">LoggerRepository</a>.</p>
</div>
</div>
<a class="anchor" id="a7861ee1569802186a619778efc85af13"></a><!-- doxytag: member="log4cxx::Hierarchy::shutdown" ref="a7861ee1569802186a619778efc85af13" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void shutdown </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used by subclasses to add a renderer to the hierarchy passed as parameter. </p>
<p>Shutting down a hierarchy will <em>safely</em> close and remove all appenders in all categories including the root logger.</p>
<p>Some appenders such as <a class="el" href="classlog4cxx_1_1net_1_1_socket_appender.html">SocketAppender</a> and <a class="el" href="classlog4cxx_1_1_async_appender.html" title="The AsyncAppender lets users log events asynchronously.">AsyncAppender</a> need to be closed before the application exists. Otherwise, pending logging events might be lost.</p>
<p>The <code>shutdown</code> method is careful to close nested appenders before closing regular appenders. This is allows configurations where a regular appender is attached to a logger and again to a nested appender. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_logger_repository.html#a618e8560b89583a7ce8212d95a000c87">LoggerRepository</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="hierarchy_8h.html">hierarchy.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="classlog4cxx_1_1_hierarchy.html">Hierarchy</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>
