<!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: DateFormat 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_format.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>DateFormat Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::helpers::DateFormat" --><!-- doxytag: inherits="log4cxx::helpers::ObjectImpl" -->
<p><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> is an abstract class for date/time formatting patterned after java.text.DateFormat.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html">log4cxx::helpers::ObjectImpl</a>.</p>
<p>Inherited by <a class="el" href="classlog4cxx_1_1helpers_1_1_relative_time_date_format.html">RelativeTimeDateFormat</a>, <a class="el" href="classlog4cxx_1_1helpers_1_1_simple_date_format.html">SimpleDateFormat</a>, <a class="el" href="classlog4cxx_1_1helpers_1_1_strftime_date_format.html">StrftimeDateFormat</a>, and <a class="el" href="classlog4cxx_1_1pattern_1_1_cached_date_format.html">CachedDateFormat</a>.</p>
<p><a href="classlog4cxx_1_1helpers_1_1_date_format-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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_date_format.html#aa62fd555fe5202905c53ad8630d8bfec">~DateFormat</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aa62fd555fe5202905c53ad8630d8bfec"></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_format.html#a96fc17cefabd50dec2d68967e45d36f1">format</a> (<a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &s, <a class="el" href="log4cxx_8h.html#adcf85375d350e7045ac5570a2c922aec">log4cxx_time_t</a> tm, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Formats an log4cxx_time_t into a date/time string. <a href="#a96fc17cefabd50dec2d68967e45d36f1"></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_format.html#a4eb964c1a542b0bcf877227ec3909414">setTimeZone</a> (const TimeZonePtr &zone)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the time zone. <a href="#a4eb964c1a542b0bcf877227ec3909414"></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_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="pro-methods"></a>
Protected 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_format.html#a4ed3a759825dfb2e3acacc178dd13416">DateFormat</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a4ed3a759825dfb2e3acacc178dd13416"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><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> is an abstract class for date/time formatting patterned after java.text.DateFormat. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa62fd555fe5202905c53ad8630d8bfec"></a><!-- doxytag: member="log4cxx::helpers::DateFormat::~DateFormat" ref="aa62fd555fe5202905c53ad8630d8bfec" 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_format.html">DateFormat</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<a class="anchor" id="a4ed3a759825dfb2e3acacc178dd13416"></a><!-- doxytag: member="log4cxx::helpers::DateFormat::DateFormat" ref="a4ed3a759825dfb2e3acacc178dd13416" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_date_format.html">DateFormat</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a96fc17cefabd50dec2d68967e45d36f1"></a><!-- doxytag: member="log4cxx::helpers::DateFormat::format" ref="a96fc17cefabd50dec2d68967e45d36f1" args="(LogString &s, log4cxx_time_t tm, log4cxx::helpers::Pool &p) const =0" -->
<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>s</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>tm</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> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Formats an log4cxx_time_t into a date/time string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>string to which the date/time string is appended. </td></tr>
<tr><td class="paramname">tm</td><td>date to be formatted. </td></tr>
<tr><td class="paramname">p</td><td>memory pool used during formatting. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classlog4cxx_1_1pattern_1_1_cached_date_format.html#aa7657d218e7a6847b2160d87ae4389c0">CachedDateFormat</a>, <a class="el" href="classlog4cxx_1_1helpers_1_1_relative_time_date_format.html#acf35afd137bc3c07de6c16c83c650220">RelativeTimeDateFormat</a>, <a class="el" href="classlog4cxx_1_1helpers_1_1_simple_date_format.html#acf35afd137bc3c07de6c16c83c650220">SimpleDateFormat</a>, and <a class="el" href="classlog4cxx_1_1helpers_1_1_strftime_date_format.html#acf35afd137bc3c07de6c16c83c650220">StrftimeDateFormat</a>.</p>
</div>
</div>
<a class="anchor" id="ad5f69e832f2e604c0bf64b1fecb9ce82"></a><!-- doxytag: member="log4cxx::helpers::DateFormat::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>
<dl class="remark"><dt><b>Remarks:</b></dt><dd>This method is used by CachedDateFormat to format the milliseconds. </dd></dl>
<p>Reimplemented in <a class="el" href="classlog4cxx_1_1pattern_1_1_cached_date_format.html#ad5f69e832f2e604c0bf64b1fecb9ce82">CachedDateFormat</a>.</p>
</div>
</div>
<a class="anchor" id="a4eb964c1a542b0bcf877227ec3909414"></a><!-- doxytag: member="log4cxx::helpers::DateFormat::setTimeZone" ref="a4eb964c1a542b0bcf877227ec3909414" args="(const 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 TimeZonePtr & </td>
<td class="paramname"><em>zone</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the time zone. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">zone</td><td>the given new time zone. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classlog4cxx_1_1helpers_1_1_simple_date_format.html#a3ade83b8918728e2a05ee6ede0ba6d9f">SimpleDateFormat</a>, and <a class="el" href="classlog4cxx_1_1helpers_1_1_strftime_date_format.html#a3ade83b8918728e2a05ee6ede0ba6d9f">StrftimeDateFormat</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="dateformat_8h.html">dateformat.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_format.html">DateFormat</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>
