Package com.illumon.iris.db.util.caching.redesign

Enum Class DataBufferPool

java.lang.Object

java.lang.Enum<DataBufferPool>

com.illumon.iris.db.util.caching.redesign.DataBufferPool

All Implemented Interfaces:

ObjectPool<DataBufferHolder>, Serializable, Comparable<DataBufferPool>, java.lang.constant.Constable

public enum DataBufferPool
extends Enum<DataBufferPool>
implements ObjectPool<DataBufferHolder>

Data buffer pool for all Deephaven-format column data.

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
DEFAULT	The data buffer pool used by all Deephaven-format columns.

Method Summary

Modifier and Type	Method	Description
final void	give(PooledObjectReference<DataBufferHolder> itemReference)	Return an item to the pool (permanently).
final PooledObjectReference<DataBufferHolder>	take()	Take an item from the pool.
static DataBufferPool	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DataBufferPool[]	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

DEFAULT

public static final DataBufferPool DEFAULT

The data buffer pool used by all Deephaven-format columns.

Method Details

values

public static DataBufferPool[] 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 DataBufferPool 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

take

@NotNull
public final PooledObjectReference<DataBufferHolder> take()

Description copied from interface: ObjectPool

Take an item from the pool.

Specified by:

take in interface ObjectPool<DataBufferHolder>

Returns:

A reference that encapsulates access to the item, to allow reclamation per the pool implementation's policies.

give

public final void give(@NotNull
 PooledObjectReference<DataBufferHolder> itemReference)

Description copied from interface: ObjectPool

Return an item to the pool (permanently).

Specified by:

give in interface ObjectPool<DataBufferHolder>

Parameters:

itemReference - The reference returns previously by a call to give.