Package org.apache.bookkeeper.common.allocator

Enum Class OutOfMemoryPolicy

java.lang.Object

java.lang.Enum<OutOfMemoryPolicy>

org.apache.bookkeeper.common.allocator.OutOfMemoryPolicy

All Implemented Interfaces:

Serializable, Comparable<OutOfMemoryPolicy>, Constable

public enum OutOfMemoryPolicy
extends Enum<OutOfMemoryPolicy>

Represents the action to take when it's not possible to allocate memory.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FallbackToHeap	If it's not possible to allocate a buffer from direct memory, fallback to allocate an unpooled buffer from JVM heap.
ThrowException	Throw regular OOM exception without taking addition actions.

Method Summary

Modifier and Type	Method	Description
static OutOfMemoryPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OutOfMemoryPolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ThrowException

public static final OutOfMemoryPolicy ThrowException

Throw regular OOM exception without taking addition actions.

FallbackToHeap

public static final OutOfMemoryPolicy FallbackToHeap

If it's not possible to allocate a buffer from direct memory, fallback to allocate an unpooled buffer from JVM heap.

This will help absorb memory allocation spikes because the heap allocations will naturally slow down the process and will result if full GC cleanup if the Heap itself is full.

Method Details

values

public static OutOfMemoryPolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static OutOfMemoryPolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null