de.carne.util.logging

Class LogMonitor

java.lang.Object

java.util.logging.Handler

de.carne.util.logging.LogMonitor

public class LogMonitor
extends java.util.logging.Handler

This class is used to monitor and record log messages in a selective manner and only during a defined period (for example to display them to the user after a long running task).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LogMonitor.Session This class represents a running monitoring session.

Constructor Summary

Constructors

Constructor and Description
LogMonitor(LogLevel level) Construct LogMonitor.

Method Summary

Modifier and Type	Method and Description
void	close()
void	excludeThread(java.lang.Thread thread) Exclude a Thread from monitoring.
void	flush()
java.util.Collection<java.util.logging.LogRecord>	getRecords() Get the LogRecords collected by this monitor.
void	includeThread(java.lang.Thread thread) Include a Thread in monitoring.
boolean	notEmpty() Check whether this monitor's buffer is not empty and does contain any records.
void	publish(java.util.logging.LogRecord record)
LogMonitor.Session	start() Start a monitoring session.

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LogMonitor

public LogMonitor(LogLevel level)

Construct LogMonitor.

Parameters:

level - The log level to use for monitoring.

Method Detail

includeThread

public void includeThread(java.lang.Thread thread)

Include a Thread in monitoring.

Parameters:

thread - The thread to monitor.

See Also:

excludeThread(Thread)

excludeThread

public void excludeThread(java.lang.Thread thread)

Exclude a Thread from monitoring.

Parameters:

thread - The thread to remove.

See Also:

includeThread(Thread)

notEmpty

public boolean notEmpty()

Check whether this monitor's buffer is not empty and does contain any records.

Returns:

true if this monitor's buffer is not empty and does contain any records.

getRecords

public java.util.Collection<java.util.logging.LogRecord> getRecords()

Get the LogRecords collected by this monitor.

Returns:

The LogRecords collected by this monitor.

start

public LogMonitor.Session start()

Start a monitoring session.

Returns:

The session object.

See Also:

LogMonitor.Session

publish

public void publish(@Nullable
                    java.util.logging.LogRecord record)

Specified by:

publish in class java.util.logging.Handler

flush

public void flush()

Specified by:

flush in class java.util.logging.Handler

close

public void close()

Specified by:

close in class java.util.logging.Handler