| <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></div> |
| <h1>DateLayout Class Reference</h1>Inheritance diagram for DateLayout:<p><center><img src="classlog4cxx_1_1helpers_1_1DateLayout__inherit__graph.png" border="0" usemap="#DateLayout__inherit__map" alt="Inheritance graph"></center> |
| <map name="DateLayout__inherit__map"> |
| <area href="classlog4cxx_1_1TTCCLayout.html" shape="rect" coords="68,317,150,341" alt=""> |
| <area href="classlog4cxx_1_1Layout.html" shape="rect" coords="84,168,134,191" alt=""> |
| <area href="classlog4cxx_1_1spi_1_1OptionHandler.html" shape="rect" coords="6,93,102,117" alt=""> |
| <area href="classlog4cxx_1_1helpers_1_1Object.html" shape="rect" coords="84,18,134,42" alt=""> |
| <area href="classlog4cxx_1_1helpers_1_1ObjectImpl.html" shape="rect" coords="126,93,201,117" alt=""> |
| </map> |
| <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for DateLayout:<p><center><img src="classlog4cxx_1_1helpers_1_1DateLayout__coll__graph.png" border="0" usemap="#DateLayout__coll__map" alt="Collaboration graph"></center> |
| <map name="DateLayout__coll__map"> |
| <area href="classlog4cxx_1_1Layout.html" shape="rect" coords="138,186,189,210" alt=""> |
| <area href="classlog4cxx_1_1spi_1_1OptionHandler.html" shape="rect" coords="6,96,102,120" alt=""> |
| <area href="classlog4cxx_1_1helpers_1_1Object.html" shape="rect" coords="90,18,141,42" alt=""> |
| <area href="classlog4cxx_1_1helpers_1_1ObjectImpl.html" shape="rect" coords="126,96,201,120" alt=""> |
| <area href="classlog4cxx_1_1helpers_1_1DateFormat.html" shape="rect" coords="217,186,297,210" alt=""> |
| <area href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html" shape="rect" coords="225,96,297,120" alt=""> |
| </map> |
| <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classlog4cxx_1_1helpers_1_1DateLayout-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_1DateLayout.html#a2">activateOptions</a> ()</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_1DateLayout.html#a3">setOption</a> (const String &option, const String &value)</td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1helpers_1_1DateLayout.html#a4">setDateFormat</a> (const String &dateFormat)</td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>const String & </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1helpers_1_1DateLayout.html#a5">getDateFormat</a> () const </td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1helpers_1_1DateLayout.html#a6">setTimeZone</a> (const String &timeZone)</td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>const String & </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1helpers_1_1DateLayout.html#a7">getTimeZone</a> () const </td></tr> |
| |
| <tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>String </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1helpers_1_1DateLayout.html#s0">NULL_DATE_FORMAT</a> = _T("NULL")</td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>String </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1helpers_1_1DateLayout.html#s1">RELATIVE_TIME_DATE_FORMAT</a> = _T("RELATIVE")</td></tr> |
| |
| <tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1helpers_1_1DateLayout.html#b0">setDateFormat</a> (const String &dateFormatType, const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">TimeZonePtr</a> &timeZone)</td></tr> |
| |
| </table> |
| <hr><a name="_details"></a><h2>Detailed Description</h2> |
| This abstract layout takes care of all the date related options and formatting work. |
| <p> |
| <hr><h2>Member Function Documentation</h2> |
| <a class="anchor" name="a2" doxytag="log4cxx::helpers::DateLayout::activateOptions" ></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 activateOptions </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap><code> [virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Activate the options that were previously set with calls to option setters.<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> |
| For example, the <a class="el" href="classlog4cxx_1_1FileAppender.html">FileAppender</a> has the <a class="el" href="classlog4cxx_1_1FileAppender.html#a5">File</a> and <a class="el" href="classlog4cxx_1_1FileAppender.html#a13">Append</a> options both of which are ambigous until the other is also set. |
| <p> |
| Implements <a class="el" href="classlog4cxx_1_1spi_1_1OptionHandler.html#a1">OptionHandler</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a5" doxytag="log4cxx::helpers::DateLayout::getDateFormat" ></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"> const String& getDateFormat </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const<code> [inline]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Returns value of the <b><a class="el" href="classlog4cxx_1_1helpers_1_1DateFormat.html">DateFormat</a></b> option. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a7" doxytag="log4cxx::helpers::DateLayout::getTimeZone" ></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"> const String& getTimeZone </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const<code> [inline]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Returns value of the <b>TimeZone</b> option. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="b0" doxytag="log4cxx::helpers::DateLayout::setDateFormat" ></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 setDateFormat </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const String & </td> |
| <td class="mdname" nowrap> <em>dateFormatType</em>, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap>const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">TimeZonePtr</a> & </td> |
| <td class="mdname" nowrap> <em>timeZone</em></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td class="md">) </td> |
| <td class="md" colspan="2"><code> [protected]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Sets the <a class="el" href="classlog4cxx_1_1helpers_1_1DateFormat.html">DateFormat</a> used to format date and time in the time zone determined by <code>timeZone</code> parameter. The <a class="el" href="classlog4cxx_1_1helpers_1_1DateFormat.html">helpers::DateFormat</a> <a class="el" href="classlog4cxx_1_1helpers_1_1DateFormat.html">DateFormat</a> used will depend on the <code>dateFormatType</code>.<p> |
| The recognized types are <a class="el" href="classlog4cxx_1_1helpers_1_1DateLayout.html#s0">NULL_DATE_FORMAT</a>, <a class="el" href="classlog4cxx_1_1helpers_1_1DateLayout.html#s1">RELATIVE_TIME_DATE_FORMAT</a>, <a class="el" href="classlog4cxx_1_1helpers_1_1AbsoluteTimeDateFormat.html#s1">helpers::AbsoluteTimeDateFormat::ABS_TIME_DATE_FORMAT</a>, <a class="el" href="classlog4cxx_1_1helpers_1_1AbsoluteTimeDateFormat.html#s2">helpers::AbsoluteTimeDateFormat::DATE_AND_TIME_DATE_FORMAT</a> and <a class="el" href="classlog4cxx_1_1helpers_1_1AbsoluteTimeDateFormat.html#s0">helpers::AbsoluteTimeDateFormat::ISO8601_DATE_FORMAT</a>. If the <code>dateFormatType</code> is not one of the above, then the argument is assumed to be a date pattern for <a class="el" href="classlog4cxx_1_1helpers_1_1DateFormat.html">helpers::DateFormat</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a4" doxytag="log4cxx::helpers::DateLayout::setDateFormat" ></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 setDateFormat </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const String & </td> |
| <td class="mdname1" valign="top" nowrap> <em>dateFormat</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap><code> [inline]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| The value of the <b><a class="el" href="classlog4cxx_1_1helpers_1_1DateFormat.html">DateFormat</a></b> option should be either an argument to the constructor of <a class="el" href="classlog4cxx_1_1helpers_1_1DateFormat.html">helpers::DateFormat</a> or one of the srings <b>"NULL"</b>, <b>"RELATIVE"</b>, <b>"ABSOLUTE"</b>, <b>"DATE"</b> or <b>"ISO8601</b>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a3" doxytag="log4cxx::helpers::DateLayout::setOption" ></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 setOption </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const String & </td> |
| <td class="mdname" nowrap> <em>option</em>, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap>const String & </td> |
| <td class="mdname" nowrap> <em>value</em></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td class="md">) </td> |
| <td class="md" colspan="2"><code> [virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Set <code>option</code> to <code>value</code>.<p> |
| The handling of each option depends on the OptionHandler instance. Some options may become active immediately whereas other may be activated only when <a class="el" href="classlog4cxx_1_1helpers_1_1DateLayout.html#a2">activateOptions</a> is called. |
| <p> |
| Implements <a class="el" href="classlog4cxx_1_1spi_1_1OptionHandler.html#a2">OptionHandler</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a6" doxytag="log4cxx::helpers::DateLayout::setTimeZone" ></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 setTimeZone </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const String & </td> |
| <td class="mdname1" valign="top" nowrap> <em>timeZone</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap><code> [inline]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| The <b>TimeZoneID</b> option is a time zone ID string in the format expected by the <code>locale</code> C++ standard class. </td> |
| </tr> |
| </table> |
| <hr><h2>Member Data Documentation</h2> |
| <a class="anchor" name="s0" doxytag="log4cxx::helpers::DateLayout::NULL_DATE_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"> String <a class="el" href="classlog4cxx_1_1helpers_1_1DateLayout.html#s0">NULL_DATE_FORMAT</a> = _T("NULL")<code> [static]</code> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| String constant designating no time information. Current value of this constant is <b>NULL</b>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="s1" doxytag="log4cxx::helpers::DateLayout::RELATIVE_TIME_DATE_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"> String <a class="el" href="classlog4cxx_1_1helpers_1_1DateLayout.html#s1">RELATIVE_TIME_DATE_FORMAT</a> = _T("RELATIVE")<code> [static]</code> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| String constant designating relative time. Current value of this constant is <b>RELATIVE</b>. </td> |
| </tr> |
| </table> |
| <hr>The documentation for this class was generated from the following files:<ul> |
| <li>datelayout.h<li>datelayout.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 --> |