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 log records for later publishing by one or more dynamically defined Handler instances.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUFFER_LIMIT The maximum number of log records 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.
static void	addHandler(java.util.logging.Logger logger, java.util.logging.Handler handler) Get the LogBuffer and add a Handler.
void	clear() Clear this log buffer.
static void	clear(java.util.logging.Logger logger) Get the LogBuffer and clear it's content.
void	close()
void	exportTo(java.io.File file) Export this log buffer's content to a file.
static void	exportTo(java.util.logging.Logger logger, java.io.File file) Get the LogBuffer and export it's content.
void	flush()
static LogBuffer	getInstance(java.util.logging.Logger logger) Get the LogBuffer instance attached to a given Logger.
void	publish(java.util.logging.LogRecord record)
void	removeHandler(java.util.logging.Handler handler) Remove a Handler.
static void	removeHandler(java.util.logging.Logger logger, java.util.logging.Handler handler) Get the LogBuffer and remove a Handler.

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

BUFFER_LIMIT

public static final int BUFFER_LIMIT

The maximum number of log records stored in the buffer.

Constructor Detail

LogBuffer

public LogBuffer()

Method Detail

getInstance

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

Get the LogBuffer instance attached to a given Logger.

Parameters:

logger - The logger to get the log buffer for.

Returns:

The attached log buffer, or null if none has been configured.

addHandler

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

Get the LogBuffer and add a Handler.

If no log buffer has been configured for the submitted logger, this function does nothing.

Parameters:

logger - The logger to get the log buffer for.

handler - The handler to add.

See Also:

getInstance(Logger), addHandler(Handler)

addHandler

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

Add a Handler.

Any already buffered log records is published to the submitted handler.

Parameters:

handler - The handler to add.

removeHandler

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

Get the LogBuffer and remove a Handler.

If no log buffer has been configured for the submitted logger, this function does nothing.

Parameters:

logger - The logger to get the log buffer for.

handler - The handler to remove.

See Also:

getInstance(Logger), removeHandler(Handler)

removeHandler

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

Remove a Handler.

Parameters:

handler - The handler to remove.

clear

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

Get the LogBuffer and clear it's content.

If no log buffer has been configured for the submitted logger, this function does nothing.

Parameters:

logger - The logger to get the log buffer for.

See Also:

getInstance(Logger), clear()

clear

public void clear()

Clear this log buffer.

exportTo

public static void exportTo(java.util.logging.Logger logger,
                            java.io.File file)
                     throws java.io.IOException

Get the LogBuffer and export it's content.

If no log buffer has been configured for the submitted logger, this function does nothing.

Parameters:

logger - The logger to get the log buffer for.

file - The file to export to.

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

getInstance(Logger), exportTo(File)

exportTo

public void exportTo(java.io.File file)
              throws java.io.IOException

Export this log buffer's content to a file.

Parameters:

file - The file to export to.

Throws:

java.io.IOException - if an I/O error occurs.

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()
           throws java.lang.SecurityException

Specified by:

close in class java.util.logging.Handler

Throws:

java.lang.SecurityException