Google Git
Sign in
apache / logging-log4cxx / bc918db26e1badbee741907044632b7801f3a3ce / . / xdocs / www / manual / classlog4cxx_1_1spi_1_1AppenderAttachable.html
blob: fc35292922407d3d6bca9cdbcaf0be8bdb760c0b [file] [log] [blame]
<html>
<head>
<title>
log4cxx - Documentation
</title>
<link href="../css/doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body bgcolor="#ffffff" text="#000000" link="#525D76">
<!-- START Header table -->
<table border="0" cellspacing="0" width="90%">
<!-- TOP IMAGE -->
<tr>
<td colspan="2">
<a href="http://logging.apache.org">
<img src="http://logging.apache.org/images/ls-logo.jpg" align="left" border="0"/>
</a>
</td>
</tr>
</table>
<!-- END Header table -->
<!-- START main table -->
<table id="main" border="0" width="90%" cellspacing="2" cellpadding="0">
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr>
<!-- LEFT SIDE NAVIGATION -->
<td id="navbar" valign="top">
<!-- ============================================================ -->
<table id="navbar" border="0" cellspacing="0" cellpadding="0">
<tr >
<td class="navbarHeader" nowrap="true">
<strong>Apache</strong>
</td>
</tr>
<tr><td class="navbarItem"><small> <a href="http://www.apache.org">Apache Home</a>
</small></td></tr>
<tr><td class="navbarItem"><small> <a href="http://logging.apache.org/">Logging Services</a>
</small></td></tr>
<tr >
<td class="navbarHeader" nowrap="true">
<strong>log4cxx project</strong>
</td>
</tr>
<tr><td class="navbarItem"><small> <a href="../index.html">About</a>
</small></td></tr>
<tr><td class="navbarItem"><small> <a href="../news.html">News</a>
</small></td></tr>
<tr><td class="navbarItem"><small> <a href="../team.html">Team</a>
</small></td></tr>
<tr><td class="navbarItem"><small> <a href="../manual/index.html">Documentation</a>
</small></td></tr>
<tr><td class="navbarItem"><small> <a href="../performance.html">Performance</a>
</small></td></tr>
<tr><td class="navbarItem"><small> <a href="../download.html">Download</a>
</small></td></tr>
</table>
</td>
<td id="mainContents" align="left" valign="top">
<hr>
<!-- Generated by Doxygen 1.3.5 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<h1>AppenderAttachable Class Reference</h1>Inheritance diagram for AppenderAttachable:<p><center><img src="classlog4cxx_1_1spi_1_1AppenderAttachable__inherit__graph.png" border="0" usemap="#AppenderAttachable__inherit__map" alt="Inheritance graph"></center>
<map name="AppenderAttachable__inherit__map">
<area href="classlog4cxx_1_1AsyncAppender.html" shape="rect" coords="6,168,116,192" alt="">
<area href="classlog4cxx_1_1Logger.html" shape="rect" coords="140,168,193,192" alt="">
<area href="classlog4cxx_1_1helpers_1_1Object.html" shape="rect" coords="88,19,138,43" alt="">
<area href="classlog4cxx_1_1spi_1_1RootCategory.html" shape="rect" coords="121,242,212,266" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for AppenderAttachable:<p><center><img src="classlog4cxx_1_1spi_1_1AppenderAttachable__coll__graph.png" border="0" usemap="#AppenderAttachable__coll__map" alt="Collaboration graph"></center>
<map name="AppenderAttachable__coll__map">
<area href="classlog4cxx_1_1helpers_1_1Object.html" shape="rect" coords="48,18,98,42" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classlog4cxx_1_1spi_1_1AppenderAttachable-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1AppenderAttachable.html#a0">addAppender</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">AppenderPtr</a> &amp;newAppender)=0</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual AppenderList&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1AppenderAttachable.html#a1">getAllAppenders</a> () const=0</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">AppenderPtr</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1AppenderAttachable.html#a2">getAppender</a> (const String &amp;name) const=0</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1AppenderAttachable.html#a3">isAttached</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">AppenderPtr</a> &amp;appender) const=0</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1AppenderAttachable.html#a4">removeAllAppenders</a> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1AppenderAttachable.html#a5">removeAppender</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">AppenderPtr</a> &amp;appender)=0</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1AppenderAttachable.html#a6">removeAppender</a> (const String &amp;name)=0</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This Interface is for attaching Appenders to objects.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a0" doxytag="log4cxx::spi::AppenderAttachable::addAppender" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void addAppender </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">AppenderPtr</a> &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>newAppender</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Add an appender.
<p>
Implemented in <a class="el" href="classlog4cxx_1_1AsyncAppender.html#a2">AsyncAppender</a>, and <a class="el" href="classlog4cxx_1_1Logger.html#a1">Logger</a>. </td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="log4cxx::spi::AppenderAttachable::getAllAppenders" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual AppenderList getAllAppenders </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get all previously added appenders as an AppenderList.
<p>
Implemented in <a class="el" href="classlog4cxx_1_1AsyncAppender.html#a5">AsyncAppender</a>, and <a class="el" href="classlog4cxx_1_1Logger.html#a10">Logger</a>. </td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="log4cxx::spi::AppenderAttachable::getAppender" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">AppenderPtr</a> getAppender </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const String &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>name</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get an appender by name.
<p>
Implemented in <a class="el" href="classlog4cxx_1_1AsyncAppender.html#a6">AsyncAppender</a>, and <a class="el" href="classlog4cxx_1_1Logger.html#a11">Logger</a>. </td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="log4cxx::spi::AppenderAttachable::isAttached" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual bool isAttached </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">AppenderPtr</a> &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>appender</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Returns <code>true</code> if the specified appender is in list of attached attached, <code>false</code> otherwise.
<p>
Implemented in <a class="el" href="classlog4cxx_1_1AsyncAppender.html#a8">AsyncAppender</a>, and <a class="el" href="classlog4cxx_1_1Logger.html#a19">Logger</a>. </td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="log4cxx::spi::AppenderAttachable::removeAllAppenders" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void removeAllAppenders </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Remove all previously added appenders.
<p>
Implemented in <a class="el" href="classlog4cxx_1_1AsyncAppender.html#a9">AsyncAppender</a>, and <a class="el" href="classlog4cxx_1_1Logger.html#a28">Logger</a>. </td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="log4cxx::spi::AppenderAttachable::removeAppender" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void removeAppender </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const String &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>name</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Remove the appender with the name passed as parameter from the list of appenders.
<p>
Implemented in <a class="el" href="classlog4cxx_1_1AsyncAppender.html#a11">AsyncAppender</a>, and <a class="el" href="classlog4cxx_1_1Logger.html#a30">Logger</a>. </td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="log4cxx::spi::AppenderAttachable::removeAppender" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void removeAppender </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">AppenderPtr</a> &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>appender</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Remove the appender passed as parameter from the list of appenders.
<p>
Implemented in <a class="el" href="classlog4cxx_1_1AsyncAppender.html#a10">AsyncAppender</a>, and <a class="el" href="classlog4cxx_1_1Logger.html#a29">Logger</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li>appenderattachable.h</ul>
</td>
</tr>
<!-- FOOTER -->
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr><td colspan="2">
<div align="center"><font color="#525D76" size="-1"><em>
Copyright &#169; 1999-2004, Apache Software Foundation
</em></font></div>
</td></tr>
</table>
<!-- END main table -->
</body>
</html>
<!-- end the processing -->