de.carne.util.logging

Class LogRecorder

java.lang.Object

de.carne.util.logging.LogRecorder

public final class LogRecorder
extends java.lang.Object

This class is used to record LogRecords in a selective manner (e.g. to display detailed results of long running operations).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LogRecorder.Session This class represents a running recording session.

Constructor Summary

Constructors

Constructor and Description
LogRecorder(java.util.logging.Level level) Construct LogRecorder.

Method Summary

Modifier and Type	Method and Description
LogRecorder	addLog(Log log) Add a Log instance to the LogRecorder for recording.
LogRecorder	addLogger(java.util.logging.Logger logger) Add a Logger instance to the LogRecorder for recording.
LogRecorder	excludeRecord(java.util.function.Predicate<java.util.logging.LogRecord> exclude) Add an exclude Predicate to the recorder.
LogRecorder	includeRecord(java.util.function.Predicate<java.util.logging.LogRecord> include) Add an include Predicate to the recorder.
LogRecorder.Session	start(boolean currentThreadOnly) Start the recording LogRecorder.Session.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogRecorder

public LogRecorder(java.util.logging.Level level)

Construct LogRecorder.

Parameters:

level - The Level to use for LogRecord filtering (all LogRecords below this level are ignored).

Method Detail

includeRecord

public LogRecorder includeRecord(java.util.function.Predicate<java.util.logging.LogRecord> include)

Add an include Predicate to the recorder.

To be recorded an issued LogRecord must match at least one of the include Predicates.

Parameters:

include - The include Predicate to apply.

Returns:

The updated LogRecorder.

excludeRecord

public LogRecorder excludeRecord(java.util.function.Predicate<java.util.logging.LogRecord> exclude)

Add an exclude Predicate to the recorder.

To be recorded an issued LogRecord must not match any of the exclude Predicates.

Parameters:

exclude - The exclude Predicate to apply.

Returns:

The updated LogRecorder.

addLog

public LogRecorder addLog(Log log)

Add a Log instance to the LogRecorder for recording.

Parameters:

log - The Log instance to add to the recording.

Returns:

The updated LogRecorder.

addLogger

public LogRecorder addLogger(java.util.logging.Logger logger)

Add a Logger instance to the LogRecorder for recording.

Parameters:

logger - The Logger instance to add to the recording.

Returns:

The updated LogRecorder.

start

public LogRecorder.Session start(boolean currentThreadOnly)

Start the recording LogRecorder.Session.

After this method has been invoked the LogRecorder collects all LogRecords that

• issued via one of the added loggers
• match the setup filtering

until the LogRecorder.Session's LogRecorder.Session.close() method is called.

Parameters:

currentThreadOnly - Whether to include only LogRecords issued by the current Thread.

Returns:

The started LogRecorder.Session.