<!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: DailyRollingFileAppender 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_1_daily_rolling_file_appender.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>DailyRollingFileAppender Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::DailyRollingFileAppender" --><!-- doxytag: inherits="log4cxx::rolling::RollingFileAppenderSkeleton" -->
<p><a class="el" href="classlog4cxx_1_1_daily_rolling_file_appender.html" title="DailyRollingFileAppender extends FileAppender so that the underlying file is rolled over at a user ch...">DailyRollingFileAppender</a> extends <a class="el" href="classlog4cxx_1_1_file_appender.html">FileAppender</a> so that the underlying file is rolled over at a user chosen frequency.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_file_appender_skeleton.html">log4cxx::rolling::RollingFileAppenderSkeleton</a>.</p>
<p><a href="classlog4cxx_1_1_daily_rolling_file_appender-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_1_daily_rolling_file_appender.html#ad07e32d489f3a68035f22bb71432663c">DailyRollingFileAppender</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The default constructor simply calls its <a class="el" href="classlog4cxx_1_1_file_appender.html#a3d8fe210d6211cccc14aa2363753cffd">parents constructor</a>. <a href="#ad07e32d489f3a68035f22bb71432663c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_daily_rolling_file_appender.html#af35541dbb66191765c6769df0116f2bd">DailyRollingFileAppender</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LayoutPtr</a> &<a class="el" href="classlog4cxx_1_1_appender_skeleton.html#af1f4e6a2229d95a18324c4e7fa71be65">layout</a>, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &filename, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &datePattern)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Instantiate a <a class="el" href="classlog4cxx_1_1_daily_rolling_file_appender.html" title="DailyRollingFileAppender extends FileAppender so that the underlying file is rolled over at a user ch...">DailyRollingFileAppender</a> and open the file designated by <code>filename</code>. <a href="#af35541dbb66191765c6769df0116f2bd"></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_1_daily_rolling_file_appender.html#af598ebf12a1b864b8945550eb71d7148">setDatePattern</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &pattern)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <b>DatePattern</b> takes a string in the same format as expected by <a class="el" href="classlog4cxx_1_1helpers_1_1_simple_date_format.html">SimpleDateFormat</a>. <a href="#af598ebf12a1b864b8945550eb71d7148"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_daily_rolling_file_appender.html#a30e63edb36ab51d054fe95c59d3f9300">getDatePattern</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the value of the <b>DatePattern</b> option. <a href="#a30e63edb36ab51d054fe95c59d3f9300"></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_1_daily_rolling_file_appender.html#ac1d269357907e0809687a2bec962e1c8">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="#ac1d269357907e0809687a2bec962e1c8"></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_1_daily_rolling_file_appender.html#a580abdcb8fd42d07eaf679166f77bc34">activateOptions</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prepares <a class="el" href="classlog4cxx_1_1_daily_rolling_file_appender.html" title="DailyRollingFileAppender extends FileAppender so that the underlying file is rolled over at a user ch...">DailyRollingFileAppender</a> for use. <a href="#a580abdcb8fd42d07eaf679166f77bc34"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classlog4cxx_1_1_daily_rolling_file_appender.html" title="DailyRollingFileAppender extends FileAppender so that the underlying file is rolled over at a user ch...">DailyRollingFileAppender</a> extends <a class="el" href="classlog4cxx_1_1_file_appender.html">FileAppender</a> so that the underlying file is rolled over at a user chosen frequency. </p>
<p>The rolling schedule is specified by the <b>DatePattern</b> option. This pattern should follow the <a class="el" href="classlog4cxx_1_1helpers_1_1_simple_date_format.html">SimpleDateFormat</a> conventions. In particular, you <em>must</em> escape literal text within a pair of single quotes. A formatted version of the date pattern is used as the suffix for the rolled file name.</p>
<p>For example, if the <b><a class="el" href="classlog4cxx_1_1_file.html" title="An abstract representation of file and directory path names.">File</a></b> option is set to <code>/foo/bar.log</code> and the <b>DatePattern</b> set to <code>'.'yyyy-MM-dd</code>, on 2001-02-16 at midnight, the logging file <code>/foo/bar.log</code> will be copied to <code>/foo/bar.log.2001-02-16</code> and logging for 2001-02-17 will continue in <code>/foo/bar.log</code> until it rolls over the next day.</p>
<p>Is is possible to specify monthly, weekly, half-daily, daily, hourly, or minutely rollover schedules.</p>
<table border="1" cellpadding="2">
<tr>
<th>DatePattern </th><th>Rollover schedule </th><th><p class="starttd">Example</p>
<p class="endtd"></p>
</th></tr>
<tr>
<td><code>'.'yyyy-MM</code> </td><td><p class="starttd">Rollover at the beginning of each month</p>
<p class="endtd"></p>
</td><td><p class="starttd">At midnight of May 31st, 2002 <code>/foo/bar.log</code> will be copied to <code>/foo/bar.log.2002-05</code>. Logging for the month of June will be output to <code>/foo/bar.log</code> until it is also rolled over the next month.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"><code>'.'yyyy-ww</code></p>
<p class="endtd"></p>
</td><td><p class="starttd">Rollover at the first day of each week. The first day of the week depends on the locale.</p>
<p class="endtd"></p>
</td><td><p class="starttd">Assuming the first day of the week is Sunday, on Saturday midnight, June 9th 2002, the file <em>/foo/bar.log</em> will be copied to <em>/foo/bar.log.2002-23</em>. Logging for the 24th week of 2002 will be output to <code>/foo/bar.log</code> until it is rolled over the next week.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"><code>'.'yyyy-MM-dd</code></p>
<p class="endtd"></p>
</td><td><p class="starttd">Rollover at midnight each day.</p>
<p class="endtd"></p>
</td><td><p class="starttd">At midnight, on March 8th, 2002, <code>/foo/bar.log</code> will be copied to <code>/foo/bar.log.2002-03-08</code>. Logging for the 9th day of March will be output to <code>/foo/bar.log</code> until it is rolled over the next day.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"><code>'.'yyyy-MM-dd-a</code></p>
<p class="endtd"></p>
</td><td><p class="starttd">Rollover at midnight and midday of each day.</p>
<p class="endtd"></p>
</td><td><p class="starttd">At noon, on March 9th, 2002, <code>/foo/bar.log</code> will be copied to <code>/foo/bar.log.2002-03-09-AM</code>. Logging for the afternoon of the 9th will be output to <code>/foo/bar.log</code> until it is rolled over at midnight.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"><code>'.'yyyy-MM-dd-HH</code></p>
<p class="endtd"></p>
</td><td><p class="starttd">Rollover at the top of every hour.</p>
<p class="endtd"></p>
</td><td><p class="starttd">At approximately 11:00.000 o'clock on March 9th, 2002, <code>/foo/bar.log</code> will be copied to <code>/foo/bar.log.2002-03-09-10</code>. Logging for the 11th hour of the 9th of March will be output to <code>/foo/bar.log</code> until it is rolled over at the beginning of the next hour.</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td><p class="starttd"><code>'.'yyyy-MM-dd-HH-mm</code></p>
<p class="endtd"></p>
</td><td><p class="starttd">Rollover at the beginning of every minute.</p>
<p class="endtd"></p>
</td><td><p class="starttd">At approximately 11:23,000, on March 9th, 2001, <code>/foo/bar.log</code> will be copied to <code>/foo/bar.log.2001-03-09-10-22</code>. Logging for the minute of 11:23 (9th of March) will be output to <code>/foo/bar.log</code> until it is rolled over the next minute.</p>
<p class="endtd"></p>
</td></tr>
</table>
<p>Do not use the colon ":" character in anywhere in the <b>DatePattern</b> option. The text before the colon is interpeted as the protocol specificaion of a URL which is probably not what you want. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad07e32d489f3a68035f22bb71432663c"></a><!-- doxytag: member="log4cxx::DailyRollingFileAppender::DailyRollingFileAppender" ref="ad07e32d489f3a68035f22bb71432663c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1_daily_rolling_file_appender.html">DailyRollingFileAppender</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The default constructor simply calls its <a class="el" href="classlog4cxx_1_1_file_appender.html#a3d8fe210d6211cccc14aa2363753cffd">parents constructor</a>. </p>
</div>
</div>
<a class="anchor" id="af35541dbb66191765c6769df0116f2bd"></a><!-- doxytag: member="log4cxx::DailyRollingFileAppender::DailyRollingFileAppender" ref="af35541dbb66191765c6769df0116f2bd" args="(const LayoutPtr &layout, const LogString &filename, const LogString &datePattern)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1_daily_rolling_file_appender.html">DailyRollingFileAppender</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LayoutPtr</a> & </td>
<td class="paramname"><em>layout</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>filename</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>datePattern</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Instantiate a <a class="el" href="classlog4cxx_1_1_daily_rolling_file_appender.html" title="DailyRollingFileAppender extends FileAppender so that the underlying file is rolled over at a user ch...">DailyRollingFileAppender</a> and open the file designated by <code>filename</code>. </p>
<p>The opened filename will become the ouput destination for this appender. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a580abdcb8fd42d07eaf679166f77bc34"></a><!-- doxytag: member="log4cxx::DailyRollingFileAppender::activateOptions" ref="a580abdcb8fd42d07eaf679166f77bc34" args="(log4cxx::helpers::Pool &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Prepares <a class="el" href="classlog4cxx_1_1_daily_rolling_file_appender.html" title="DailyRollingFileAppender extends FileAppender so that the underlying file is rolled over at a user ch...">DailyRollingFileAppender</a> for use. </p>
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_file_appender_skeleton.html#a580abdcb8fd42d07eaf679166f77bc34">RollingFileAppenderSkeleton</a>.</p>
</div>
</div>
<a class="anchor" id="a30e63edb36ab51d054fe95c59d3f9300"></a><!-- doxytag: member="log4cxx::DailyRollingFileAppender::getDatePattern" ref="a30e63edb36ab51d054fe95c59d3f9300" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> getDatePattern </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the value of the <b>DatePattern</b> option. </p>
</div>
</div>
<a class="anchor" id="af598ebf12a1b864b8945550eb71d7148"></a><!-- doxytag: member="log4cxx::DailyRollingFileAppender::setDatePattern" ref="af598ebf12a1b864b8945550eb71d7148" args="(const LogString &pattern)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setDatePattern </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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The <b>DatePattern</b> takes a string in the same format as expected by <a class="el" href="classlog4cxx_1_1helpers_1_1_simple_date_format.html">SimpleDateFormat</a>. </p>
<p>This options determines the rollover schedule. </p>
</div>
</div>
<a class="anchor" id="ac1d269357907e0809687a2bec962e1c8"></a><!-- doxytag: member="log4cxx::DailyRollingFileAppender::setOption" ref="ac1d269357907e0809687a2bec962e1c8" args="(const LogString &option, const LogString &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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_1_daily_rolling_file_appender.html#a580abdcb8fd42d07eaf679166f77bc34" title="Prepares DailyRollingFileAppender for use.">activateOptions</a> is called. </p>
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1_file_appender.html#ac1d269357907e0809687a2bec962e1c8">FileAppender</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="dailyrollingfileappender_8h.html">dailyrollingfileappender.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="classlog4cxx_1_1_daily_rolling_file_appender.html">DailyRollingFileAppender</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>
