net.pwall.log

Class LogListener

java.lang.Object

net.pwall.log.LogListener

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

LogList

public abstract class LogListener
extends Object
implements AutoCloseable

The LogListener class is the base class for an object that is called for every log event. It is intended to be used only in unit tests. The constructor adds the object to a static list of listeners; the Logger classes will check for the presence of listeners and invoke them as required.

Author:

Peter Wall

Constructor Summary

Constructors

Constructor and Description
LogListener() Construct a LogListener - add the listener to the list of listeners.

Method Summary

Modifier and Type	Method and Description
static void	add(LogListener listener) Add a listener to the list.
void	close() Close the listener - remove it from the list.
static void	invokeAll(Logger logger, Level level, String text, Throwable throwable) Invoke all listeners.
static boolean	present() Test whether listeners are present.
abstract void	receive(Instant time, Logger logger, Level level, String text, Throwable throwable) Receive a log event.
static void	remove(LogListener listener) Remove a listener from the list.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogListener

public LogListener()

Construct a LogListener - add the listener to the list of listeners.

Method Detail

close

public void close()

Close the listener - remove it from the list. This operation is idempotent - closing a listener that is already closed has no effect.

Specified by:

close in interface AutoCloseable

receive

public abstract void receive(Instant time,
                             Logger logger,
                             Level level,
                             String text,
                             Throwable throwable)

Receive a log event.

Parameters:

time - the time of the event

logger - the logger object

level - the logging level

text - the text of the message

throwable - a Throwable, if provided

add

public static void add(LogListener listener)

Add a listener to the list.

Parameters:

listener - the listener

remove

public static void remove(LogListener listener)

Remove a listener from the list.

Parameters:

listener - the listener

present

public static boolean present()

Test whether listeners are present.

Returns:

true if listeners are present

invokeAll

public static void invokeAll(Logger logger,
                             Level level,
                             String text,
                             Throwable throwable)

Invoke all listeners. For reasons of efficiency, this should be called only after present() has returned true.

Parameters:

logger - the originating Logger

level - the level

text - the text of the log message

throwable - the Throwable, if present