/usr/share/doc/liblog4j1.2-java/api/org/apache/log4j/RollingFileAppender.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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>RollingFileAppender (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="RollingFileAppender (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};
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/RollingFileAppender.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/PropertyConfigurator.html" title="class in org.apache.log4j"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/apache/log4j/SimpleLayout.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/RollingFileAppender.html" target="_top">Frames</a></li>
<li><a href="RollingFileAppender.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 RollingFileAppender" class="title">Class RollingFileAppender</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><a href="../../../org/apache/log4j/FileAppender.html" title="class in org.apache.log4j">org.apache.log4j.FileAppender</a></li>
<li>
<ul class="inheritance">
<li>org.apache.log4j.RollingFileAppender</li>
</ul>
</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/varia/ExternallyRolledFileAppender.html" title="class in org.apache.log4j.varia">ExternallyRolledFileAppender</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">RollingFileAppender</span>
extends <a href="../../../org/apache/log4j/FileAppender.html" title="class in org.apache.log4j">FileAppender</a></pre>
<div class="block">RollingFileAppender extends FileAppender to backup the log files when
they reach a certain size.
The log4j extras companion includes alternatives which should be considered
for new deployments and which are discussed in the documentation
for org.apache.log4j.rolling.RollingFileAppender.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Heinz Richter, 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 int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/RollingFileAppender.html#maxBackupIndex">maxBackupIndex</a></span></code>
<div class="block">There is one backup file by default.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/RollingFileAppender.html#maxFileSize">maxFileSize</a></span></code>
<div class="block">The default maximum file size is 10MB.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.log4j.FileAppender">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.log4j.<a href="../../../org/apache/log4j/FileAppender.html" title="class in org.apache.log4j">FileAppender</a></h3>
<code><a href="../../../org/apache/log4j/FileAppender.html#bufferedIO">bufferedIO</a>, <a href="../../../org/apache/log4j/FileAppender.html#bufferSize">bufferSize</a>, <a href="../../../org/apache/log4j/FileAppender.html#fileAppend">fileAppend</a>, <a href="../../../org/apache/log4j/FileAppender.html#fileName">fileName</a></code></li>
</ul>
<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/RollingFileAppender.html#RollingFileAppender--">RollingFileAppender</a></span>()</code>
<div class="block">The default constructor simply calls its <a href="../../../org/apache/log4j/FileAppender.html#FileAppender-org.apache.log4j.Layout-java.lang.String-"><code>parents constructor</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/RollingFileAppender.html#RollingFileAppender-org.apache.log4j.Layout-java.lang.String-">RollingFileAppender</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/RollingFileAppender.html#RollingFileAppender-org.apache.log4j.Layout-java.lang.String-boolean-">RollingFileAppender</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 RollingFileAppender 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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/RollingFileAppender.html#getMaxBackupIndex--">getMaxBackupIndex</a></span>()</code>
<div class="block">Returns the value of the <b>MaxBackupIndex</b> option.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/RollingFileAppender.html#getMaximumFileSize--">getMaximumFileSize</a></span>()</code>
<div class="block">Get the maximum size that the output file is allowed to reach
before being rolled over to backup files.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/RollingFileAppender.html#rollOver--">rollOver</a></span>()</code>
<div class="block">Implements the usual roll over behaviour.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/RollingFileAppender.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="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/RollingFileAppender.html#setMaxBackupIndex-int-">setMaxBackupIndex</a></span>(int maxBackups)</code>
<div class="block">Set the maximum number of backup files to keep around.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/RollingFileAppender.html#setMaxFileSize-java.lang.String-">setMaxFileSize</a></span>(java.lang.String value)</code>
<div class="block">Set the maximum size that the output file is allowed to reach
before being rolled over to backup files.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/RollingFileAppender.html#setMaximumFileSize-long-">setMaximumFileSize</a></span>(long maxFileSize)</code>
<div class="block">Set the maximum size that the output file is allowed to reach
before being rolled over to backup files.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/RollingFileAppender.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>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/log4j/RollingFileAppender.html#subAppend-org.apache.log4j.spi.LoggingEvent-">subAppend</a></span>(<a href="../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi">LoggingEvent</a> event)</code>
<div class="block">This method differentiates RollingFileAppender from its super
class.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.log4j.FileAppender">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.log4j.<a href="../../../org/apache/log4j/FileAppender.html" title="class in org.apache.log4j">FileAppender</a></h3>
<code><a href="../../../org/apache/log4j/FileAppender.html#activateOptions--">activateOptions</a>, <a href="../../../org/apache/log4j/FileAppender.html#closeFile--">closeFile</a>, <a href="../../../org/apache/log4j/FileAppender.html#getAppend--">getAppend</a>, <a href="../../../org/apache/log4j/FileAppender.html#getBufferedIO--">getBufferedIO</a>, <a href="../../../org/apache/log4j/FileAppender.html#getBufferSize--">getBufferSize</a>, <a href="../../../org/apache/log4j/FileAppender.html#getFile--">getFile</a>, <a href="../../../org/apache/log4j/FileAppender.html#reset--">reset</a>, <a href="../../../org/apache/log4j/FileAppender.html#setAppend-boolean-">setAppend</a>, <a href="../../../org/apache/log4j/FileAppender.html#setBufferedIO-boolean-">setBufferedIO</a>, <a href="../../../org/apache/log4j/FileAppender.html#setBufferSize-int-">setBufferSize</a>, <a href="../../../org/apache/log4j/FileAppender.html#setFile-java.lang.String-">setFile</a></code></li>
</ul>
<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#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="maxFileSize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxFileSize</h4>
<pre>protected long maxFileSize</pre>
<div class="block">The default maximum file size is 10MB.</div>
</li>
</ul>
<a name="maxBackupIndex">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>maxBackupIndex</h4>
<pre>protected int maxBackupIndex</pre>
<div class="block">There is one backup file by default.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="RollingFileAppender--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RollingFileAppender</h4>
<pre>public RollingFileAppender()</pre>
<div class="block">The default constructor simply calls its <a href="../../../org/apache/log4j/FileAppender.html#FileAppender-org.apache.log4j.Layout-java.lang.String-"><code>parents constructor</code></a>.</div>
</li>
</ul>
<a name="RollingFileAppender-org.apache.log4j.Layout-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RollingFileAppender</h4>
<pre>public RollingFileAppender(<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 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>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="RollingFileAppender-org.apache.log4j.Layout-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RollingFileAppender</h4>
<pre>public RollingFileAppender(<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="getMaxBackupIndex--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxBackupIndex</h4>
<pre>public int getMaxBackupIndex()</pre>
<div class="block">Returns the value of the <b>MaxBackupIndex</b> option.</div>
</li>
</ul>
<a name="getMaximumFileSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaximumFileSize</h4>
<pre>public long getMaximumFileSize()</pre>
<div class="block">Get the maximum size that the output file is allowed to reach
before being rolled over to backup files.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a name="rollOver--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rollOver</h4>
<pre>public void rollOver()</pre>
<div class="block">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>
</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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../org/apache/log4j/FileAppender.html#setFile-java.lang.String-boolean-boolean-int-">FileAppender</a></code></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>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../org/apache/log4j/FileAppender.html#setFile-java.lang.String-boolean-boolean-int-">setFile</a></code> in class <code><a href="../../../org/apache/log4j/FileAppender.html" title="class in org.apache.log4j">FileAppender</a></code></dd>
<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="setMaxBackupIndex-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxBackupIndex</h4>
<pre>public void setMaxBackupIndex(int maxBackups)</pre>
<div class="block">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>
</li>
</ul>
<a name="setMaximumFileSize-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaximumFileSize</h4>
<pre>public void setMaximumFileSize(long maxFileSize)</pre>
<div class="block">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-java.lang.String-"><code>setMaxFileSize(java.lang.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>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/apache/log4j/RollingFileAppender.html#setMaxFileSize-java.lang.String-"><code>setMaxFileSize(String)</code></a></dd>
</dl>
</li>
</ul>
<a name="setMaxFileSize-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxFileSize</h4>
<pre>public void setMaxFileSize(java.lang.String value)</pre>
<div class="block">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>
</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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../org/apache/log4j/FileAppender.html#setQWForFiles-java.io.Writer-">FileAppender</a></code></span></div>
<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>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../org/apache/log4j/FileAppender.html#setQWForFiles-java.io.Writer-">setQWForFiles</a></code> in class <code><a href="../../../org/apache/log4j/FileAppender.html" title="class in org.apache.log4j">FileAppender</a></code></dd>
</dl>
</li>
</ul>
<a name="subAppend-org.apache.log4j.spi.LoggingEvent-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>subAppend</h4>
<pre>protected void subAppend(<a href="../../../org/apache/log4j/spi/LoggingEvent.html" title="class in org.apache.log4j.spi">LoggingEvent</a> event)</pre>
<div class="block">This method differentiates RollingFileAppender from its super
class.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../org/apache/log4j/WriterAppender.html#subAppend-org.apache.log4j.spi.LoggingEvent-">subAppend</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.9.0</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/RollingFileAppender.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/PropertyConfigurator.html" title="class in org.apache.log4j"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/apache/log4j/SimpleLayout.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/RollingFileAppender.html" target="_top">Frames</a></li>
<li><a href="RollingFileAppender.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>
|