<!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: CachedDateFormat 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_1pattern_1_1_cached_date_format.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<h1>CachedDateFormat Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::pattern::CachedDateFormat" --><!-- doxytag: inherits="log4cxx::helpers::DateFormat" -->
<p>Inherits <a class="el" href="classlog4cxx_1_1helpers_1_1_date_format.html">log4cxx::helpers::DateFormat</a>.</p>
<p><a href="classlog4cxx_1_1pattern_1_1_cached_date_format-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <a class="el" href="classlog4cxx_1_1pattern_1_1_cached_date_format.html#adf764cbdea00d65edcd07bb9953ad2b7a7be08bab91f2340e7221e8ffe2ddac49">NO_MILLISECONDS</a> = -2,
<a class="el" href="classlog4cxx_1_1pattern_1_1_cached_date_format.html#adf764cbdea00d65edcd07bb9953ad2b7a1b695a298b4ea96545e125c36a1ded3c">UNRECOGNIZED_MILLISECONDS</a> = -1
}</td></tr>
<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_1pattern_1_1_cached_date_format.html#ae5f327d96f89fe1ae7ca4f182bb8d36f">CachedDateFormat</a> (const log4cxx::helpers::DateFormatPtr &dateFormat, int expiration)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classlog4cxx_1_1pattern_1_1_cached_date_format.html">CachedDateFormat</a> object. <a href="#ae5f327d96f89fe1ae7ca4f182bb8d36f"></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_1pattern_1_1_cached_date_format.html#aa7657d218e7a6847b2160d87ae4389c0">format</a> (<a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &sbuf, <a class="el" href="log4cxx_8h.html#adcf85375d350e7045ac5570a2c922aec">log4cxx_time_t</a> date, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Formats a Date into a date/time string. <a href="#aa7657d218e7a6847b2160d87ae4389c0"></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_1pattern_1_1_cached_date_format.html#a9f84241757bbfca5c06353ab6ffaf95d">setTimeZone</a> (const log4cxx::helpers::TimeZonePtr &zone)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set timezone. <a href="#a9f84241757bbfca5c06353ab6ffaf95d"></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_1pattern_1_1_cached_date_format.html#ad5f69e832f2e604c0bf64b1fecb9ce82">numberFormat</a> (<a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &s, int n, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Format an integer consistent with the format method. <a href="#ad5f69e832f2e604c0bf64b1fecb9ce82"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_cached_date_format.html#af9d0f8f14823faa4bbe7f344fa89af75">findMillisecondStart</a> (<a class="el" href="log4cxx_8h.html#adcf85375d350e7045ac5570a2c922aec">log4cxx_time_t</a> time, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &formatted, const log4cxx::helpers::DateFormatPtr &formatter, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &pool)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finds start of millisecond field in formatted time. <a href="#af9d0f8f14823faa4bbe7f344fa89af75"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1pattern_1_1_cached_date_format.html#a6f5274fcb26c6fc5ccf2cae9191e1ec1">getMaximumCacheValidity</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &pattern)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets maximum cache validity for the specified SimpleDateTime conversion pattern. <a href="#a6f5274fcb26c6fc5ccf2cae9191e1ec1"></a><br/></td></tr>
</table>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="adf764cbdea00d65edcd07bb9953ad2b7"></a><!-- doxytag: member="log4cxx::pattern::CachedDateFormat::@1" ref="adf764cbdea00d65edcd07bb9953ad2b7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="adf764cbdea00d65edcd07bb9953ad2b7a7be08bab91f2340e7221e8ffe2ddac49"></a><!-- doxytag: member="NO_MILLISECONDS" ref="adf764cbdea00d65edcd07bb9953ad2b7a7be08bab91f2340e7221e8ffe2ddac49" args="" -->NO_MILLISECONDS</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="adf764cbdea00d65edcd07bb9953ad2b7a1b695a298b4ea96545e125c36a1ded3c"></a><!-- doxytag: member="UNRECOGNIZED_MILLISECONDS" ref="adf764cbdea00d65edcd07bb9953ad2b7a1b695a298b4ea96545e125c36a1ded3c" args="" -->UNRECOGNIZED_MILLISECONDS</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae5f327d96f89fe1ae7ca4f182bb8d36f"></a><!-- doxytag: member="log4cxx::pattern::CachedDateFormat::CachedDateFormat" ref="ae5f327d96f89fe1ae7ca4f182bb8d36f" args="(const log4cxx::helpers::DateFormatPtr &dateFormat, int expiration)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1pattern_1_1_cached_date_format.html">CachedDateFormat</a> </td>
<td>(</td>
<td class="paramtype">const log4cxx::helpers::DateFormatPtr & </td>
<td class="paramname"><em>dateFormat</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>expiration</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new <a class="el" href="classlog4cxx_1_1pattern_1_1_cached_date_format.html">CachedDateFormat</a> object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">dateFormat</td><td>Date format, may not be null. </td></tr>
<tr><td class="paramname">expiration</td><td>maximum cached range in microseconds. If the dateFormat is known to be incompatible with the caching algorithm, use a value of 0 to totally disable caching or 1 to only use cache for duplicate requests. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af9d0f8f14823faa4bbe7f344fa89af75"></a><!-- doxytag: member="log4cxx::pattern::CachedDateFormat::findMillisecondStart" ref="af9d0f8f14823faa4bbe7f344fa89af75" args="(log4cxx_time_t time, const LogString &formatted, const log4cxx::helpers::DateFormatPtr &formatter, log4cxx::helpers::Pool &pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int findMillisecondStart </td>
<td>(</td>
<td class="paramtype"><a class="el" href="log4cxx_8h.html#adcf85375d350e7045ac5570a2c922aec">log4cxx_time_t</a> </td>
<td class="paramname"><em>time</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>formatted</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const log4cxx::helpers::DateFormatPtr & </td>
<td class="paramname"><em>formatter</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>pool</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finds start of millisecond field in formatted time. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">time</td><td>long time, must be integral number of seconds </td></tr>
<tr><td class="paramname">formatted</td><td>String corresponding formatted string </td></tr>
<tr><td class="paramname">formatter</td><td>DateFormat date format </td></tr>
<tr><td class="paramname">pool</td><td>pool. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>int position in string of first digit of milliseconds, -1 indicates no millisecond field, -2 indicates unrecognized field (likely RelativeTimeDateFormat) </dd></dl>
</div>
</div>
<a class="anchor" id="aa7657d218e7a6847b2160d87ae4389c0"></a><!-- doxytag: member="log4cxx::pattern::CachedDateFormat::format" ref="aa7657d218e7a6847b2160d87ae4389c0" args="(LogString &sbuf, log4cxx_time_t date, log4cxx::helpers::Pool &p) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void format </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>sbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="log4cxx_8h.html#adcf85375d350e7045ac5570a2c922aec">log4cxx_time_t</a> </td>
<td class="paramname"><em>date</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<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Formats a Date into a date/time string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">date</td><td>the date to format. </td></tr>
<tr><td class="paramname">sbuf</td><td>the string buffer to write to. </td></tr>
<tr><td class="paramname">p</td><td>memory pool. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classlog4cxx_1_1helpers_1_1_date_format.html#a96fc17cefabd50dec2d68967e45d36f1">DateFormat</a>.</p>
</div>
</div>
<a class="anchor" id="a6f5274fcb26c6fc5ccf2cae9191e1ec1"></a><!-- doxytag: member="log4cxx::pattern::CachedDateFormat::getMaximumCacheValidity" ref="a6f5274fcb26c6fc5ccf2cae9191e1ec1" args="(const LogString &pattern)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int getMaximumCacheValidity </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>pattern</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets maximum cache validity for the specified SimpleDateTime conversion pattern. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pattern</td><td>conversion pattern, may not be null. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Duration in microseconds from an integral second that the cache will return consistent results. </dd></dl>
</div>
</div>
<a class="anchor" id="ad5f69e832f2e604c0bf64b1fecb9ce82"></a><!-- doxytag: member="log4cxx::pattern::CachedDateFormat::numberFormat" ref="ad5f69e832f2e604c0bf64b1fecb9ce82" args="(LogString &s, int n, log4cxx::helpers::Pool &p) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void numberFormat </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">int </td>
<td class="paramname"><em>n</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<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Format an integer consistent with the format method. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>string to which the numeric string is appended. </td></tr>
<tr><td class="paramname">n</td><td>integer value. </td></tr>
<tr><td class="paramname">p</td><td>memory pool used during formatting. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1helpers_1_1_date_format.html#ad5f69e832f2e604c0bf64b1fecb9ce82">DateFormat</a>.</p>
</div>
</div>
<a class="anchor" id="a9f84241757bbfca5c06353ab6ffaf95d"></a><!-- doxytag: member="log4cxx::pattern::CachedDateFormat::setTimeZone" ref="a9f84241757bbfca5c06353ab6ffaf95d" args="(const log4cxx::helpers::TimeZonePtr &zone)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void setTimeZone </td>
<td>(</td>
<td class="paramtype">const log4cxx::helpers::TimeZonePtr & </td>
<td class="paramname"><em>zone</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set timezone. </p>
<dl class="remark"><dt><b>Remarks:</b></dt><dd>Setting the timezone using getCalendar().<a class="el" href="classlog4cxx_1_1pattern_1_1_cached_date_format.html#a9f84241757bbfca5c06353ab6ffaf95d" title="Set timezone.">setTimeZone()</a> will likely cause caching to misbehave. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">zone</td><td>TimeZone new timezone </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="cacheddateformat_8h.html">cacheddateformat.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_1pattern.html">pattern</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1pattern_1_1_cached_date_format.html">CachedDateFormat</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>
