MINI SHELL

Server : Apache/2.2.2 (Fedora)
System : Linux App1.pathumtani.go.th 2.6.20-1.2320.fc5smp #1 SMP Tue Jun 12 19:40:16 EDT 2007 i686
User : apache ( 48)
PHP Version : 5.2.9
Disable Function : NONE
Directory :  /usr/share/javadoc/log4j-1.2.8/org/apache/log4j/

Upload File :
current_dir [ Writeable ] document_root [ Writeable ]

 

Current File : //usr/share/javadoc/log4j-1.2.8/org/apache/log4j/RollingFileAppender.html
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE html PUBLIC "-//gnu.org///DTD XHTML 1.1 plus Target 1.0//EN" "../../../resources/xhtml11-target10.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><title>RollingFileAppender (Log4j Version 1.2.8)</title><script src="../../../resources/gjdoc.js" type="text/javascript"><!-- this comment required for konqueror 3.2.2 --></script><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"/><meta name="generator" content="GNU Gjdoc Standard Doclet"/><meta name="keywords" content="org.apache.log4j.RollingFileAppender class"/><meta name="keywords" content="maxFileSize"/><meta name="keywords" content="maxBackupIndex"/><meta name="keywords" content="getMaxBackupIndex()"/><meta name="keywords" content="getMaximumFileSize()"/><meta name="keywords" content="synchronization not necessary since doAppend is alreasy synched
  void rollOver()"/><meta name="keywords" content="setFile()"/><meta name="keywords" content="setMaxBackupIndex()"/><meta name="keywords" content="setMaximumFileSize()"/><meta name="keywords" content="setMaxFileSize()"/><meta name="keywords" content="setQWForFiles()"/><meta name="keywords" content="subAppend()"/><link rel="stylesheet" type="text/css" href="../../../resources/gjdochtml-clean-layout.css" title="GNU Clean"/><link rel="stylesheet" type="text/css" href="../../../resources/gjdochtml-clean-color1.css" title="GNU Clean"/></head><body class="content class" onload="if(parent.contentPageLoaded)parent.contentPageLoaded(document.title)"><table class="navbar div top"><tr><td class="navbar div top"><div class="navbar div top"><span class="navbar item enabled"><a href="../../../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item active">Class</span> <span class="navbar item enabled"><a href="RollingFileAppender-uses.html">Use</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../../../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../../../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../../../about.html">About</a></span></div></td><td class="header" rowspan="2"><b>Log4j 1.2.8</b></td></tr><tr><td class="navi"><a href="../../../org/apache/log4j/PropertyConfigurator.html">Prev Class</a> | <a href="../../../org/apache/log4j/SimpleLayout.html">Next Class</a></td><td class="navi"><a href="../../../index.html" title="Show in a frameset" target="_top">Frames</a> | <a href="RollingFileAppender.html" title="Show without frames" target="_top">No Frames</a> </td></tr><tr><td class="navi">Summary: Nested | <a href="#summary-fields">Field</a> | <a href="#summary-methods">Method</a> | <a href="#summary-constructors">Constr</a></td><td class="navi">Detail: Nested | <a href="#detail-fields">Field</a> | <a href="#detail-methods">Method</a> | <a href="#detail-constructors">Constr</a></td></tr></table><div class="class title outer"><h3 class="class title-package">org.apache.log4j</h3><h1 class="class title-class">Class RollingFileAppender</h1></div><div class="class inheritance-tree"><ul class="inheritance 0"><li class="inheritance 0"><code>java.lang.Object</code></li><li><ul class="inheritance 1"><li class="inheritance 1"><code><a href="../../../org/apache/log4j/AppenderSkeleton.html">org.apache.log4j.AppenderSkeleton</a></code></li><li><ul class="inheritance 2"><li class="inheritance 2"><code><a href="../../../org/apache/log4j/WriterAppender.html">org.apache.log4j.WriterAppender</a></code></li><li><ul class="inheritance 3"><li class="inheritance 3"><code><a href="../../../org/apache/log4j/FileAppender.html">org.apache.log4j.FileAppender</a></code></li><li><ul class="inheritance 4"><li class="inheritance 4"><code>org.apache.log4j.RollingFileAppender</code></li><li></li></ul></li></ul></li></ul></li></ul></li></ul></div><dl class="class knownimplementing"><dt class="header"><b>Implemented Interfaces:</b></dt><dd class="item"><a href="../../../org/apache/log4j/Appender.html" title="Interface in org.apache.log4j">Appender</a>, <a href="../../../org/apache/log4j/spi/OptionHandler.html" title="Interface in org.apache.log4j.spi">OptionHandler</a></dd></dl><dl class="class subclasses"><dt class="class subclasses header"><b>Known Direct Subclasses:</b></dt><dd class="class subclasses header"><a href="../../../org/apache/log4j/varia/ExternallyRolledFileAppender.html" title="Class in org.apache.log4j.varia">ExternallyRolledFileAppender</a></dd></b></dt></dl><hr/><div class="class synopsis outer"><div class="class synopsis declaration"><code>public class <b class="class synopsis name">RollingFileAppender</b></code></div><div class="class synopsis superclass"><code>extends <a href="../../../org/apache/log4j/FileAppender.html" title="Class in org.apache.log4j">FileAppender</a></code></div></div><hr/><div class="class description">RollingFileAppender extends FileAppender to backup the log files when
they reach a certain size.
</div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Authors:</b></dt><dd class="tag item">Heinz Richter</dd><dd class="tag item">Ceki G&uuml;lc&uuml;</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><a name="summary-fields" id="summary-fields"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Field Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected  int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#maxBackupIndex">maxBackupIndex</a></code></dt><dd class="description">There is one backup file by default.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected  long</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#maxFileSize">maxFileSize</a></code></dt><dd class="description">The default maximum file size is 10MB.</dd></dl></td></tr></table></dd></dl><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table sub header"><td colspan="2"><h3 class="table sub header">Fields inherited from class org.apache.log4j.<a href="../../../org/apache/log4j/FileAppender.html" title="Class in org.apache.log4j">FileAppender</a></h3></td></tr><tr><td class="inherited"><a href="../../../org/apache/log4j/FileAppender.html#bufferSize"><code class="member">bufferSize</code></a>, <a href="../../../org/apache/log4j/FileAppender.html#bufferedIO"><code class="member">bufferedIO</code></a>, <a href="../../../org/apache/log4j/FileAppender.html#fileAppend"><code class="member">fileAppend</code></a>, <a href="../../../org/apache/log4j/FileAppender.html#fileName"><code class="member">fileName</code></a></td></tr></table></dd></dl><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table sub header"><td colspan="2"><h3 class="table sub header">Fields inherited from class org.apache.log4j.<a href="../../../org/apache/log4j/WriterAppender.html" title="Class in org.apache.log4j">WriterAppender</a></h3></td></tr><tr><td class="inherited"><a href="../../../org/apache/log4j/WriterAppender.html#encoding"><code class="member">encoding</code></a>, <a href="../../../org/apache/log4j/WriterAppender.html#immediateFlush"><code class="member">immediateFlush</code></a>, <a href="../../../org/apache/log4j/WriterAppender.html#qw"><code class="member">qw</code></a></td></tr></table></dd></dl><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table sub header"><td colspan="2"><h3 class="table sub header">Fields inherited from class org.apache.log4j.<a href="../../../org/apache/log4j/AppenderSkeleton.html" title="Class in org.apache.log4j">AppenderSkeleton</a></h3></td></tr><tr><td class="inherited"><a href="../../../org/apache/log4j/AppenderSkeleton.html#closed"><code class="member">closed</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#errorHandler"><code class="member">errorHandler</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#headFilter"><code class="member">headFilter</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#layout"><code class="member">layout</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#name"><code class="member">name</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#tailFilter"><code class="member">tailFilter</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#threshold"><code class="member">threshold</code></a></td></tr></table></dd></dl><a name="summary-constructors" id="summary-constructors"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Constructor Summary</h2></td></tr><tr><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#RollingFileAppender()">RollingFileAppender</a>()</code></dt><dd class="description">The default constructor simply calls its <code>parents constructor</code>.</dd></dl></td></tr><tr><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#RollingFileAppender(org.apache.log4j.Layout,String)">RollingFileAppender</a>(<a href="../../../org/apache/log4j/Layout.html" title="Class in org.apache.log4j">Layout</a>&nbsp;layout, String&nbsp;filename)</code></dt><dd class="description">Instantiate a FileAppender and open the file designated by
<code>filename</code>.</dd></dl></td></tr><tr><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#RollingFileAppender(org.apache.log4j.Layout,String,boolean)">RollingFileAppender</a>(<a href="../../../org/apache/log4j/Layout.html" title="Class in org.apache.log4j">Layout</a>&nbsp;layout, String&nbsp;filename, boolean&nbsp;append)</code></dt><dd class="description">Instantiate a RollingFileAppender and open the file designated by
<code>filename</code>.</dd></dl></td></tr></table></dd></dl><a name="summary-methods" id="summary-methods"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Method Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis"> int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getMaxBackupIndex()">getMaxBackupIndex</a>()</code></dt><dd class="description">Returns the value of the <b>MaxBackupIndex</b> option.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> long</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getMaximumFileSize()">getMaximumFileSize</a>()</code></dt><dd class="description">Get the maximum size that the output file is allowed to reach
before being rolled over to backup files.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setFile(String,boolean,boolean,int)">setFile</a>(String&nbsp;fileName, boolean&nbsp;append, boolean&nbsp;bufferedIO, int&nbsp;bufferSize)</code></dt><dd class="description">Sets and <i>opens</i> the file where the log output will
go.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setMaxBackupIndex(int)">setMaxBackupIndex</a>(int&nbsp;maxBackups)</code></dt><dd class="description">Set the maximum number of backup files to keep around.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setMaxFileSize(String)">setMaxFileSize</a>(String&nbsp;value)</code></dt><dd class="description">Set the maximum size that the output file is allowed to reach
before being rolled over to backup files.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setMaximumFileSize(long)">setMaximumFileSize</a>(long&nbsp;maxFileSize)</code></dt><dd class="description">Set the maximum size that the output file is allowed to reach
before being rolled over to backup files.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected  void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setQWForFiles(Writer)">setQWForFiles</a>(Writer&nbsp;writer)</code></dt><dd class="description">Sets the quiet writer being used.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected  void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#subAppend(org.apache.log4j.spi.LoggingEvent)">subAppend</a>(<a href="../../../org/apache/log4j/spi/LoggingEvent.html" title="Class in org.apache.log4j.spi">LoggingEvent</a>&nbsp;event)</code></dt><dd class="description">This method differentiates RollingFileAppender from its super
class.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> //</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#synchronization not necessary since doAppend is alreasy synched
  void rollOver()">synchronization not necessary since doAppend is alreasy synched
  void rollOver</a>()</code></dt><dd class="description">Implements the usual roll over behaviour.</dd></dl></td></tr></table></dd></dl><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table sub header"><td colspan="2"><h3 class="table sub header">Methods inherited from class org.apache.log4j.<a href="../../../org/apache/log4j/FileAppender.html" title="Class in org.apache.log4j">FileAppender</a></h3></td></tr><tr><td class="inherited"><a href="../../../org/apache/log4j/FileAppender.html#activateOptions()" title="activateOptions()"><code class="member">activateOptions</code></a>, <a href="../../../org/apache/log4j/FileAppender.html#closeFile()" title="closeFile()"><code class="member">closeFile</code></a>, <a href="../../../org/apache/log4j/FileAppender.html#getAppend()" title="getAppend()"><code class="member">getAppend</code></a>, <a href="../../../org/apache/log4j/FileAppender.html#getBufferSize()" title="getBufferSize()"><code class="member">getBufferSize</code></a>, <a href="../../../org/apache/log4j/FileAppender.html#getBufferedIO()" title="getBufferedIO()"><code class="member">getBufferedIO</code></a>, <a href="../../../org/apache/log4j/FileAppender.html#getFile()" title="getFile()"><code class="member">getFile</code></a>, <a href="../../../org/apache/log4j/FileAppender.html#reset()" title="reset()"><code class="member">reset</code></a>, <a href="../../../org/apache/log4j/FileAppender.html#setAppend(boolean)" title="setAppend(boolean)"><code class="member">setAppend</code></a>, <a href="../../../org/apache/log4j/FileAppender.html#setBufferSize(int)" title="setBufferSize(int)"><code class="member">setBufferSize</code></a>, <a href="../../../org/apache/log4j/FileAppender.html#setBufferedIO(boolean)" title="setBufferedIO(boolean)"><code class="member">setBufferedIO</code></a>, <a href="../../../org/apache/log4j/FileAppender.html#setFile(String)" title="setFile(String)"><code class="member">setFile</code></a>, <a href="../../../org/apache/log4j/FileAppender.html#setFile(String,boolean,boolean,int)" title="setFile(String,boolean,boolean,int)"><code class="member">setFile</code></a>, <a href="../../../org/apache/log4j/FileAppender.html#setQWForFiles(Writer)" title="setQWForFiles(Writer)"><code class="member">setQWForFiles</code></a></td></tr></table></dd></dl><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table sub header"><td colspan="2"><h3 class="table sub header">Methods inherited from class org.apache.log4j.<a href="../../../org/apache/log4j/WriterAppender.html" title="Class in org.apache.log4j">WriterAppender</a></h3></td></tr><tr><td class="inherited"><a href="../../../org/apache/log4j/WriterAppender.html#activateOptions()" title="activateOptions()"><code class="member">activateOptions</code></a>, <a href="../../../org/apache/log4j/WriterAppender.html#append(org.apache.log4j.spi.LoggingEvent)" title="append(LoggingEvent)"><code class="member">append</code></a>, <a href="../../../org/apache/log4j/WriterAppender.html#checkEntryConditions()" title="checkEntryConditions()"><code class="member">checkEntryConditions</code></a>, <a href="../../../org/apache/log4j/WriterAppender.html#close()" title="close()"><code class="member">close</code></a>, <a href="../../../org/apache/log4j/WriterAppender.html#closeWriter()" title="closeWriter()"><code class="member">closeWriter</code></a>, <a href="../../../org/apache/log4j/WriterAppender.html#createWriter(OutputStream)" title="createWriter(OutputStream)"><code class="member">createWriter</code></a>, <a href="../../../org/apache/log4j/WriterAppender.html#getEncoding()" title="getEncoding()"><code class="member">getEncoding</code></a>, <a href="../../../org/apache/log4j/WriterAppender.html#getImmediateFlush()" title="getImmediateFlush()"><code class="member">getImmediateFlush</code></a>, <a href="../../../org/apache/log4j/WriterAppender.html#requiresLayout()" title="requiresLayout()"><code class="member">requiresLayout</code></a>, <a href="../../../org/apache/log4j/WriterAppender.html#reset()" title="reset()"><code class="member">reset</code></a>, <a href="../../../org/apache/log4j/WriterAppender.html#setEncoding(String)" title="setEncoding(String)"><code class="member">setEncoding</code></a>, <a href="../../../org/apache/log4j/WriterAppender.html#setErrorHandler(org.apache.log4j.spi.ErrorHandler)" title="setErrorHandler(ErrorHandler)"><code class="member">setErrorHandler</code></a>, <a href="../../../org/apache/log4j/WriterAppender.html#setImmediateFlush(boolean)" title="setImmediateFlush(boolean)"><code class="member">setImmediateFlush</code></a>, <a href="../../../org/apache/log4j/WriterAppender.html#setWriter(Writer)" title="setWriter(Writer)"><code class="member">setWriter</code></a>, <a href="../../../org/apache/log4j/WriterAppender.html#subAppend(org.apache.log4j.spi.LoggingEvent)" title="subAppend(LoggingEvent)"><code class="member">subAppend</code></a>, <a href="../../../org/apache/log4j/WriterAppender.html#writeFooter()" title="writeFooter()"><code class="member">writeFooter</code></a>, <a href="../../../org/apache/log4j/WriterAppender.html#writeHeader()" title="writeHeader()"><code class="member">writeHeader</code></a></td></tr></table></dd></dl><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table sub header"><td colspan="2"><h3 class="table sub header">Methods inherited from class org.apache.log4j.<a href="../../../org/apache/log4j/AppenderSkeleton.html" title="Class in org.apache.log4j">AppenderSkeleton</a></h3></td></tr><tr><td class="inherited"><a href="../../../org/apache/log4j/AppenderSkeleton.html#activateOptions()" title="activateOptions()"><code class="member">activateOptions</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#addFilter(org.apache.log4j.spi.Filter)" title="addFilter(Filter)"><code class="member">addFilter</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#append(org.apache.log4j.spi.LoggingEvent)" title="append(LoggingEvent)"><code class="member">append</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#clearFilters()" title="clearFilters()"><code class="member">clearFilters</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#doAppend(org.apache.log4j.spi.LoggingEvent)" title="doAppend(LoggingEvent)"><code class="member">doAppend</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#finalize()" title="finalize()"><code class="member">finalize</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#getErrorHandler()" title="getErrorHandler()"><code class="member">getErrorHandler</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#getFilter()" title="getFilter()"><code class="member">getFilter</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#getFirstFilter()" title="getFirstFilter()"><code class="member">getFirstFilter</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#getLayout()" title="getLayout()"><code class="member">getLayout</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#getName()" title="getName()"><code class="member">getName</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#getThreshold()" title="getThreshold()"><code class="member">getThreshold</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#isAsSevereAsThreshold(org.apache.log4j.Priority)" title="isAsSevereAsThreshold(Priority)"><code class="member">isAsSevereAsThreshold</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#setErrorHandler(org.apache.log4j.spi.ErrorHandler)" title="setErrorHandler(ErrorHandler)"><code class="member">setErrorHandler</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#setLayout(org.apache.log4j.Layout)" title="setLayout(Layout)"><code class="member">setLayout</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#setName(String)" title="setName(String)"><code class="member">setName</code></a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#setThreshold(org.apache.log4j.Priority)" title="setThreshold(Priority)"><code class="member">setThreshold</code></a></td></tr></table></dd></dl><a name="detail-fields" id="detail-fields"/><h2 class="section header">Field Details</h2><div class="section"><a name="maxBackupIndex" id="maxBackupIndex"/><div class="member detail outer"><h3 class="member detail name">maxBackupIndex</h3><pre class="member detail synopsis">protected int maxBackupIndex</pre><blockquote class="member detail name"><div class="member detail description">There is one backup file by default.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="maxFileSize" id="maxFileSize"/><div class="member detail outer"><h3 class="member detail name">maxFileSize</h3><pre class="member detail synopsis">protected long maxFileSize</pre><blockquote class="member detail name"><div class="member detail description">The default maximum file size is 10MB.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><a name="detail-constructors" id="detail-constructors"/><h2 class="section header">Constructor Details</h2><div class="section"><a name="RollingFileAppender()" id="RollingFileAppender()"/><div class="member detail outer"><h3 class="member detail name">RollingFileAppender</h3><pre class="member detail synopsis">public RollingFileAppender()</pre><blockquote class="member detail name"><div class="member detail description">The default constructor simply calls its <code>parents constructor</code>.  </div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="RollingFileAppender(org.apache.log4j.Layout,String)" id="RollingFileAppender(org.apache.log4j.Layout,String)"/><div class="member detail outer"><h3 class="member detail name">RollingFileAppender</h3><pre class="member detail synopsis">public RollingFileAppender(<a href="../../../org/apache/log4j/Layout.html" title="Class in org.apache.log4j">Layout</a> layout,
                           String filename)
            throws IOException</pre><blockquote class="member detail name"><div class="member detail description">Instantiate a FileAppender and open the file designated by
<code>filename</code>. The opened filename will become the output
destination for this appender.
<p/>The file will be appended to.  </div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="RollingFileAppender(org.apache.log4j.Layout,String,boolean)" id="RollingFileAppender(org.apache.log4j.Layout,String,boolean)"/><div class="member detail outer"><h3 class="member detail name">RollingFileAppender</h3><pre class="member detail synopsis">public RollingFileAppender(<a href="../../../org/apache/log4j/Layout.html" title="Class in org.apache.log4j">Layout</a> layout,
                           String filename,
                           boolean append)
            throws IOException</pre><blockquote class="member detail name"><div class="member detail description">Instantiate a RollingFileAppender and open the file designated by
<code>filename</code>. The opened filename will become the ouput
destination for this appender.
<p/>If the <code>append</code> parameter is true, the file will be
appended to. Otherwise, the file desginated by
<code>filename</code> will be truncated before being opened.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><a name="detail-methods" id="detail-methods"/><h2 class="section header">Method Details</h2><div class="section"><a name="getMaxBackupIndex()" id="getMaxBackupIndex()"/><div class="member detail outer"><h3 class="member detail name">getMaxBackupIndex</h3><pre class="member detail synopsis">public int getMaxBackupIndex()</pre><blockquote class="member detail name"><div class="member detail description">Returns the value of the <b>MaxBackupIndex</b> option.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getMaximumFileSize()" id="getMaximumFileSize()"/><div class="member detail outer"><h3 class="member detail name">getMaximumFileSize</h3><pre class="member detail synopsis">public long getMaximumFileSize()</pre><blockquote class="member detail name"><div class="member detail description">Get the maximum size that the output file is allowed to reach
before being rolled over to backup files.
</div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Since:</b></dt><dd>1.1</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setFile(String,boolean,boolean,int)" id="setFile(String,boolean,boolean,int)"/><div class="member detail outer"><h3 class="member detail name">setFile</h3><pre class="member detail synopsis">public void setFile(String fileName,
                    boolean append,
                    boolean bufferedIO,
                    int bufferSize)
            throws IOException</pre><blockquote class="member detail name"><div class="member detail description">Sets and <i>opens</i> the file where the log output will
go. The specified file must be writable.
<p/>If there was already an opened file, then the previous file
is closed first.
<p/><b>Do not use this method directly. To configure a FileAppender
or one of its subclasses, set its properties one by one and then
call activateOptions.</b>
</div><dl class="member detail overridden list"><dt class="member detail overridden header"><b>Overrides:</b></dt><dd class="member detail overridden item"><a href="../../../org/apache/log4j/FileAppender.html#setFile(String,boolean,boolean,int)">setFile</a> in interface <a href="../../../org/apache/log4j/FileAppender.html" title="Class in org.apache.log4j">FileAppender</a></dd></dl><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">fileName</code><span class="separator"> - </span><span class="description">The path to the log file.</span></dd><dd class="item"><code class="name">append</code><span class="separator"> - </span><span class="description">If true will append to fileName. Otherwise will
truncate fileName.</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setMaxBackupIndex(int)" id="setMaxBackupIndex(int)"/><div class="member detail outer"><h3 class="member detail name">setMaxBackupIndex</h3><pre class="member detail synopsis">public void setMaxBackupIndex(int maxBackups)</pre><blockquote class="member detail name"><div class="member detail description">Set the maximum number of backup files to keep around.
<p/>The <b>MaxBackupIndex</b> option determines how many backup
files are kept before the oldest is erased. This option takes
a positive integer value. If set to zero, then there will be no
backup files and the log file will be truncated when it reaches
<code>MaxFileSize</code>.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setMaxFileSize(String)" id="setMaxFileSize(String)"/><div class="member detail outer"><h3 class="member detail name">setMaxFileSize</h3><pre class="member detail synopsis">public void setMaxFileSize(String value)</pre><blockquote class="member detail name"><div class="member detail description">Set the maximum size that the output file is allowed to reach
before being rolled over to backup files.
<p/>In configuration files, the <b>MaxFileSize</b> option takes an
long integer in the range 0 - 2^63. You can specify the value
with the suffixes "KB", "MB" or "GB" so that the integer is
interpreted being expressed respectively in kilobytes, megabytes
or gigabytes. For example, the value "10KB" will be interpreted
as 10240.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setMaximumFileSize(long)" id="setMaximumFileSize(long)"/><div class="member detail outer"><h3 class="member detail name">setMaximumFileSize</h3><pre class="member detail synopsis">public void setMaximumFileSize(long maxFileSize)</pre><blockquote class="member detail name"><div class="member detail description">Set the maximum size that the output file is allowed to reach
before being rolled over to backup files.
<p/>This method is equivalent to <a href="../../../org/apache/log4j/RollingFileAppender.html#setMaxFileSize(String)"><code>setMaxFileSize(String)</code></a> except
that it is required for differentiating the setter taking a
<code>long</code> argument from the setter taking a
<code>String</code> argument by the JavaBeans <code>Introspector</code>.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>See Also:</b></dt><dd><a href="../../../org/apache/log4j/RollingFileAppender.html#setMaxFileSize(String)"><code>setMaxFileSize(String)</code></a></dd></dl></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setQWForFiles(Writer)" id="setQWForFiles(Writer)"/><div class="member detail outer"><h3 class="member detail name">setQWForFiles</h3><pre class="member detail synopsis">protected void setQWForFiles(Writer writer)</pre><blockquote class="member detail name"><div class="member detail description">Sets the quiet writer being used.
This method is overriden by <a href="../../../org/apache/log4j/RollingFileAppender.html"><code>RollingFileAppender</code></a>.
</div><dl class="member detail overridden list"><dt class="member detail overridden header"><b>Overrides:</b></dt><dd class="member detail overridden item"><a href="../../../org/apache/log4j/FileAppender.html#setQWForFiles(Writer)">setQWForFiles</a> in interface <a href="../../../org/apache/log4j/FileAppender.html" title="Class in org.apache.log4j">FileAppender</a></dd></dl><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="subAppend(org.apache.log4j.spi.LoggingEvent)" id="subAppend(org.apache.log4j.spi.LoggingEvent)"/><div class="member detail outer"><h3 class="member detail name">subAppend</h3><pre class="member detail synopsis">protected void subAppend(<a href="../../../org/apache/log4j/spi/LoggingEvent.html" title="Class in org.apache.log4j.spi">LoggingEvent</a> event)</pre><blockquote class="member detail name"><div class="member detail description">This method differentiates RollingFileAppender from its super
class.
</div><dl class="member detail overridden list"><dt class="member detail overridden header"><b>Overrides:</b></dt><dd class="member detail overridden item"><a href="../../../org/apache/log4j/WriterAppender.html#subAppend(org.apache.log4j.spi.LoggingEvent)">subAppend</a> in interface <a href="../../../org/apache/log4j/WriterAppender.html" title="Class in org.apache.log4j">WriterAppender</a></dd></dl><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Since:</b></dt><dd>0.9.0</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="synchronization not necessary since doAppend is alreasy synched
  void rollOver()" id="synchronization not necessary since doAppend is alreasy synched
  void rollOver()"/><div class="member detail outer"><h3 class="member detail name">synchronization not necessary since doAppend is alreasy synched
  void rollOver</h3><pre class="member detail synopsis">public // synchronization not necessary since doAppend is alreasy synched
  void rollOver()</pre><blockquote class="member detail name"><div class="member detail description">Implements the usual roll over behaviour.
<p/>If <code>MaxBackupIndex</code> is positive, then files
{<code>File.1</code>, ..., <code>File.MaxBackupIndex -1</code>}
are renamed to {<code>File.2</code>, ...,
<code>File.MaxBackupIndex</code>}. Moreover, <code>File</code> is
renamed <code>File.1</code> and closed. A new <code>File</code> is
created to receive further log output.
<p/>If <code>MaxBackupIndex</code> is equal to zero, then the
<code>File</code> is truncated with no backup files created.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><p class="navbar bottom spacer"> </p><table class="navbar div bottom"><tr><td><div class="navbar div top"><span class="navbar item enabled"><a href="../../../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item active">Class</span> <span class="navbar item enabled"><a href="RollingFileAppender-uses.html">Use</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../../../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../../../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../../../about.html">About</a></span></div></td></tr></table><hr/>Copyright 2000-2002 Apache Software Foundation.</body></html>

Anon7 - 2021