gov.nasa.pds.report.logging.handler

Class PDSFileHandler

java.lang.Object

java.util.logging.Handler

java.util.logging.StreamHandler

java.util.logging.FileHandler

gov.nasa.pds.report.logging.handler.PDSFileHandler

public class PDSFileHandler
extends FileHandler

Class to setup a file handler for the tools logging capability.

Author:

jpadams, mcayanan

Constructor Summary

Constructors

Constructor and Description
PDSFileHandler(String file, boolean append, Level level, Formatter formatter) Constructor.
PDSFileHandler(String file, Formatter formatter) Constructor that does not append to a file and automatically sets the log level to 'ALL'.
PDSFileHandler(String file, Level level, Formatter formatter) Constructor that does not append to a file.

Method Summary

Methods inherited from class java.util.logging.FileHandler

close, publish

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

PDSFileHandler

public PDSFileHandler(String file,
              Formatter formatter)
               throws SecurityException,
                      IOException

Constructor that does not append to a file and automatically sets the log level to 'ALL'.

Parameters:

file - A file name to store the logging messages. If the file exists, it will overwrite the existing contents.

formatter - Formatter to be used to format the log messages.

Throws:

SecurityException

IOException

PDSFileHandler

public PDSFileHandler(String file,
              Level level,
              Formatter formatter)
               throws SecurityException,
                      IOException

Constructor that does not append to a file.

Parameters:

file - A file name to store the logging messages.

level - Sets the logging level.

formatter - Formatter to be used to format the log messages.

Throws:

SecurityException

IOException

PDSFileHandler

public PDSFileHandler(String file,
              boolean append,
              Level level,
              Formatter formatter)
               throws SecurityException,
                      IOException

Constructor.

Parameters:

file - A file name to store the logging messages.

append - A flag to tell the handler to append to the file or to overwrite the existing contents.

level - Sets the logging level.

formatter - Formatter to be used to format the log messages.

Throws:

SecurityException

IOException