org.mdiutil.util.logging

Class HeaderFileHandler

java.lang.Object

java.util.logging.Handler

java.util.logging.StreamHandler

java.util.logging.FileHandler

org.mdiutil.util.logging.HeaderFileHandler

public class HeaderFileHandler
extends FileHandler

This class allows to add a header to a File logged by a FileHandler.

Constructor Summary

Constructors

Constructor and Description
HeaderFileHandler() Construct a default HeaderFileHandler.
HeaderFileHandler(String pattern) Initialize a HeaderFileHandler to write to the given filename pattern.
HeaderFileHandler(String pattern, boolean append) Initialize a FileHandler to write to the given filename, with optional append.
HeaderFileHandler(String pattern, int limit, int count) Initialize a FileHandler to write to a set of files.

Method Summary

Modifier and Type	Method and Description
void	publish(LogRecord record) Format and publish a LogRecord.
void	setHeader(String header) Set the optional header for the handler.

Methods inherited from class java.util.logging.FileHandler

close

Methods inherited from class java.util.logging.StreamHandler

flush, isLoggable, setEncoding, setOutputStream

Methods inherited from class java.util.logging.Handler

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

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderFileHandler

public HeaderFileHandler()
                  throws IOException,
                         SecurityException

Construct a default HeaderFileHandler.

Throws:

IOException - if there are IO problems opening the files.

SecurityException - if a security manager exists and if the caller does not have LoggingPermission("control")).

NullPointerException - if pattern property is an empty String.

HeaderFileHandler

public HeaderFileHandler(String pattern)
                  throws IOException,
                         SecurityException

Initialize a HeaderFileHandler to write to the given filename pattern.

Parameters:

pattern - the pattern

Throws:

IOException - if there are IO problems opening the files.

SecurityException - if a security manager exists and if the caller does not have LoggingPermission("control")

HeaderFileHandler

public HeaderFileHandler(String pattern,
                         boolean append)
                  throws IOException,
                         SecurityException

Initialize a FileHandler to write to the given filename, with optional append.

Parameters:

pattern - the pattern

Throws:

IOException - if there are IO problems opening the files.

SecurityException - if a security manager exists and if the caller does not have LoggingPermission("control")

HeaderFileHandler

public HeaderFileHandler(String pattern,
                         int limit,
                         int count)
                  throws IOException,
                         SecurityException

Initialize a FileHandler to write to a set of files. When (approximately) the given limit has been written to one file, another file will be opened. The output will cycle through a set of count files. The count must be at least 1.

Parameters:

pattern - the pattern for naming the output file

limit - the maximum number of bytes to write to any one file

count - the number of files to use

Throws:

IOException - if there are IO problems opening the files.

SecurityException - if a security manager exists and if the caller does not have LoggingPermission("control")

IllegalArgumentException - if limit < 0, or count < 1.

Method Detail

setHeader

public void setHeader(String header)

Set the optional header for the handler.

Parameters:

header - the header

publish

public void publish(LogRecord record)

Format and publish a LogRecord.

Overrides:

publish in class FileHandler

Parameters:

record - description of the log event