de.carne.util.logging

Class LogBuffer

java.lang.Object

java.util.logging.Handler

de.carne.util.logging.LogBuffer

public class LogBuffer
extends java.util.logging.Handler

Handler implementation used to buffer LogRecords (e.g. to access log messages issued during application startup).

Field Summary

Fields

Modifier and Type	Field and Description
static int	LIMIT The maximum number of LogRecords stored in the buffer.

Constructor Summary

Constructors

Constructor and Description
LogBuffer()

Method Summary

Modifier and Type	Method and Description
void	addHandler(java.util.logging.Handler handler) Add a Handler to the LogBuffer for LogRecord consuming.
static void	addHandler(java.util.logging.Logger logger, java.util.logging.Handler handler) Add a Handler to a LogBuffer for LogRecord consuming.
static void	addHandler(Log log, java.util.logging.Handler handler) Add a Handler to a LogBuffer for LogRecord consuming.
void	close()
void	flush()
static void	flush(Log log) Perform a flush operation on a LogBuffer.
static void	flush(java.util.logging.Logger logger) Perform a flush operation on a LogBuffer.
static LogBuffer	get(Log log) Get the LogBuffer attached to the submitted Log (if any).
static LogBuffer	get(java.util.logging.Logger logger) Get the LogBuffer attached to the submitted Logger (if any).
void	publish(java.util.logging.LogRecord record)
void	removeHandler(java.util.logging.Handler handler) Remove a previously added Handler from the LogBuffer.
static void	removeHandler(java.util.logging.Logger logger, java.util.logging.Handler handler) Remove a previously added Handler from a LogBuffer.
static void	removeHandler(Log log, java.util.logging.Handler handler) Remove a previously added Handler from a LogBuffer.

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

Field Detail

LIMIT

public static final int LIMIT

The maximum number of LogRecords stored in the buffer.

If the limit is reached the oldest records are automatically discarded.

Constructor Detail

LogBuffer

public LogBuffer()

Method Detail

get

@Nullable
public static LogBuffer get(Log log)

Get the LogBuffer attached to the submitted Log (if any).

Parameters:

log - The Log to get the LogBuffer for.

Returns:

The found LogBuffer or null if none has been configured.

get

@Nullable
public static LogBuffer get(java.util.logging.Logger logger)

Get the LogBuffer attached to the submitted Logger (if any).

Parameters:

logger - The Logger to get the LogBuffer for.

Returns:

The found LogBuffer or null if none has been configured.

addHandler

public static void addHandler(Log log,
                              java.util.logging.Handler handler)

Add a Handler to a LogBuffer for LogRecord consuming.

If the submitted Log has no LogBuffer attached the call is ignored.

Parameters:

log - The Log identifying the LogBuffer to add to.

handler - The Handler to add.

See Also:

get(Log), addHandler(Handler)

addHandler

public static void addHandler(java.util.logging.Logger logger,
                              java.util.logging.Handler handler)

Add a Handler to a LogBuffer for LogRecord consuming.

If the submitted Logger has no LogBuffer attached the call is ignored.

Parameters:

logger - The Logger identifying the LogBuffer to add to.

handler - The Handler to add.

See Also:

get(Logger), addHandler(Handler)

addHandler

public void addHandler(java.util.logging.Handler handler)

Add a Handler to the LogBuffer for LogRecord consuming.

Any already buffered LogRecord is sent to the Handler during this operation.

Parameters:

handler - The Handler to add.

removeHandler

public static void removeHandler(Log log,
                                 java.util.logging.Handler handler)

Remove a previously added Handler from a LogBuffer.

If the submitted Log has no LogBuffer attached the call is ignored.

Parameters:

log - The Log identifying the LogBuffer to remove from.

handler - The Handler to remove.

See Also:

addHandler(Log, Handler), get(Log), removeHandler(Handler)

removeHandler

public static void removeHandler(java.util.logging.Logger logger,
                                 java.util.logging.Handler handler)

Remove a previously added Handler from a LogBuffer.

If the submitted Logger has no LogBuffer attached the call is ignored.

Parameters:

logger - The Logger identifying the LogBuffer to remove from.

handler - The Handler to remove.

See Also:

addHandler(Logger, Handler), get(Logger), removeHandler(Handler)

removeHandler

public void removeHandler(java.util.logging.Handler handler)

Remove a previously added Handler from the LogBuffer.

After removal the Handler will no longer receive any LogRecords.

Parameters:

handler - The Handler to remove.

See Also:

addHandler(Handler)

flush

public static void flush(Log log)

Perform a flush operation on a LogBuffer.

The flush request is forwarded to any currently registered Handler and any buffered LogRecord will be discarded. If the submitted Logger has no LogBuffer attached the call is ignored.

Parameters:

log - The Log identifying the LogBuffer to flush.

See Also:

get(Log)

flush

public static void flush(java.util.logging.Logger logger)

Perform a flush operation on a LogBuffer.

The flush request is forwarded to any currently registered Handler and any buffered LogRecord will be discarded. If the submitted Logger has no LogBuffer attached the call is ignored.

Parameters:

logger - The Logger identifying the LogBuffer to flush.

See Also:

get(Logger)

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