testdevapidocs/org/apache/log4j/FileAppender.html - hbase-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>FileAppender (Apache HBase 4.0.0-alpha-1-SNAPSHOT Test API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="declaration: package: org.apache.log4j, class: FileAppender">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 <script type="text/javascript" src="../../../script-dir/jquery-3.6.1.min.js"></script>
 <script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var evenRowColor = "even-row-color";
 var oddRowColor = "odd-row-color";
 var tableTab = "table-tab";
 var activeTableTab = "active-table-tab";
 var pathtoroot = "../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flex-box">
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar-top">
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
 <li><a href="../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="class-use/FileAppender.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../index-all.html">Index</a></li>
 <li><a href="../../../help-doc.html#class">Help</a></li>
 </ul>
 </div>
 <div class="sub-nav">
 <div>
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
 <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </div>
 <div class="nav-list-search"><label for="search-input">SEARCH:</label>
 <input type="text" id="search-input" value="search" disabled="disabled">
 <input type="reset" id="reset-button" value="reset" disabled="disabled">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip-navbar-top"></span></nav>
 </header>
 <div class="flex-content">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.log4j</a></div>
 <h1 title="Class FileAppender" class="title">Class FileAppender</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
 <div class="inheritance">org.apache.log4j.AppenderSkeleton
 <div class="inheritance">org.apache.log4j.WriterAppender
 <div class="inheritance">org.apache.log4j.FileAppender</div>
 </div>
 </div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code>org.apache.log4j.Appender</code>, <code>org.apache.log4j.spi.OptionHandler</code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-33">FileAppender</a></span>
 <span class="extends-implements">extends org.apache.log4j.WriterAppender</span></div>
 <div class="block">Just a copy of the old log4j12 FileAppender. The ContainerLogAppender for YARN NodeManager needs
  this class but the log4j-1.2-api bridge does not provide it which causes the UTs in
  hbase-mapreduce module to fail if we start a separated MR cluster.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ======== NESTED CLASS SUMMARY ======== -->
 <li>
 <section class="nested-class-summary" id="nested-class-summary">
 <h2>Nested Class Summary</h2>
 <div class="inherited-list">
 <h2 id="nested-classes-inherited-from-class-org.apache.log4j.AppenderSkeleton">Nested classes/interfaces inherited from class&nbsp;org.apache.log4j.AppenderSkeleton</h2>
 <code>org.apache.log4j.AppenderSkeleton.NoOpErrorHandler</code></div>
 </section>
 </li>
 <!-- =========== FIELD SUMMARY =========== -->
 <li>
 <section class="field-summary" id="field-summary">
 <h2>Field Summary</h2>
 <div class="caption"><span>Fields</span></div>
 <div class="summary-table three-column-summary">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Field</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>protected boolean</code></div>
 <div class="col-second even-row-color"><code><a href="#bufferedIO" class="member-name-link">bufferedIO</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">Do we do bufferedIO?</div>
 </div>
 <div class="col-first odd-row-color"><code>protected int</code></div>
 <div class="col-second odd-row-color"><code><a href="#bufferSize" class="member-name-link">bufferSize</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">Determines the size of IO buffer be.</div>
 </div>
 <div class="col-first even-row-color"><code>protected boolean</code></div>
 <div class="col-second even-row-color"><code><a href="#fileAppend" class="member-name-link">fileAppend</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">Controls file truncatation.</div>
 </div>
 <div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second odd-row-color"><code><a href="#fileName" class="member-name-link">fileName</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">The name of the log file.</div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="fields-inherited-from-class-org.apache.log4j.WriterAppender">Fields inherited from class&nbsp;org.apache.log4j.WriterAppender</h3>
 <code>encoding, immediateFlush, qw</code></div>
 <div class="inherited-list">
 <h3 id="fields-inherited-from-class-org.apache.log4j.AppenderSkeleton">Fields inherited from class&nbsp;org.apache.log4j.AppenderSkeleton</h3>
 <code>closed, errorHandler, headFilter, layout, name, tailFilter, threshold</code></div>
 </section>
 </li>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li>
 <section class="constructor-summary" id="constructor-summary">
 <h2>Constructor Summary</h2>
 <div class="caption"><span>Constructors</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">FileAppender</a>()</code></div>
 <div class="col-last even-row-color">
 <div class="block">The default constructor does not do anything.</div>
 </div>
 <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.log4j.Layout,java.lang.String)" class="member-name-link">FileAppender</a><wbr>(org.apache.log4j.Layout&nbsp;layout,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fileName)</code></div>
 <div class="col-last odd-row-color">
 <div class="block">Instantiate a FileAppender and open the file designated by <code>filename</code>.</div>
 </div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.log4j.Layout,java.lang.String,boolean)" class="member-name-link">FileAppender</a><wbr>(org.apache.log4j.Layout&nbsp;layout,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fileName,
  boolean&nbsp;append)</code></div>
 <div class="col-last even-row-color">
 <div class="block">Instantiate a FileAppender and open the file designated by <code>fileName</code>.</div>
 </div>
 <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.log4j.Layout,java.lang.String,boolean,boolean,int)" class="member-name-link">FileAppender</a><wbr>(org.apache.log4j.Layout&nbsp;layout,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fileName,
  boolean&nbsp;append,
  boolean&nbsp;bufferedIO,
  int&nbsp;bufferSize)</code></div>
 <div class="col-last odd-row-color">
 <div class="block">Instantiate a <code>FileAppender</code> and open the file designated by <code>fileName</code>.</div>
 </div>
 </div>
 </section>
 </li>
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#activateOptions()" class="member-name-link">activateOptions</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">If the value of <b>File</b> is not <code>null</code>, then <a href="#setFile(java.lang.String)"><code>setFile(java.lang.String)</code></a> is called with the
  values of <b>File</b> and <b>Append</b> properties.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#closeFile()" class="member-name-link">closeFile</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Closes the previously opened file.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAppend()" class="member-name-link">getAppend</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns the value of the <b>Append</b> option.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBufferedIO()" class="member-name-link">getBufferedIO</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Get the value of the <b>BufferedIO</b> option.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBufferSize()" class="member-name-link">getBufferSize</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Get the size of the IO buffer.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFile()" class="member-name-link">getFile</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns the value of the <b>File</b> option.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Close any previously opened file and call the parent's <code>reset</code>.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAppend(boolean)" class="member-name-link">setAppend</a><wbr>(boolean&nbsp;flag)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">The <b>Append</b> option takes a boolean value.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setBufferedIO(boolean)" class="member-name-link">setBufferedIO</a><wbr>(boolean&nbsp;bufferedIO)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">The <b>BufferedIO</b> option takes a boolean value.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setBufferSize(int)" class="member-name-link">setBufferSize</a><wbr>(int&nbsp;bufferSize)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Set the size of the IO buffer.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFile(java.lang.String)" class="member-name-link">setFile</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;file)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">The <b>File</b> property takes a string value which should be the name of the file to append
  to.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFile(java.lang.String,boolean,boolean,int)" class="member-name-link">setFile</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fileName,
  boolean&nbsp;append,
  boolean&nbsp;bufferedIO,
  int&nbsp;bufferSize)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">
  Sets and <i>opens</i> the file where the log output will go.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setQWForFiles(java.io.Writer)" class="member-name-link">setQWForFiles</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Writer.html" title="class or interface in java.io" class="external-link">Writer</a>&nbsp;writer)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the quiet writer being used.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.log4j.WriterAppender">Methods inherited from class&nbsp;org.apache.log4j.WriterAppender</h3>
 <code>append, checkEntryConditions, close, closeWriter, createWriter, getEncoding, getImmediateFlush, requiresLayout, setEncoding, setErrorHandler, setImmediateFlush, setWriter, shouldFlush, subAppend, writeFooter, writeHeader</code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.log4j.AppenderSkeleton">Methods inherited from class&nbsp;org.apache.log4j.AppenderSkeleton</h3>
 <code>addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setLayout, setName, setThreshold</code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ============ FIELD DETAIL =========== -->
 <li>
 <section class="field-details" id="field-detail">
 <h2>Field Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="fileAppend">
 <h3>fileAppend</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-42">fileAppend</a></span></div>
 <div class="block">Controls file truncatation. The default value for this variable is <code>true</code>, meaning
  that by default a <code>FileAppender</code> will append to an existing file and not truncate
  it.
  <p>
  This option is meaningful only if the FileAppender opens the file.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="fileName">
 <h3>fileName</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-47">fileName</a></span></div>
 <div class="block">The name of the log file.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="bufferedIO">
 <h3>bufferedIO</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-52">bufferedIO</a></span></div>
 <div class="block">Do we do bufferedIO?</div>
 </section>
 </li>
 <li>
 <section class="detail" id="bufferSize">
 <h3>bufferSize</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-57">bufferSize</a></span></div>
 <div class="block">Determines the size of IO buffer be. Default is 8K.</div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <li>
 <section class="constructor-details" id="constructor-detail">
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="&lt;init&gt;()">
 <h3>FileAppender</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-62">FileAppender</a></span>()</div>
 <div class="block">The default constructor does not do anything.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="&lt;init&gt;(org.apache.log4j.Layout,java.lang.String,boolean,boolean,int)">
 <h3>FileAppender</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-75">FileAppender</a></span><wbr><span class="parameters">(org.apache.log4j.Layout&nbsp;layout,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fileName,
  boolean&nbsp;append,
  boolean&nbsp;bufferedIO,
  int&nbsp;bufferSize)</span>
              throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
 <div class="block">Instantiate a <code>FileAppender</code> and open the file designated by <code>fileName</code>.
  The opened filename will become the output destination for this appender.
  <p>
  If the <code>append</code> parameter is true, the file will be appended to. Otherwise, the file
  designated by <code>fileName</code> will be truncated before being opened.
  <p>
  If the <code>bufferedIO</code> parameter is <code>true</code>, then buffered IO will be used to
  write to the output file.</div>
 <dl class="notes">
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="&lt;init&gt;(org.apache.log4j.Layout,java.lang.String,boolean)">
 <h3>FileAppender</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-88">FileAppender</a></span><wbr><span class="parameters">(org.apache.log4j.Layout&nbsp;layout,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fileName,
  boolean&nbsp;append)</span>
              throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
 <div class="block">Instantiate a FileAppender and open the file designated by <code>fileName</code>. The opened
  filename will become the output destination for this appender.
  <p>
  If the <code>append</code> parameter is true, the file will be appended to. Otherwise, the file
  designated by <code>fileName</code> will be truncated before being opened.</div>
 <dl class="notes">
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="&lt;init&gt;(org.apache.log4j.Layout,java.lang.String)">
 <h3>FileAppender</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-99">FileAppender</a></span><wbr><span class="parameters">(org.apache.log4j.Layout&nbsp;layout,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fileName)</span>
              throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
 <div class="block">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>
 <dl class="notes">
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="setFile(java.lang.String)">
 <h3>setFile</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-113">setFile</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;file)</span></div>
 <div class="block">The <b>File</b> property takes a string value which should be the name of the file to append
  to.
  <p>
  <font color="#DD0044"><b>Note that the special values "System.out" or "System.err" are no
  longer honored.</b></font>
  <p>
  Note: Actual opening of the file is made when <a href="#activateOptions()"><code>activateOptions()</code></a> is called, not when the
  options are set.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getAppend()">
 <h3>getAppend</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-123">getAppend</a></span>()</div>
 <div class="block">Returns the value of the <b>Append</b> option.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getFile()">
 <h3>getFile</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-128">getFile</a></span>()</div>
 <div class="block">Returns the value of the <b>File</b> option.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="activateOptions()">
 <h3>activateOptions</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-137">activateOptions</a></span>()</div>
 <div class="block">If the value of <b>File</b> is not <code>null</code>, then <a href="#setFile(java.lang.String)"><code>setFile(java.lang.String)</code></a> is called with the
  values of <b>File</b> and <b>Append</b> properties.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code>activateOptions</code>&nbsp;in interface&nbsp;<code>org.apache.log4j.spi.OptionHandler</code></dd>
 <dt>Overrides:</dt>
 <dd><code>activateOptions</code>&nbsp;in class&nbsp;<code>org.apache.log4j.WriterAppender</code></dd>
 <dt>Since:</dt>
 <dd>0.8.1</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="closeFile()">
 <h3>closeFile</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-152">closeFile</a></span>()</div>
 <div class="block">Closes the previously opened file.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getBufferedIO()">
 <h3>getBufferedIO</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-171">getBufferedIO</a></span>()</div>
 <div class="block">Get the value of the <b>BufferedIO</b> option.
  <p>
  BufferedIO will significatnly increase performance on heavily loaded systems.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getBufferSize()">
 <h3>getBufferSize</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-178">getBufferSize</a></span>()</div>
 <div class="block">Get the size of the IO buffer.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="setAppend(boolean)">
 <h3>setAppend</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-190">setAppend</a></span><wbr><span class="parameters">(boolean&nbsp;flag)</span></div>
 <div class="block">The <b>Append</b> option takes a boolean value. It is set to <code>true</code> by default. If
  true, then <code>File</code> will be opened in append mode by <a href="#setFile(java.lang.String)"><code>setFile</code></a> (see
  above). Otherwise, <a href="#setFile(java.lang.String)"><code>setFile</code></a> will open <code>File</code> in truncate mode.
  <p>
  Note: Actual opening of the file is made when <a href="#activateOptions()"><code>activateOptions()</code></a> is called, not when the
  options are set.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="setBufferedIO(boolean)">
 <h3>setBufferedIO</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-200">setBufferedIO</a></span><wbr><span class="parameters">(boolean&nbsp;bufferedIO)</span></div>
 <div class="block">The <b>BufferedIO</b> option takes a boolean value. It is set to <code>false</code> by default.
  If true, then <code>File</code> will be opened and the resulting <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Writer.html" title="class or interface in java.io" class="external-link"><code>Writer</code></a> wrapped
  around a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/BufferedWriter.html" title="class or interface in java.io" class="external-link"><code>BufferedWriter</code></a>. BufferedIO will significatnly increase performance on heavily
  loaded systems.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="setBufferSize(int)">
 <h3>setBufferSize</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-210">setBufferSize</a></span><wbr><span class="parameters">(int&nbsp;bufferSize)</span></div>
 <div class="block">Set the size of the IO buffer.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="setFile(java.lang.String,boolean,boolean,int)">
 <h3>setFile</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-226">setFile</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fileName,
  boolean&nbsp;append,
  boolean&nbsp;bufferedIO,
  int&nbsp;bufferSize)</span>
              throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
 <div class="block"><p>
  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="notes">
 <dt>Parameters:</dt>
 <dd><code>fileName</code> - The path to the log file.</dd>
 <dd><code>append</code> - If true will append to fileName. Otherwise will truncate fileName.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setQWForFiles(java.io.Writer)">
 <h3>setQWForFiles</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-274">setQWForFiles</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Writer.html" title="class or interface in java.io" class="external-link">Writer</a>&nbsp;writer)</span></div>
 <div class="block">Sets the quiet writer being used. This method is overriden by <code>RollingFileAppender</code>.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="reset()">
 <h3>reset</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../src-html/org/apache/log4j/FileAppender.html#line-281">reset</a></span>()</div>
 <div class="block">Close any previously opened file and call the parent's <code>reset</code>.</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code>reset</code>&nbsp;in class&nbsp;<code>org.apache.log4j.WriterAppender</code></dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &#169; 2007&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>