| <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 Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
| <h1>PatternConverter Class Reference</h1>Inheritance diagram for PatternConverter:<p><center><img src="classlog4cxx_1_1helpers_1_1PatternConverter__inherit__graph.png" border="0" usemap="#PatternConverter__inherit__map" alt="Inheritance graph"></center> |
| <map name="PatternConverter__inherit__map"> |
| <area href="classlog4cxx_1_1helpers_1_1ObjectImpl.html" shape="rect" coords="24,93,98,117" alt=""> |
| <area href="classlog4cxx_1_1helpers_1_1Object.html" shape="rect" coords="36,18,86,42" alt=""> |
| </map> |
| <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for PatternConverter:<p><center><img src="classlog4cxx_1_1helpers_1_1PatternConverter__coll__graph.png" border="0" usemap="#PatternConverter__coll__map" alt="Collaboration graph"></center> |
| <map name="PatternConverter__coll__map"> |
| <area href="classlog4cxx_1_1helpers_1_1ObjectImpl.html" shape="rect" coords="6,96,81,120" alt=""> |
| <area href="classlog4cxx_1_1helpers_1_1Object.html" shape="rect" coords="18,19,69,43" alt=""> |
| <area href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html" shape="rect" coords="105,96,177,120" alt=""> |
| </map> |
| <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classlog4cxx_1_1helpers_1_1PatternConverter-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 </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1helpers_1_1PatternConverter.html#a0">format</a> (ostream &sbuf, const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">spi::LoggingEventPtr</a> &e) const </td></tr> |
| |
| <tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1helpers_1_1PatternConverter.html#b2">convert</a> (ostream &sbuf, const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">spi::LoggingEventPtr</a> &event) const=0</td></tr> |
| |
| </table> |
| <hr><a name="_details"></a><h2>Detailed Description</h2> |
| <a class="el" href="classlog4cxx_1_1helpers_1_1PatternConverter.html">PatternConverter</a> is an abtract class that provides the formatting functionality that derived classes need.<p> |
| Conversion specifiers in a conversion patterns are parsed to individual PatternConverters. Each of which is responsible for converting a logging event in a converter specific manner. |
| <p> |
| <hr><h2>Member Function Documentation</h2> |
| <a class="anchor" name="b2" doxytag="log4cxx::helpers::PatternConverter::convert" ></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 convert </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">ostream & </td> |
| <td class="mdname" nowrap> <em>sbuf</em>, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap>const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">spi::LoggingEventPtr</a> & </td> |
| <td class="mdname" nowrap> <em>event</em></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td class="md">) </td> |
| <td class="md" colspan="2"> const<code> [protected, pure virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Derived pattern converters must override this method in order to convert conversion specifiers in the correct way. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a0" doxytag="log4cxx::helpers::PatternConverter::format" ></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"> void format </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">ostream & </td> |
| <td class="mdname" nowrap> <em>sbuf</em>, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap>const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">spi::LoggingEventPtr</a> & </td> |
| <td class="mdname" nowrap> <em>e</em></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td class="md">) </td> |
| <td class="md" colspan="2"> const<code> [virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| A template method for formatting in a converter specific way. </td> |
| </tr> |
| </table> |
| <hr>The documentation for this class was generated from the following files:<ul> |
| <li>patternconverter.h<li>patternconverter.cpp</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 © 1999-2004, Apache Software Foundation |
| </em></font></div> |
| </td></tr> |
| </table> |
| <!-- END main table --> |
| </body> |
| </html> |
| <!-- end the processing --> |