public class RollingFileAppender extends FileAppender
限定符和类型 | 字段和说明 |
---|---|
protected int |
maxBackupIndex
There is one backup file by default.
|
protected long |
maxFileSize
The default maximum file size is 10MB.
|
bufferedIO, bufferSize, fileAppend, fileName
encoding, immediateFlush, qw
closed, errorHandler, headFilter, layout, name, tailFilter, threshold
构造器和说明 |
---|
RollingFileAppender()
The default constructor simply calls its
parents constructor . |
RollingFileAppender(Layout layout,
java.lang.String filename)
Instantiate a FileAppender and open the file designated by
filename . |
RollingFileAppender(Layout layout,
java.lang.String filename,
boolean append)
Instantiate a RollingFileAppender and open the file designated by
filename . |
限定符和类型 | 方法和说明 |
---|---|
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(java.lang.String fileName,
boolean append,
boolean bufferedIO,
int bufferSize)
Sets and opens the file where the log output will
go.
|
void |
setMaxBackupIndex(int maxBackups)
Set the maximum number of backup files to keep around.
|
void |
setMaxFileSize(java.lang.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(java.io.Writer writer)
Sets the quiet writer being used.
|
protected void |
subAppend(LoggingEvent event)
This method differentiates RollingFileAppender from its super
class.
|
activateOptions, closeFile, getAppend, getBufferedIO, getBufferSize, getFile, reset, setAppend, setBufferedIO, setBufferSize, setFile
append, checkEntryConditions, close, closeWriter, createWriter, getEncoding, getImmediateFlush, requiresLayout, setEncoding, setErrorHandler, setImmediateFlush, setWriter, shouldFlush, writeFooter, writeHeader
addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setLayout, setName, setThreshold
protected long maxFileSize
protected int maxBackupIndex
public RollingFileAppender()
parents constructor
.public RollingFileAppender(Layout layout, java.lang.String filename, boolean append) throws java.io.IOException
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.
java.io.IOException
public RollingFileAppender(Layout layout, java.lang.String filename) throws java.io.IOException
filename
. The opened filename will become the output
destination for this appender.
The file will be appended to.
java.io.IOException
public int getMaxBackupIndex()
public long getMaximumFileSize()
public void rollOver()
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.
public void setFile(java.lang.String fileName, boolean append, boolean bufferedIO, int bufferSize) throws java.io.IOException
FileAppender
Sets and opens the file where the log output will go. The specified file must be writable.
If there was already an opened file, then the previous file is closed first.
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.
setFile
在类中 FileAppender
fileName
- The path to the log file.append
- If true will append to fileName. Otherwise will
truncate fileName.java.io.IOException
public void setMaxBackupIndex(int maxBackups)
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
.
public void setMaximumFileSize(long maxFileSize)
This method is equivalent to setMaxFileSize(java.lang.String)
except
that it is required for differentiating the setter taking a
long
argument from the setter taking a
String
argument by the JavaBeans Introspector
.
public void setMaxFileSize(java.lang.String value)
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.
protected void setQWForFiles(java.io.Writer writer)
FileAppender
RollingFileAppender
.setQWForFiles
在类中 FileAppender
protected void subAppend(LoggingEvent event)
subAppend
在类中 WriterAppender