xdev.util.logging

Class XdevMemoryHandler

java.lang.Object

java.util.logging.Handler

xdev.util.logging.XdevMemoryHandler

public class XdevMemoryHandler
extends Handler

Handler that buffers requests in a circular buffer in memory. Normally this Handler simply stores incoming LogRecords into its memory buffer and discards earlier records. This buffering is very cheap and avoids formatting costs.

The XdevMemoryHandler supports following properties, which must be set in the System properties. To change the properties in Runtime in a type-safe manner you may use the IntegerSystemProperty reference hold by SYSTEM_PROPERTY_STORAGE_SIZE.

Name	Type	Description
xdev.util.logging.xdevmemoryhandler.storageSize	int	The xdev.util.logging.xdevmemoryhandler.storageSize System property can be used to specify the storage size for the XdevMemoryHandler. The XdevMemoryHandler holds on to a maximum of log records specified by this property. If the maximum is reached earlier log records will be discarded.

Since:

3.2

Author:

XDEV Software (FH), XDEV Software (RHHF)

See Also:

IntegerSystemProperty

Field Summary

Fields

Modifier and Type	Field and Description
static IntegerSystemProperty	SYSTEM_PROPERTY_STORAGE_SIZE The xdev.util.logging.xdevhandler.storageSize System property can be used to specify the storage size for the XdevMemoryHandler.

Constructor Summary

Constructors

Constructor and Description
XdevMemoryHandler() Creates a new XdevMemoryHandler instance.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush() This class does not support the concept of flush.
LogRecord	getRecord(int index) Returns the reference to the log record specified by index.
int	getRecordCount() Returns the count of the records currently stored by this XdevMemoryHandler.
List<LogRecord>	getRecords() Returns a List (defensive copy) of the LogRecords held by this XdevMemoryHandler instance.
void	publish(LogRecord record)

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

SYSTEM_PROPERTY_STORAGE_SIZE

public static final IntegerSystemProperty SYSTEM_PROPERTY_STORAGE_SIZE

The xdev.util.logging.xdevhandler.storageSize System property can be used to specify the storage size for the XdevMemoryHandler. The XdevMemoryHandler holds on to a maximum of log records specified by this property. If the maximum is reached earlier log records will be discarded.

Constructor Detail

XdevMemoryHandler

public XdevMemoryHandler()

Creates a new XdevMemoryHandler instance.

Method Detail

publish

public void publish(LogRecord record)

Specified by:

publish in class Handler

flush

public void flush()

This class does not support the concept of flush. You may use methods calls to get the log records.

Specified by:

flush in class Handler

See Also:

getRecords()

getRecords

public List<LogRecord> getRecords()

Returns a List (defensive copy) of the LogRecords held by this XdevMemoryHandler instance.

Returns:

a List (defensive copy) of the LogRecords held by this XdevMemoryHandler instance.

getRecordCount

public int getRecordCount()

Returns the count of the records currently stored by this XdevMemoryHandler.

Returns:

the count of the records currently stored by this XdevMemoryHandler.

getRecord

public LogRecord getRecord(int index)

Returns the reference to the log record specified by index.

Parameters:

index - of the log record to return.

Returns:

the reference to the log record specified by index.

close

public void close()
           throws SecurityException

Specified by:

close in class Handler

Throws:

SecurityException