/usr/share/doc/liblog4j1.2-java/api/org/apache/log4j/FileAppender.html is in liblog4j1.2-java-doc 1.2.17-8.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>FileAppender (Log4j Version 1.2.17)</title>
<meta name="date" content="2017-10-21">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FileAppender (Log4j Version 1.2.17)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Log4j 1.2.17</b><!-- 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. --></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/apache/log4j/EnhancedThrowableRenderer.html" title="class in org.apache.log4j"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/apache/log4j/Hierarchy.html" title="class in org.apache.log4j"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/log4j/FileAppender.html" target="_top">Frames</a></li>
<li><a href="FileAppender.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.log4j</div>
<h2 title="Class FileAppender" class="title">Class FileAppender</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../org/apache/log4j/AppenderSkeleton.html" title="class in org.apache.log4j">org.apache.log4j.AppenderSkeleton</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../org/apache/log4j/WriterAppender.html" title="class in org.apache.log4j">org.apache.log4j.WriterAppender</a></li>
<li>
<ul class="inheritance">
<li>org.apache.log4j.FileAppender</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><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>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../org/apache/log4j/DailyRollingFileAppender.html" title="class in org.apache.log4j">DailyRollingFileAppender</a>, <a href="../../../org/apache/log4j/RollingFileAppender.html" title="class in org.apache.log4j">RollingFileAppender</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">FileAppender</span>
extends <a href="../../../org/apache/log4j/WriterAppender.html" title="class in org.apache.log4j">WriterAppender</a></pre>
<div class="block">FileAppender appends log events to a file.
<p>Support for <code>java.io.Writer</code> and console appending
has been deprecated and then removed. See the replacement
solutions: <a href="../../../org/apache/log4j/WriterAppender.html" title="class in org.apache.log4j"><code>WriterAppender</code></a> and <a href="../../../org/apache/log4j/ConsoleAppender.html" title="class in org.apache.log4j"><code>ConsoleAppender</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Ceki Gülcü</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#bufferedIO">bufferedIO</a></span></code>
<div class="block">Do we do bufferedIO?</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#bufferSize">bufferSize</a></span></code>
<div class="block">Determines the size of IO buffer be.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#fileAppend">fileAppend</a></span></code>
<div class="block">Controls file truncatation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#fileName">fileName</a></span></code>
<div class="block">The name of the log file.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.log4j.WriterAppender">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.log4j.<a href="../../../org/apache/log4j/WriterAppender.html" title="class in org.apache.log4j">WriterAppender</a></h3>
<code><a href="../../../org/apache/log4j/WriterAppender.html#encoding">encoding</a>, <a href="../../../org/apache/log4j/WriterAppender.html#immediateFlush">immediateFlush</a>, <a href="../../../org/apache/log4j/WriterAppender.html#qw">qw</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.log4j.AppenderSkeleton">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.log4j.<a href="../../../org/apache/log4j/AppenderSkeleton.html" title="class in org.apache.log4j">AppenderSkeleton</a></h3>
<code><a href="../../../org/apache/log4j/AppenderSkeleton.html#closed">closed</a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#errorHandler">errorHandler</a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#headFilter">headFilter</a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#layout">layout</a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#name">name</a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#tailFilter">tailFilter</a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#threshold">threshold</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#FileAppender--">FileAppender</a></span>()</code>
<div class="block">The default constructor does not do anything.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#FileAppender-org.apache.log4j.Layout-java.lang.String-">FileAppender</a></span>(<a href="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">Layout</a> layout,
java.lang.String filename)</code>
<div class="block">Instantiate a FileAppender and open the file designated by
<code>filename</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#FileAppender-org.apache.log4j.Layout-java.lang.String-boolean-">FileAppender</a></span>(<a href="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">Layout</a> layout,
java.lang.String filename,
boolean append)</code>
<div class="block">Instantiate a FileAppender and open the file designated by
<code>filename</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#FileAppender-org.apache.log4j.Layout-java.lang.String-boolean-boolean-int-">FileAppender</a></span>(<a href="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">Layout</a> layout,
java.lang.String filename,
boolean append,
boolean bufferedIO,
int bufferSize)</code>
<div class="block">Instantiate a <code>FileAppender</code> and open the file
designated by <code>filename</code>.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#activateOptions--">activateOptions</a></span>()</code>
<div class="block">If the value of <b>File</b> is not <code>null</code>, then <a href="../../../org/apache/log4j/FileAppender.html#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>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#closeFile--">closeFile</a></span>()</code>
<div class="block">Closes the previously opened file.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#getAppend--">getAppend</a></span>()</code>
<div class="block">Returns the value of the <b>Append</b> option.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#getBufferedIO--">getBufferedIO</a></span>()</code>
<div class="block">Get the value of the <b>BufferedIO</b> option.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#getBufferSize--">getBufferSize</a></span>()</code>
<div class="block">Get the size of the IO buffer.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#getFile--">getFile</a></span>()</code>
<div class="block">Returns the value of the <b>File</b> option.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#reset--">reset</a></span>()</code>
<div class="block">Close any previously opened file and call the parent's
<code>reset</code>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#setAppend-boolean-">setAppend</a></span>(boolean flag)</code>
<div class="block">The <b>Append</b> option takes a boolean value.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#setBufferedIO-boolean-">setBufferedIO</a></span>(boolean bufferedIO)</code>
<div class="block">The <b>BufferedIO</b> option takes a boolean value.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#setBufferSize-int-">setBufferSize</a></span>(int bufferSize)</code>
<div class="block">Set the size of the IO buffer.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#setFile-java.lang.String-">setFile</a></span>(java.lang.String file)</code>
<div class="block">The <b>File</b> property takes a string value which should be the
name of the file to append to.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#setFile-java.lang.String-boolean-boolean-int-">setFile</a></span>(java.lang.String fileName,
boolean append,
boolean bufferedIO,
int bufferSize)</code>
<div class="block">Sets and <i>opens</i> the file where the log output will
go.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/FileAppender.html#setQWForFiles-java.io.Writer-">setQWForFiles</a></span>(java.io.Writer writer)</code>
<div class="block">Sets the quiet writer being used.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.log4j.WriterAppender">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.log4j.<a href="../../../org/apache/log4j/WriterAppender.html" title="class in org.apache.log4j">WriterAppender</a></h3>
<code><a href="../../../org/apache/log4j/WriterAppender.html#append-org.apache.log4j.spi.LoggingEvent-">append</a>, <a href="../../../org/apache/log4j/WriterAppender.html#checkEntryConditions--">checkEntryConditions</a>, <a href="../../../org/apache/log4j/WriterAppender.html#close--">close</a>, <a href="../../../org/apache/log4j/WriterAppender.html#closeWriter--">closeWriter</a>, <a href="../../../org/apache/log4j/WriterAppender.html#createWriter-java.io.OutputStream-">createWriter</a>, <a href="../../../org/apache/log4j/WriterAppender.html#getEncoding--">getEncoding</a>, <a href="../../../org/apache/log4j/WriterAppender.html#getImmediateFlush--">getImmediateFlush</a>, <a href="../../../org/apache/log4j/WriterAppender.html#requiresLayout--">requiresLayout</a>, <a href="../../../org/apache/log4j/WriterAppender.html#setEncoding-java.lang.String-">setEncoding</a>, <a href="../../../org/apache/log4j/WriterAppender.html#setErrorHandler-org.apache.log4j.spi.ErrorHandler-">setErrorHandler</a>, <a href="../../../org/apache/log4j/WriterAppender.html#setImmediateFlush-boolean-">setImmediateFlush</a>, <a href="../../../org/apache/log4j/WriterAppender.html#setWriter-java.io.Writer-">setWriter</a>, <a href="../../../org/apache/log4j/WriterAppender.html#shouldFlush-org.apache.log4j.spi.LoggingEvent-">shouldFlush</a>, <a href="../../../org/apache/log4j/WriterAppender.html#subAppend-org.apache.log4j.spi.LoggingEvent-">subAppend</a>, <a href="../../../org/apache/log4j/WriterAppender.html#writeFooter--">writeFooter</a>, <a href="../../../org/apache/log4j/WriterAppender.html#writeHeader--">writeHeader</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.log4j.AppenderSkeleton">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.log4j.<a href="../../../org/apache/log4j/AppenderSkeleton.html" title="class in org.apache.log4j">AppenderSkeleton</a></h3>
<code><a href="../../../org/apache/log4j/AppenderSkeleton.html#addFilter-org.apache.log4j.spi.Filter-">addFilter</a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#clearFilters--">clearFilters</a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#doAppend-org.apache.log4j.spi.LoggingEvent-">doAppend</a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#finalize--">finalize</a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#getErrorHandler--">getErrorHandler</a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#getFilter--">getFilter</a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#getFirstFilter--">getFirstFilter</a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#getLayout--">getLayout</a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#getName--">getName</a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#getThreshold--">getThreshold</a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#isAsSevereAsThreshold-org.apache.log4j.Priority-">isAsSevereAsThreshold</a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#setLayout-org.apache.log4j.Layout-">setLayout</a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#setName-java.lang.String-">setName</a>, <a href="../../../org/apache/log4j/AppenderSkeleton.html#setThreshold-org.apache.log4j.Priority-">setThreshold</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="fileAppend">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fileAppend</h4>
<pre>protected boolean fileAppend</pre>
<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>
</li>
</ul>
<a name="fileName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fileName</h4>
<pre>protected java.lang.String fileName</pre>
<div class="block">The name of the log file.</div>
</li>
</ul>
<a name="bufferedIO">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bufferedIO</h4>
<pre>protected boolean bufferedIO</pre>
<div class="block">Do we do bufferedIO?</div>
</li>
</ul>
<a name="bufferSize">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>bufferSize</h4>
<pre>protected int bufferSize</pre>
<div class="block">Determines the size of IO buffer be. Default is 8K.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="FileAppender--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FileAppender</h4>
<pre>public FileAppender()</pre>
<div class="block">The default constructor does not do anything.</div>
</li>
</ul>
<a name="FileAppender-org.apache.log4j.Layout-java.lang.String-boolean-boolean-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FileAppender</h4>
<pre>public FileAppender(<a href="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">Layout</a> layout,
java.lang.String filename,
boolean append,
boolean bufferedIO,
int bufferSize)
throws java.io.IOException</pre>
<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>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="FileAppender-org.apache.log4j.Layout-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FileAppender</h4>
<pre>public FileAppender(<a href="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">Layout</a> layout,
java.lang.String filename,
boolean append)
throws java.io.IOException</pre>
<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>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="FileAppender-org.apache.log4j.Layout-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FileAppender</h4>
<pre>public FileAppender(<a href="../../../org/apache/log4j/Layout.html" title="class in org.apache.log4j">Layout</a> layout,
java.lang.String filename)
throws java.io.IOException</pre>
<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>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setFile-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFile</h4>
<pre>public void setFile(java.lang.String file)</pre>
<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="../../../org/apache/log4j/FileAppender.html#activateOptions--"><code>activateOptions()</code></a> is called, not when the options are set.</div>
</li>
</ul>
<a name="getAppend--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAppend</h4>
<pre>public boolean getAppend()</pre>
<div class="block">Returns the value of the <b>Append</b> option.</div>
</li>
</ul>
<a name="getFile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFile</h4>
<pre>public java.lang.String getFile()</pre>
<div class="block">Returns the value of the <b>File</b> option.</div>
</li>
</ul>
<a name="activateOptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>activateOptions</h4>
<pre>public void activateOptions()</pre>
<div class="block">If the value of <b>File</b> is not <code>null</code>, then <a href="../../../org/apache/log4j/FileAppender.html#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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/log4j/spi/OptionHandler.html#activateOptions--">activateOptions</a></code> in interface <code><a href="../../../org/apache/log4j/spi/OptionHandler.html" title="interface in org.apache.log4j.spi">OptionHandler</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../org/apache/log4j/WriterAppender.html#activateOptions--">activateOptions</a></code> in class <code><a href="../../../org/apache/log4j/WriterAppender.html" title="class in org.apache.log4j">WriterAppender</a></code></dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.8.1</dd>
</dl>
</li>
</ul>
<a name="closeFile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>closeFile</h4>
<pre>protected void closeFile()</pre>
<div class="block">Closes the previously opened file.</div>
</li>
</ul>
<a name="getBufferedIO--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBufferedIO</h4>
<pre>public boolean getBufferedIO()</pre>
<div class="block">Get the value of the <b>BufferedIO</b> option.
<p>BufferedIO will significatnly increase performance on heavily
loaded systems.</div>
</li>
</ul>
<a name="getBufferSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBufferSize</h4>
<pre>public int getBufferSize()</pre>
<div class="block">Get the size of the IO buffer.</div>
</li>
</ul>
<a name="setAppend-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAppend</h4>
<pre>public void setAppend(boolean flag)</pre>
<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="../../../org/apache/log4j/FileAppender.html#setFile-java.lang.String-"><code>setFile</code></a> (see
above). Otherwise, <a href="../../../org/apache/log4j/FileAppender.html#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="../../../org/apache/log4j/FileAppender.html#activateOptions--"><code>activateOptions()</code></a> is called, not when the options are set.</div>
</li>
</ul>
<a name="setBufferedIO-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBufferedIO</h4>
<pre>public void setBufferedIO(boolean bufferedIO)</pre>
<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 <code>Writer</code> wrapped
around a <code>BufferedWriter</code>.
BufferedIO will significatnly increase performance on heavily
loaded systems.</div>
</li>
</ul>
<a name="setBufferSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBufferSize</h4>
<pre>public void setBufferSize(int bufferSize)</pre>
<div class="block">Set the size of the IO buffer.</div>
</li>
</ul>
<a name="setFile-java.lang.String-boolean-boolean-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFile</h4>
<pre>public void setFile(java.lang.String fileName,
boolean append,
boolean bufferedIO,
int bufferSize)
throws java.io.IOException</pre>
<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>
<dt><span class="paramLabel">Parameters:</span></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><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="setQWForFiles-java.io.Writer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQWForFiles</h4>
<pre>protected void setQWForFiles(java.io.Writer writer)</pre>
<div class="block">Sets the quiet writer being used.
This method is overriden by <a href="../../../org/apache/log4j/RollingFileAppender.html" title="class in org.apache.log4j"><code>RollingFileAppender</code></a>.</div>
</li>
</ul>
<a name="reset--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>reset</h4>
<pre>protected void reset()</pre>
<div class="block">Close any previously opened file and call the parent's
<code>reset</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../org/apache/log4j/WriterAppender.html#reset--">reset</a></code> in class <code><a href="../../../org/apache/log4j/WriterAppender.html" title="class in org.apache.log4j">WriterAppender</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Log4j 1.2.17</b><!-- 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. --></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/apache/log4j/EnhancedThrowableRenderer.html" title="class in org.apache.log4j"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/apache/log4j/Hierarchy.html" title="class in org.apache.log4j"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/log4j/FileAppender.html" target="_top">Frames</a></li>
<li><a href="FileAppender.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright 2000-2007 Apache Software Foundation.</small></p>
</body>
</html>
|