org.apache.log4j

Class FileAppender

Implemented Interfaces:
Appender, OptionHandler
Known Direct Subclasses:
DailyRollingFileAppender, RollingFileAppender

public class FileAppender
extends WriterAppender

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.

Author:
Ceki Gülcü

Field Summary

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.

Fields inherited from class org.apache.log4j.WriterAppender

encoding, immediateFlush, qw

Fields inherited from class org.apache.log4j.AppenderSkeleton

closed, errorHandler, headFilter, layout, name, tailFilter, threshold

Constructor Summary

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.

Method Summary

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.

Methods inherited from class org.apache.log4j.WriterAppender

activateOptions, append, checkEntryConditions, close, closeWriter, createWriter, getEncoding, getImmediateFlush, requiresLayout, reset, setEncoding, setErrorHandler, setImmediateFlush, setWriter, subAppend, writeFooter, writeHeader

Methods inherited from class org.apache.log4j.AppenderSkeleton

activateOptions, addFilter, append, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold

Field Details

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.

Constructor Details

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.

Method Details

activateOptions

public void activateOptions()
If the value of File is not null, then setFile is called with the values of File and Append properties.
Specified by:
activateOptions in interface OptionHandler
Overrides:
activateOptions in interface WriterAppender
Since:
0.8.1

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.
Overrides:
reset in interface WriterAppender

setAppend

public void setAppend(boolean flag)

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)

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.

Parameters:
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.