Enum Class Recyclers

java.lang.Object

java.lang.Enum<Recyclers>

org.opensearch.common.recycler.Recyclers

All Implemented Interfaces:

Serializable, Comparable<Recyclers>, Constable

public enum Recyclers
extends Enum<Recyclers>

Utility class of recyclers.

Opensearch.internal:

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Method Summary

Modifier and Type	Method	Description
static <T> Recycler<T>	concurrent(Recycler.Factory<T> factory)
static <T> Recycler<T>	concurrent(Recycler.Factory<T> factory, int concurrencyLevel)	Create a concurrent implementation that can support concurrent access from concurrencyLevel threads with little contention.
static <T> Recycler<T>	concurrentDeque(Recycler.C<T> c, int limit)	Return a concurrent recycler based on a deque.
static <T> Recycler<T>	deque(Recycler.C<T> c, int limit)	Return a recycler based on a deque.
static <T> Recycler.Factory<T>	dequeFactory(Recycler.C<T> c, int limit)	Return a recycler based on a deque.
static <T> Recycler<T>	locked(Recycler<T> recycler)	Wrap the provided recycler so that calls to Recycler.obtain() and Releasable.close() are protected by a lock.
static <T> Recycler<T>	none(Recycler.C<T> c)	Return a Recycler that never recycles entries.
static Recyclers	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Recyclers[]	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

Method Details

values

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

none

public static <T> Recycler<T> none(Recycler.C<T> c)

Return a Recycler that never recycles entries.

concurrentDeque

public static <T> Recycler<T> concurrentDeque(Recycler.C<T> c,
 int limit)

Return a concurrent recycler based on a deque.

deque

public static <T> Recycler<T> deque(Recycler.C<T> c,
 int limit)

Return a recycler based on a deque.

dequeFactory

public static <T> Recycler.Factory<T> dequeFactory(Recycler.C<T> c,
 int limit)

Return a recycler based on a deque.

locked

public static <T> Recycler<T> locked(Recycler<T> recycler)

Wrap the provided recycler so that calls to Recycler.obtain() and Releasable.close() are protected by a lock.

Opensearch.internal:

concurrent

public static <T> Recycler<T> concurrent(Recycler.Factory<T> factory,
 int concurrencyLevel)

Create a concurrent implementation that can support concurrent access from concurrencyLevel threads with little contention.

concurrent

public static <T> Recycler<T> concurrent(Recycler.Factory<T> factory)