org.apache.log4j
public class RollingFileAppender extends FileAppender
Field Summary | |
---|---|
protected int | maxBackupIndex
There is one backup file by default. |
protected long | maxFileSize
The default maximum file size is 10MB. |
Constructor Summary | |
---|---|
RollingFileAppender()
The default constructor simply calls its {@link
FileAppender#FileAppender parents constructor}. | |
RollingFileAppender(Layout layout, String filename, boolean append)
Instantiate a RollingFileAppender and open the file designated by
filename . | |
RollingFileAppender(Layout layout, String filename)
Instantiate a FileAppender and open the file designated by
filename . |
Method Summary | |
---|---|
int | getMaxBackupIndex()
Returns the value of the MaxBackupIndex option. |
long | getMaximumFileSize()
Get the maximum size that the output file is allowed to reach
before being rolled over to backup files. |
void | rollOver()
Implements the usual roll over behaviour.
|
void | setFile(String fileName, boolean append, boolean bufferedIO, int bufferSize) |
void | setMaxBackupIndex(int maxBackups)
Set the maximum number of backup files to keep around.
|
void | setMaxFileSize(String value)
Set the maximum size that the output file is allowed to reach
before being rolled over to backup files.
|
void | setMaximumFileSize(long maxFileSize)
Set the maximum size that the output file is allowed to reach
before being rolled over to backup files.
|
protected void | setQWForFiles(Writer writer) |
protected void | subAppend(LoggingEvent event)
This method differentiates RollingFileAppender from its super
class. |
filename
. The opened filename will become the ouput
destination for this appender.
If the append
parameter is true, the file will be
appended to. Otherwise, the file desginated by
filename
will be truncated before being opened.
filename
. The opened filename will become the output
destination for this appender.
The file will be appended to.
Since: 1.1
If MaxBackupIndex
is positive, then files
{File.1
, ..., File.MaxBackupIndex -1
}
are renamed to {File.2
, ...,
File.MaxBackupIndex
}. Moreover, File
is
renamed File.1
and closed. A new File
is
created to receive further log output.
If MaxBackupIndex
is equal to zero, then the
File
is truncated with no backup files created.
The MaxBackupIndex 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
MaxFileSize
.
In configuration files, the MaxFileSize 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.
This method is equivalent to {@link #setMaxFileSize} except
that it is required for differentiating the setter taking a
long
argument from the setter taking a
String
argument by the JavaBeans {@link
java.beans.Introspector Introspector}.
See Also: setMaxFileSize
Since: 0.9.0