Save This Page
Home » openjdk-7 » java » util » logging » [javadoc | source]
java.util.logging
public class: MemoryHandler [javadoc | source]
java.lang.Object
   java.util.logging.Handler
      java.util.logging.MemoryHandler
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. On certain trigger conditions, the MemoryHandler will push out its current buffer contents to a target Handler, which will typically publish them to the outside world.

There are three main models for triggering a push of the buffer:

Configuration: By default each MemoryHandler is initialized using the following LogManager configuration properties. If properties are not defined (or have invalid values) then the specified default values are used. If no default value is defined then a RuntimeException is thrown.

Field Summary
 int start     
 int count     
Fields inherited from java.util.logging.Handler:
sealed
Constructor:
 public MemoryHandler() 
 public MemoryHandler(Handler target,
    int size,
    Level pushLevel) 
    Create a MemoryHandler.

    The MemoryHandler is configured based on LogManager properties (or their default values) except that the given pushLevel argument and buffer size argument are used.

    Parameters:
    target - the Handler to which to publish output.
    size - the number of log records to buffer (must be greater than zero)
    pushLevel - message level to push on
    Throws:
    IllegalArgumentException - is size is <= 0
Method from java.util.logging.MemoryHandler Summary:
close,   flush,   getPushLevel,   isLoggable,   publish,   push,   setPushLevel
Methods from java.util.logging.Handler:
checkAccess,   close,   flush,   getEncoding,   getErrorManager,   getFilter,   getFormatter,   getLevel,   isLoggable,   publish,   reportError,   setEncoding,   setErrorManager,   setFilter,   setFormatter,   setLevel
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.util.logging.MemoryHandler Detail:
 public  void close() throws SecurityException 
    Close the Handler and free all associated resources. This will also close the target Handler.
 public  void flush() 
    Causes a flush on the target Handler.

    Note that the current contents of the MemoryHandler buffer are not written out. That requires a "push".

 public synchronized Level getPushLevel() 
    Get the pushLevel.
 public boolean isLoggable(LogRecord record) 
    Check if this Handler would actually log a given LogRecord into its internal buffer.

    This method checks if the LogRecord has an appropriate level and whether it satisfies any Filter. However it does not check whether the LogRecord would result in a "push" of the buffer contents. It will return false if the LogRecord is Null.

 public synchronized  void publish(LogRecord record) 
    Store a LogRecord in an internal buffer.

    If there is a Filter, its isLoggable method is called to check if the given log record is loggable. If not we return. Otherwise the given record is copied into an internal circular buffer. Then the record's level property is compared with the pushLevel. If the given level is greater than or equal to the pushLevel then push is called to write all buffered records to the target output Handler.

 public synchronized  void push() 
    Push any buffered output to the target Handler.

    The buffer is then cleared.

 public  void setPushLevel(Level newLevel) throws SecurityException 
    Set the pushLevel. After a LogRecord is copied into our internal buffer, if its level is greater than or equal to the pushLevel, then push will be called.