Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/java/util/logging/MemoryHandler#pubctors) \| [Methods](https://developer.android.com/reference/java/util/logging/MemoryHandler#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/java/util/logging/MemoryHandler#inhmethods)

# MemoryHandler


`
public


class
MemoryHandler
`


`


`

`

extends https://developer.android.com/reference/java/util/logging/Handler


`

`


`

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) |||
| ↳ | [java.util.logging.Handler](https://developer.android.com/reference/java/util/logging/Handler) ||
|   | ↳ | java.util.logging.MemoryHandler |

<br />

*** ** * ** ***

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:

- An incoming LogRecord has a type that is greater than a pre-defined level, the pushLevel.
- An external class calls the push method explicitly.
- A subclass overrides the log method and scans each incoming LogRecord and calls push if a record matches some desired criteria.


**Configuration:**
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.

- \<handler-name\>.level specifies the level for the Handler (defaults to Level.ALL).
- \<handler-name\>.filter specifies the name of a Filter class to use (defaults to no Filter).
- \<handler-name\>.size defines the buffer size (defaults to 1000).
- \<handler-name\>.push defines the pushLevel (defaults to level.SEVERE).
- \<handler-name\>.target specifies the name of the target Handler class. (no default).


For example, the properties for `MemoryHandler` would be:

- java.util.logging.MemoryHandler.level=INFO
- java.util.logging.MemoryHandler.formatter=java.util.logging.SimpleFormatter


For a custom handler, e.g. com.foo.MyHandler, the properties would be:

- com.foo.MyHandler.level=INFO
- com.foo.MyHandler.formatter=java.util.logging.SimpleFormatter

<br />

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/java/util/logging/MemoryHandler#MemoryHandler()() ` Create a MemoryHandler and configure it based on LogManager configuration properties. |
| ` https://developer.android.com/reference/java/util/logging/MemoryHandler#MemoryHandler(java.util.logging.Handler,%20int,%20java.util.logging.Level)(https://developer.android.com/reference/java/util/logging/Handler target, int size, https://developer.android.com/reference/java/util/logging/Level pushLevel) ` Create a MemoryHandler. |

| ### Public methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/java/util/logging/MemoryHandler#close()() ` Close the Handler and free all associated resources. |
| ` void` | ` https://developer.android.com/reference/java/util/logging/MemoryHandler#flush()() ` Causes a flush on the target Handler. |
| ` https://developer.android.com/reference/java/util/logging/Level` | ` https://developer.android.com/reference/java/util/logging/MemoryHandler#getPushLevel()() ` Get the pushLevel. |
| ` boolean` | ` https://developer.android.com/reference/java/util/logging/MemoryHandler#isLoggable(java.util.logging.LogRecord)(https://developer.android.com/reference/java/util/logging/LogRecord record) ` Check if this Handler would actually log a given LogRecord into its internal buffer. |
| ` void` | ` https://developer.android.com/reference/java/util/logging/MemoryHandler#publish(java.util.logging.LogRecord)(https://developer.android.com/reference/java/util/logging/LogRecord record) ` Store a LogRecord in an internal buffer. |
| ` void` | ` https://developer.android.com/reference/java/util/logging/MemoryHandler#push()() ` Push any buffered output to the target Handler. |
| ` void` | ` https://developer.android.com/reference/java/util/logging/MemoryHandler#setPushLevel(java.util.logging.Level)(https://developer.android.com/reference/java/util/logging/Level newLevel) ` Set the pushLevel. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/util/logging/Handler ` |---|---| | ` abstract void` | ` https://developer.android.com/reference/java/util/logging/Handler#close()() ` Close the Handler and free all associated resources. | | ` abstract void` | ` https://developer.android.com/reference/java/util/logging/Handler#flush()() ` Flush any buffered output. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/util/logging/Handler#getEncoding()() ` Return the character encoding for this Handler. | | ` https://developer.android.com/reference/java/util/logging/ErrorManager` | ` https://developer.android.com/reference/java/util/logging/Handler#getErrorManager()() ` Retrieves the ErrorManager for this Handler. | | ` https://developer.android.com/reference/java/util/logging/Filter` | ` https://developer.android.com/reference/java/util/logging/Handler#getFilter()() ` Get the current Filter for this Handler. | | ` https://developer.android.com/reference/java/util/logging/Formatter` | ` https://developer.android.com/reference/java/util/logging/Handler#getFormatter()() ` Return the Formatter for this Handler. | | ` https://developer.android.com/reference/java/util/logging/Level` | ` https://developer.android.com/reference/java/util/logging/Handler#getLevel()() ` Get the log level specifying which messages will be logged by this Handler. | | ` boolean` | ` https://developer.android.com/reference/java/util/logging/Handler#isLoggable(java.util.logging.LogRecord)(https://developer.android.com/reference/java/util/logging/LogRecord record) ` Check if this Handler would actually log a given LogRecord. | | ` abstract void` | ` https://developer.android.com/reference/java/util/logging/Handler#publish(java.util.logging.LogRecord)(https://developer.android.com/reference/java/util/logging/LogRecord record) ` Publish a LogRecord. | | ` void` | ` https://developer.android.com/reference/java/util/logging/Handler#reportError(java.lang.String,%20java.lang.Exception,%20int)(https://developer.android.com/reference/java/lang/String msg, https://developer.android.com/reference/java/lang/Exception ex, int code) ` Protected convenience method to report an error to this Handler's ErrorManager. | | ` void` | ` https://developer.android.com/reference/java/util/logging/Handler#setEncoding(java.lang.String)(https://developer.android.com/reference/java/lang/String encoding) ` Set the character encoding used by this Handler. | | ` void` | ` https://developer.android.com/reference/java/util/logging/Handler#setErrorManager(java.util.logging.ErrorManager)(https://developer.android.com/reference/java/util/logging/ErrorManager em) ` Define an ErrorManager for this Handler. | | ` void` | ` https://developer.android.com/reference/java/util/logging/Handler#setFilter(java.util.logging.Filter)(https://developer.android.com/reference/java/util/logging/Filter newFilter) ` Set a Filter to control output on this Handler. | | ` void` | ` https://developer.android.com/reference/java/util/logging/Handler#setFormatter(java.util.logging.Formatter)(https://developer.android.com/reference/java/util/logging/Formatter newFormatter) ` Set a Formatter. | | ` void` | ` https://developer.android.com/reference/java/util/logging/Handler#setLevel(java.util.logging.Level)(https://developer.android.com/reference/java/util/logging/Level newLevel) ` Set the log level specifying which message levels will be logged by this Handler. | ||
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||

## Public constructors

### MemoryHandler

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public MemoryHandler ()
```

Create a MemoryHandler and configure it based on
LogManager configuration properties.

<br />

### MemoryHandler

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.

<br />

| Parameters ||
|---|---|
| `target` | `Handler`: the Handler to which to publish output. <br /> |
| `size` | `int`: the number of log records to buffer (must be greater than zero) <br /> |
| `pushLevel` | `Level`: message level to push on <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if `size is <= 0` |

## Public methods

### close

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void close ()
```

Close the Handler and free all associated resources.
This will also close the target Handler.

<br />

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/SecurityException` | if a security manager exists and if the caller does not have LoggingPermission("control"). |

### flush

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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".

<br />

### getPushLevel

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Level getPushLevel ()
```

Get the pushLevel.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/logging/Level` | the value of the pushLevel <br /> |

### isLoggable

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.

<br />

<br />

| Parameters ||
|---|---|
| `record` | `LogRecord`: a LogRecord <br /> |

| Returns ||
|---|---|
| `boolean` | true if the LogRecord would be logged. <br /> |

### publish

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public 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.

<br />

| Parameters ||
|---|---|
| `record` | `LogRecord`: description of the log event. A null record is silently ignored and is not published <br /> |

### push

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void push ()
```

Push any buffered output to the target Handler.


The buffer is then cleared.

<br />

### setPushLevel

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void setPushLevel (Level newLevel)
```

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.

<br />

| Parameters ||
|---|---|
| `newLevel` | `Level`: the new value of the pushLevel <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/SecurityException` | if a security manager exists and if the caller does not have LoggingPermission("control"). |