<!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: DateLayout 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_1helpers_1_1_date_layout.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>DateLayout Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::helpers::DateLayout" --><!-- doxytag: inherits="log4cxx::Layout" -->
<p>This abstract layout takes care of all the date related options and formatting work.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1_layout.html">log4cxx::Layout</a>.</p>
<p>Inherited by <a class="el" href="classlog4cxx_1_1_t_t_c_c_layout.html">TTCCLayout</a>.</p>
<p><a href="classlog4cxx_1_1helpers_1_1_date_layout-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_1helpers_1_1_date_layout.html#a4980f1622f115668d84760966d0280dc">DateLayout</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &dateLayoutOption)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_date_layout.html#a8c1fa2ff504a9bcc82752f15d0d7d01c">~DateLayout</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_1helpers_1_1_date_layout.html#af1f3ced78d335ec9c2b800d6d5aa3ef8">activateOptions</a> (<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">Activate the options that were previously set with calls to option setters. <a href="#af1f3ced78d335ec9c2b800d6d5aa3ef8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_date_layout.html#aee5023c29cca9dc68164b22a01cb7c6e">setOption</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &option, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set <code>option</code> to <code>value</code>. <a href="#aee5023c29cca9dc68164b22a01cb7c6e"></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_1helpers_1_1_date_layout.html#a7f7ef38b2c36b1f530a4da63458a1e54">setDateFormat</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &dateFormat1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The value of the <b><a class="el" href="classlog4cxx_1_1helpers_1_1_date_format.html" title="DateFormat is an abstract class for date/time formatting patterned after java.text.DateFormat.">DateFormat</a></b> option should be either an argument to the constructor of <a class="el" href="classlog4cxx_1_1helpers_1_1_date_format.html" title="DateFormat is an abstract class for date/time formatting patterned after java.text.DateFormat.">helpers::DateFormat</a> or one of the strings <b>"NULL"</b>, <b>"RELATIVE"</b>, <b>"ABSOLUTE"</b>, <b>"DATE"</b> or <b>"ISO8601</b>. <a href="#a7f7ef38b2c36b1f530a4da63458a1e54"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_date_layout.html#ad4184c4defaf3a8ec47731c47893bd11">getDateFormat</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns value of the <b><a class="el" href="classlog4cxx_1_1helpers_1_1_date_format.html" title="DateFormat is an abstract class for date/time formatting patterned after java.text.DateFormat.">DateFormat</a></b> option. <a href="#ad4184c4defaf3a8ec47731c47893bd11"></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_1helpers_1_1_date_layout.html#a119bd446fc6748a02bedc17f16466549">setTimeZone</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &timeZone)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <b>TimeZoneID</b> option is a time zone ID string in the format expected by the <code>locale</code> C++ standard class. <a href="#a119bd446fc6748a02bedc17f16466549"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_date_layout.html#ac83674603203cb08dcfdc681cd940886">getTimeZone</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns value of the <b><a class="el" href="classlog4cxx_1_1helpers_1_1_time_zone.html">TimeZone</a></b> option. <a href="#ac83674603203cb08dcfdc681cd940886"></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_1helpers_1_1_date_layout.html#abbabed22459ea31baf2e35933632721c">formatDate</a> (<a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &s, const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggingEventPtr</a> &event, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p) const </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">DateFormatPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_date_layout.html#a0595fba33539dd3c1f27efd9f8ffe5e6">dateFormat</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This abstract layout takes care of all the date related options and formatting work. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a4980f1622f115668d84760966d0280dc"></a><!-- doxytag: member="log4cxx::helpers::DateLayout::DateLayout" ref="a4980f1622f115668d84760966d0280dc" args="(const LogString &dateLayoutOption)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_date_layout.html">DateLayout</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>dateLayoutOption</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a8c1fa2ff504a9bcc82752f15d0d7d01c"></a><!-- doxytag: member="log4cxx::helpers::DateLayout::~DateLayout" ref="a8c1fa2ff504a9bcc82752f15d0d7d01c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classlog4cxx_1_1helpers_1_1_date_layout.html">DateLayout</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af1f3ced78d335ec9c2b800d6d5aa3ef8"></a><!-- doxytag: member="log4cxx::helpers::DateLayout::activateOptions" ref="af1f3ced78d335ec9c2b800d6d5aa3ef8" args="(log4cxx::helpers::Pool &p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void activateOptions </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><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Activate the options that were previously set with calls to option setters. </p>
<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>
<p>For example, the <a class="el" href="classlog4cxx_1_1_file_appender.html" title="FileAppender appends log events to a file.">FileAppender</a> has the <a class="el" href="classlog4cxx_1_1_file_appender.html#a6a6c98222ccf2072dad5a434f9336930">File</a> and <a class="el" href="classlog4cxx_1_1_file_appender.html#a78ebca211ceb3a0b2960a48092089906">Append</a> options both of which are ambigous until the other is also set. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#af04d4bfbd66b46083b1aa042fdafbb06">OptionHandler</a>.</p>
</div>
</div>
<a class="anchor" id="abbabed22459ea31baf2e35933632721c"></a><!-- doxytag: member="log4cxx::helpers::DateLayout::formatDate" ref="abbabed22459ea31baf2e35933632721c" args="(LogString &s, const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void formatDate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>s</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::LoggingEventPtr</a> & </td>
<td class="paramname"><em>event</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> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad4184c4defaf3a8ec47731c47893bd11"></a><!-- doxytag: member="log4cxx::helpers::DateLayout::getDateFormat" ref="ad4184c4defaf3a8ec47731c47893bd11" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a>& getDateFormat </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns value of the <b><a class="el" href="classlog4cxx_1_1helpers_1_1_date_format.html" title="DateFormat is an abstract class for date/time formatting patterned after java.text.DateFormat.">DateFormat</a></b> option. </p>
</div>
</div>
<a class="anchor" id="ac83674603203cb08dcfdc681cd940886"></a><!-- doxytag: member="log4cxx::helpers::DateLayout::getTimeZone" ref="ac83674603203cb08dcfdc681cd940886" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a>& getTimeZone </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns value of the <b><a class="el" href="classlog4cxx_1_1helpers_1_1_time_zone.html">TimeZone</a></b> option. </p>
</div>
</div>
<a class="anchor" id="a7f7ef38b2c36b1f530a4da63458a1e54"></a><!-- doxytag: member="log4cxx::helpers::DateLayout::setDateFormat" ref="a7f7ef38b2c36b1f530a4da63458a1e54" args="(const LogString &dateFormat1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setDateFormat </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>dateFormat1</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The value of the <b><a class="el" href="classlog4cxx_1_1helpers_1_1_date_format.html" title="DateFormat is an abstract class for date/time formatting patterned after java.text.DateFormat.">DateFormat</a></b> option should be either an argument to the constructor of <a class="el" href="classlog4cxx_1_1helpers_1_1_date_format.html" title="DateFormat is an abstract class for date/time formatting patterned after java.text.DateFormat.">helpers::DateFormat</a> or one of the strings <b>"NULL"</b>, <b>"RELATIVE"</b>, <b>"ABSOLUTE"</b>, <b>"DATE"</b> or <b>"ISO8601</b>. </p>
</div>
</div>
<a class="anchor" id="aee5023c29cca9dc68164b22a01cb7c6e"></a><!-- doxytag: member="log4cxx::helpers::DateLayout::setOption" ref="aee5023c29cca9dc68164b22a01cb7c6e" args="(const LogString &option, const LogString &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void setOption </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></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set <code>option</code> to <code>value</code>. </p>
<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_1_date_layout.html#af1f3ced78d335ec9c2b800d6d5aa3ef8" title="Activate the options that were previously set with calls to option setters.">activateOptions</a> is called. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#a8f2ae2ded63f80c627269c99b20c19ee">OptionHandler</a>.</p>
</div>
</div>
<a class="anchor" id="a119bd446fc6748a02bedc17f16466549"></a><!-- doxytag: member="log4cxx::helpers::DateLayout::setTimeZone" ref="a119bd446fc6748a02bedc17f16466549" args="(const LogString &timeZone)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setTimeZone </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>timeZone</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The <b>TimeZoneID</b> option is a time zone ID string in the format expected by the <code>locale</code> C++ standard class. </p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a0595fba33539dd3c1f27efd9f8ffe5e6"></a><!-- doxytag: member="log4cxx::helpers::DateLayout::dateFormat" ref="a0595fba33539dd3c1f27efd9f8ffe5e6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DateFormatPtr <a class="el" href="classlog4cxx_1_1helpers_1_1_date_layout.html#a0595fba33539dd3c1f27efd9f8ffe5e6">dateFormat</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="datelayout_8h.html">datelayout.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_1helpers.html">helpers</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1helpers_1_1_date_layout.html">DateLayout</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>
