org.apache.log4j
Class FileAppender
- Appender, OptionHandler
public class FileAppender
FileAppender appends log events to a file.
Support for
java.io.Writer
and console appending
has been deprecated and then removed. See the replacement
solutions:
WriterAppender
and
ConsoleAppender
.
protected int | bufferSize - Determines the size of IO buffer be.
|
protected boolean | bufferedIO - Do we do bufferedIO?
|
protected boolean | fileAppend - Controls file truncatation.
|
protected String | fileName - The name of the log file.
|
FileAppender() - The default constructor does not do anything.
|
FileAppender(Layout layout, String filename) - Instantiate a FileAppender and open the file designated by
filename .
|
FileAppender(Layout layout, String filename, boolean append) - Instantiate a FileAppender and open the file designated by
filename .
|
FileAppender(Layout layout, String filename, boolean append, boolean bufferedIO, int bufferSize) - Instantiate a
FileAppender and open the file
designated by filename .
|
void | activateOptions() - If the value of File is not
null , then setFile is called with the values of File and
Append properties.
|
protected void | closeFile() - Closes the previously opened file.
|
boolean | getAppend() - Returns the value of the Append option.
|
int | getBufferSize() - Get the size of the IO buffer.
|
boolean | getBufferedIO() - Get the value of the BufferedIO option.
|
String | getFile() - Returns the value of the File option.
|
protected void | reset() - Close any previously opened file and call the parent's
reset .
|
void | setAppend(boolean flag) - The Append option takes a boolean value.
|
void | setBufferSize(int bufferSize) - Set the size of the IO buffer.
|
void | setBufferedIO(boolean bufferedIO) - The BufferedIO option takes a boolean value.
|
void | setFile(String file) - The File property takes a string value which should be the
name of the file to append to.
|
void | setFile(String fileName, boolean append, boolean bufferedIO, int bufferSize) - Sets and opens the file where the log output will
go.
|
protected void | setQWForFiles(Writer writer) - Sets the quiet writer being used.
|
activateOptions , append , checkEntryConditions , close , closeWriter , createWriter , getEncoding , getImmediateFlush , requiresLayout , reset , setEncoding , setErrorHandler , setImmediateFlush , setWriter , subAppend , writeFooter , writeHeader |
activateOptions , addFilter , append , clearFilters , doAppend , finalize , getErrorHandler , getFilter , getFirstFilter , getLayout , getName , getThreshold , isAsSevereAsThreshold , setErrorHandler , setLayout , setName , setThreshold |
bufferSize
protected int bufferSize
Determines the size of IO buffer be. Default is 8K.
bufferedIO
protected boolean bufferedIO
Do we do bufferedIO?
fileAppend
protected boolean fileAppend
Controls file truncatation. The default value for this variable
is
true
, meaning that by default a
FileAppender
will append to an existing file and not
truncate it.
This option is meaningful only if the FileAppender opens the
file.
fileName
protected String fileName
The name of the log file.
FileAppender
public FileAppender()
The default constructor does not do anything.
FileAppender
public FileAppender(Layout layout,
String filename)
throws IOException
Instantiate a FileAppender and open the file designated by
filename
. The opened filename will become the output
destination for this appender.
The file will be appended to.
FileAppender
public FileAppender(Layout layout,
String filename,
boolean append)
throws IOException
Instantiate a FileAppender and open the file designated by
filename
. The opened filename will become the output
destination for this appender.
If the
append
parameter is true, the file will be
appended to. Otherwise, the file designated by
filename
will be truncated before being opened.
FileAppender
public FileAppender(Layout layout,
String filename,
boolean append,
boolean bufferedIO,
int bufferSize)
throws IOException
Instantiate a
FileAppender
and open the file
designated by
filename
. The opened filename will
become the output destination for this appender.
If the
append
parameter is true, the file will be
appended to. Otherwise, the file designated by
filename
will be truncated before being opened.
If the
bufferedIO
parameter is
true
,
then buffered IO will be used to write to the output file.
closeFile
protected void closeFile()
Closes the previously opened file.
getAppend
public boolean getAppend()
Returns the value of the Append option.
getBufferSize
public int getBufferSize()
Get the size of the IO buffer.
getBufferedIO
public boolean getBufferedIO()
Get the value of the
BufferedIO option.
BufferedIO will significatnly increase performance on heavily
loaded systems.
getFile
public String getFile()
Returns the value of the File option.
reset
protected void reset()
Close any previously opened file and call the parent's
reset
.
- reset in interface WriterAppender
setAppend
public void setAppend(boolean flag)
The
Append option takes a boolean value. It is set to
true
by default. If true, then
File
will be opened in append mode by
setFile
(see
above). Otherwise,
setFile
will open
File
in truncate mode.
Note: Actual opening of the file is made when
activateOptions()
is called, not when the options are set.
setBufferSize
public void setBufferSize(int bufferSize)
Set the size of the IO buffer.
setBufferedIO
public void setBufferedIO(boolean bufferedIO)
The
BufferedIO option takes a boolean value. It is set to
false
by default. If true, then
File
will be opened and the resulting
Writer
wrapped
around a
BufferedWriter
.
BufferedIO will significatnly increase performance on heavily
loaded systems.
setFile
public void setFile(String file)
The
File property takes a string value which should be the
name of the file to append to.
Note that the special values
"System.out" or "System.err" are no longer honored.
Note: Actual opening of the file is made when
activateOptions()
is called, not when the options are set.
setFile
public void setFile(String fileName,
boolean append,
boolean bufferedIO,
int bufferSize)
throws IOException
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.
fileName
- The path to the log file.append
- If true will append to fileName. Otherwise will
truncate fileName.
setQWForFiles
protected void setQWForFiles(Writer writer)
Copyright 2000-2005 Apache Software Foundation.