de.frame4j.io

Class LogHandler

java.lang.Object

java.util.logging.Handler

de.frame4j.io.LogHandler

Direct Known Subclasses:

LogWriterHandler

@MinDoc(copyright="Copyright  2006, 2009  A. Weinert",
        author="Albrecht Weinert",
        version="V.33",
        lastModified="27.03.2021",
        usage="use for (java.) logging",
        purpose="parent for logging handlers")
public abstract class LogHandler
extends Handler

Common to (this packagage's) logger handlers.


© Copyright 2009 Albrecht Weinert.

Version:

33 (27.03.2021)

Author:

Albrecht Weinert

See Also:

LogWriterHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed Closed and done.
protected boolean	doClose Do close, when finished.
Formatter	formatter The formatter.
protected int	intLevel This LogDbHandler's logging level as number.
static int	OFF_LEVEL Log-Level Off.

Constructor Summary

Constructors

Constructor and Description
LogHandler(Formatter formatter) Constructor.

Method Summary

Modifier and Type	Method and Description
Formatter	getFormatter() The formatter.
boolean	isClosed() Closed (and done).
boolean	isLoggable(LogRecord record) Decide if a LogRecord is loggable on this Handler.
void	setFilter(Filter filter) Set a filter.
void	setFormatter(Formatter formatter) Set the formatter.
void	setLevel(Level level) Set this LogDbHandler's logging level .

Methods inherited from class java.util.logging.Handler

close, flush, getEncoding, getErrorManager, getFilter, getLevel, publish, reportError, setEncoding, setErrorManager

Methods inherited from class java.lang.Object

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

Field Detail

OFF_LEVEL

public static final int OFF_LEVEL

Log-Level Off.

See Also:

Level.OFF

closed

protected boolean closed

Closed and done.

See Also:

isClosed()

intLevel

protected int intLevel

This LogDbHandler's logging level as number.

The actual Level of this LogHandler (level) will be held here as integer number.

doClose

protected volatile boolean doClose

Do close, when finished.

Can be used as Signal by overridden method Handler.close() to other working threads.

formatter

public final Formatter formatter

The formatter.

Hint: This final Formatter may be used as lock object as is in LogDbHandler.

Constructor Detail

LogHandler

public LogHandler(Formatter formatter)

Constructor.

Parameters:

formatter - non null (and forever)

Method Detail

isClosed

public final boolean isClosed()

Closed (and done).

If true this Handler is not usable any more and should be forgotten as soon as possible.

Not usable means that all new logging orders will be filtered out. Nevertheless cached logging (as with LogDbHandler) will be forwarded in a working thread (using the doClose flag as hurry up signal.

setFilter

public final void setFilter(Filter filter)

Set a filter.

Hint: This is a opportunity for complex filter criteria. They will live on cost of the the logging process control threads.

default: null

Overrides:

setFilter in class Handler

Parameters:

filter - the (one) extra filter or null for just level filtering

isLoggable

public final boolean isLoggable(LogRecord record)

Decide if a LogRecord is loggable on this Handler.

record null or LogHandler closed gets a false.

Other wise the level and if given filter criteria apply.

Overrides:

isLoggable in class Handler

See Also:

Handler.isLoggable(java.util.logging.LogRecord)

setLevel

public final void setLevel(Level level)

Set this LogDbHandler's logging level .

LogRecords having a lower Level (integer value) as the one set here will be ignored by this LogHandler.

Implementation hint: This class and its inheritors handle the filtering meant by this level more efficient than the superclass Handler. Nevertheless this info (level) is forwarded to it.

Hint: The basic level filtering is made / should be made by the Logger, thus avoiding the construction of LogRecords than thrown away by the Handlers.

default: Level.ALL

Overrides:

setLevel in class Handler

getFormatter

public final Formatter getFormatter()

The formatter.

Final and never null.

Overrides:

getFormatter in class Handler

setFormatter

public final void setFormatter(Formatter formatter)

Set the formatter.

This method does nothing if the formatter to be set and already set are the same. Otherwise an IllegalArgumentException is thrown as this classes formatter is final and never null. (This senseless method is nevertheless necessary to override a not fitting inherited implementation.)

Overrides:

setFormatter in class Handler