MemoryHandler Class

Definition

Namespace:

Java.Util.Logging

Assembly:

Mono.Android.dll

Handler that buffers requests in a circular buffer in memory.

[Android.Runtime.Register("java/util/logging/MemoryHandler", DoNotGenerateAcw=true)]
public class MemoryHandler : Java.Util.Logging.Handler

[<Android.Runtime.Register("java/util/logging/MemoryHandler", DoNotGenerateAcw=true)>]
type MemoryHandler = class
    inherit Handler

Inheritance

Object

Object

Handler

MemoryHandler

Attributes

RegisterAttribute

Remarks

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: <ul> <li> An incoming LogRecord has a type that is greater than a pre-defined level, the pushLevel. </li> <li> An external class calls the push method explicitly. </li> <li> A subclass overrides the log method and scans each incoming LogRecord and calls push if a record matches some desired criteria. </li> </ul>

<b>Configuration:</b> By default each MemoryHandler is initialized using the following LogManager configuration properties where <handler-name> refers to the fully-qualified class name of the handler. 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. <ul> <li> &lt;handler-name&gt;.level specifies the level for the Handler (defaults to Level.ALL). </li> <li> &lt;handler-name&gt;.filter specifies the name of a Filter class to use (defaults to no Filter). </li> <li> &lt;handler-name&gt;.size defines the buffer size (defaults to 1000). </li> <li> &lt;handler-name&gt;.push defines the pushLevel (defaults to level.SEVERE). </li> <li> &lt;handler-name&gt;.target specifies the name of the target Handler class. (no default). </li> </ul>

For example, the properties for MemoryHandler would be: <ul> <li> java.util.logging.MemoryHandler.level=INFO </li> <li> java.util.logging.MemoryHandler.formatter=java.util.logging.SimpleFormatter </li> </ul>

For a custom handler, e.g. com.foo.MyHandler, the properties would be: <ul> <li> com.foo.MyHandler.level=INFO </li> <li> com.foo.MyHandler.formatter=java.util.logging.SimpleFormatter </li> </ul>

Added in 1.4.

Java documentation for java.util.logging.MemoryHandler.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

MemoryHandler()	Create a MemoryHandler and configure it based on LogManager configuration properties.
MemoryHandler(Handler, Int32, Level)	Create a MemoryHandler.
MemoryHandler(IntPtr, JniHandleOwnership)	A constructor used when creating managed representations of JNI objects; called by the runtime.

Properties

Class	Returns the runtime class of this Object. (Inherited from Object)
Encoding	Return the character encoding for this Handler. -or- Set the character encoding used by this Handler. (Inherited from Handler)
ErrorManager	Retrieves the ErrorManager for this Handler. -or- Define an ErrorManager for this Handler. (Inherited from Handler)
Filter	Get the current Filter for this Handler. -or- Set a Filter to control output on this Handler. (Inherited from Handler)
Formatter	Return the Formatter for this Handler. -or- Set a Formatter. (Inherited from Handler)
Handle	The handle to the underlying Android instance. (Inherited from Object)
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
Level	Get the log level specifying which messages will be logged by this Handler. -or- Set the log level specifying which message levels will be logged by this Handler. (Inherited from Handler)
PeerReference	(Inherited from Object)
PushLevel	Get the pushLevel. -or- Set the pushLevel.
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Methods

Clone()	Creates and returns a copy of this object. (Inherited from Object)
Close()	Close the Handler and free all associated resources.
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
Flush()	Causes a flush on the target Handler.
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
IsLoggable(LogRecord)	Check if this Handler would actually log a given LogRecord. (Inherited from Handler)
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
Publish(LogRecord)	Store a LogRecord in an internal buffer.
Push()	Push any buffered output to the target Handler.
ReportError(String, Exception, Int32)	Protected convenience method to report an error to this Handler's ErrorManager. (Inherited from Handler)
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)