com.sptci.logging

Class FileHandler

java.lang.Object

java.util.logging.Handler

com.sptci.logging.HandlerSkeleton

com.sptci.logging.WriterHandler

com.sptci.logging.FileHandler

Direct Known Subclasses:

DailyRollingFileHandler

public class FileHandler
extends WriterHandler

FileAppender appends log events to a file.

Version:

$Revision: 5813 $

Author:

Ceki Gülcü, Scott.Stark@jboss.org

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	fileAppend Controls file truncatation.
protected String	fileName The name of the log file.

Fields inherited from class com.sptci.logging.WriterHandler

bufferedIO, bufferSize, immediateFlush

Fields inherited from class com.sptci.logging.HandlerSkeleton

name

Constructor Summary

Constructors

Constructor and Description
FileHandler() The default constructor does not do anything.
FileHandler(Formatter layout, String filename) Instantiate a FileHandler and open the file designated by filename.
FileHandler(Formatter layout, String filename, boolean append) Instantiate a FileHandler and open the file designated by filename.
FileHandler(Formatter layout, String filename, boolean append, boolean bufferedIO, int bufferSize) Instantiate a FileHandler and open the file designated by filename.

Method Summary

Modifier and Type	Method and Description
void	activateOptions() If the value of File is not null, then setFile(String) is called with the values of File and Append properties.
boolean	getAppend() Returns the value of the Append option.
String	getFile() Returns the value of the File option.
void	setAppend(boolean flag) The Append 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.

Methods inherited from class com.sptci.logging.WriterHandler

checkEntryConditions, close, flush, getBufferSize, getImmediateFlush, isBufferedIO, publish, setBufferedIO, setBufferSize, setEncoding, setImmediateFlush, setOutputStream, subPublish

Methods inherited from class com.sptci.logging.HandlerSkeleton

debug, getName, setName

Methods inherited from class java.util.logging.Handler

getEncoding, getErrorManager, getFilter, getFormatter, getLevel, isLoggable, reportError, setErrorManager, setFilter, setFormatter, setLevel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

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 Detail

FileHandler

public FileHandler()

The default constructor does not do anything.

FileHandler

public FileHandler(Formatter layout,
                   String filename,
                   boolean append,
                   boolean bufferedIO,
                   int bufferSize)
            throws IOException

Instantiate a FileHandler 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.

Parameters:

layout - The formatter for the log record

filename - The base file name for the log file

append - The append mode to use for the log file

bufferedIO - Flag indicating whether IO should be buffered

bufferSize - The buffer size to use if using buffered IO

Throws:

IOException - If errors are encountered while setting up the logging system

FileHandler

public FileHandler(Formatter layout,
                   String filename,
                   boolean append)
            throws IOException

Instantiate a FileHandler 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.

Parameters:

layout - The formatter to use for the log records

filename - The base log file name

append - The append mode to use for the log file

Throws:

IOException - If errors are encountered while setting up the logging system

FileHandler

public FileHandler(Formatter layout,
                   String filename)
            throws IOException

Instantiate a FileHandler and open the file designated by filename. The opened filename will become the output destination for this appender. The file will be appended to.

Parameters:

layout - The formatter to use for the log records

filename - The base log file name

Throws:

IOException - If errors are encountered while setting up the logging system

Method Detail

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: Actual opening of the file is made when activateOptions() is called, not when the options are set.

Parameters:

file - The file to append to

getAppend

public boolean getAppend()

Returns the value of the Append option.

Returns:

whether to append to the file

getFile

public String getFile()

Returns the value of the File option.

Returns:

the file name

activateOptions

public void activateOptions()

If the value of File is not null, then setFile(String) is called with the values of File and Append properties.

Overrides:

activateOptions in class HandlerSkeleton

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.

Parameters:

flag - The flag that indicates append mode

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 FileHandler 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.

bufferedIO - Flag indicating whether IO operations should be buffered

bufferSize - The buffer size to use when using buffered IO

Throws:

IOException - If errors are encountered