Package adams.core.logging

Class FileHandler

java.lang.Object

java.util.logging.Handler

adams.core.logging.AbstractLogHandler

adams.core.logging.FileHandler

All Implemented Interfaces:

Comparable<Handler>

Direct Known Subclasses:

RotatingFileHandler

public class FileHandler
extends AbstractLogHandler

Sends all logging output to the specified log file.
Makes use of the ADAMS_LOGFILE_PREFIX environment variable. E.g., with "ADAMS_LOGFILE_PREFIX=testing-", the default log file "$HOME/.adams/log/console.log" will become "$HOME/.adams/log/testing-console.log".

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary

Fields

Modifier and Type	Field	Description
static String	ADAMS_LOGFILE_PREFIX	the environment variable to inject a prefix into the log file.
protected static Map<File,Boolean>	m_Configured	whether the file has been configured.
protected File	m_LogFile	the log file to use.
protected boolean	m_LogIsDir	whether the file points to a directory.

Fields inherited from class adams.core.logging.AbstractLogHandler

m_LoggingListeners, m_LogUsed

Constructor Summary

Constructors

Constructor	Description
FileHandler()

Method Summary

Modifier and Type	Method	Description
int	compareTo(Handler o)	Compares the handler with itself.
protected void	doPublish(LogRecord record)	Publish a LogRecord.
File	getLogFile()	Returns the log file in use.
protected void	initialize()	Initializes the members.
protected boolean	isSetUp()	Returns whether the handler has been initialized.
void	setLogFile(File value)	Sets the log file to use.
protected void	setUp()	Hook method for performing setup before processing first log record.

Methods inherited from class adams.core.logging.AbstractLogHandler

addLoggingListener, close, equals, flush, iterator, loggingListeners, notifyLoggingListeners, postPublish, publish, removeLoggingListener, removeLoggingListeners, reset

Methods inherited from class java.util.logging.Handler

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

Methods inherited from class java.lang.Object

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

Field Detail

ADAMS_LOGFILE_PREFIX

public static final String ADAMS_LOGFILE_PREFIX

the environment variable to inject a prefix into the log file.

See Also:

Constant Field Values

m_Configured

protected static final Map<File,Boolean> m_Configured

whether the file has been configured.

m_LogFile

protected File m_LogFile

the log file to use.

m_LogIsDir

protected boolean m_LogIsDir

whether the file points to a directory.

Constructor Detail

FileHandler

public FileHandler()

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractLogHandler

setLogFile

public void setLogFile(File value)

Sets the log file to use.

Parameters:

value - the file

getLogFile

public File getLogFile()

Returns the log file in use.

Returns:

the file

isSetUp

protected boolean isSetUp()

Returns whether the handler has been initialized.

Overrides:

isSetUp in class AbstractLogHandler

Returns:

true if initialized

setUp

protected void setUp()

Hook method for performing setup before processing first log record.

Overrides:

setUp in class AbstractLogHandler

doPublish

protected void doPublish(LogRecord record)

Publish a LogRecord.

The logging request was made initially to a Logger object, which initialized the LogRecord and forwarded it here.

The Handler is responsible for formatting the message, when and if necessary. The formatting should include localization.

Specified by:

doPublish in class AbstractLogHandler

Parameters:

record - description of the log event. A null record is silently ignored and is not published

compareTo

public int compareTo(Handler o)

Compares the handler with itself.

Specified by:

compareTo in interface Comparable<Handler>

Overrides:

compareTo in class AbstractLogHandler

Parameters:

o - the other handler

Returns:

less than 0, equal to 0, or greater than 0 if the handler is less, equal to, or greater than this one