Top Description Fields Constructors Methods

org.apache.commons.pool2

public final Enum PooledObjectState

Class Inheritance

extends Enum<PooledObjectState>

java.lang.Object
java.lang.Enum
org.apache.commons.pool2.PooledObjectState

Provides all possible states of a PooledObject.

Since: 2.0

Field Summary

Modifier and Type	Field and Description
public static final PooledObjectState	ABANDONED Deemed abandoned, to be invalidated.
public static final PooledObjectState	ALLOCATED In use.
public static final PooledObjectState	EVICTION In the queue, currently being tested for possible eviction.
public static final PooledObjectState	EVICTION_RETURN_TO_HEAD Not in the queue, currently being tested for possible eviction.
public static final PooledObjectState	IDLE In the queue, not in use.
public static final PooledObjectState	INVALID Failed maintenance (e.g. eviction test or validation) and will be / has been destroyed
public static final PooledObjectState	RETURNING Returning to the pool.
public static final PooledObjectState	VALIDATION In the queue, currently being validated.
public static final PooledObjectState	VALIDATION_PREALLOCATED Not in queue, currently being validated.
public static final PooledObjectState	VALIDATION_RETURN_TO_HEAD Not in queue, currently being validated.

Constructor Summary

Access	Constructor and Description
private	PooledObjectState()

Method Summary

Modifier and Type	Method and Description
public static PooledObjectState	valueOf(String name)
public static PooledObjectState[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ABANDONED	back to summary
public static final PooledObjectState ABANDONED Deemed abandoned, to be invalidated.

ALLOCATED	back to summary
public static final PooledObjectState ALLOCATED In use.

EVICTION	back to summary
public static final PooledObjectState EVICTION In the queue, currently being tested for possible eviction.

EVICTION_RETURN_TO_HEAD	back to summary
public static final PooledObjectState EVICTION_RETURN_TO_HEAD Not in the queue, currently being tested for possible eviction. An attempt to borrow the object was made while being tested which removed it from the queue. It should be returned to the head of the queue once eviction testing completes. Todo Consider allocating object and ignoring the result of the eviction test.

IDLE	back to summary
public static final PooledObjectState IDLE In the queue, not in use.

INVALID	back to summary
public static final PooledObjectState INVALID Failed maintenance (e.g. eviction test or validation) and will be / has been destroyed

RETURNING	back to summary
public static final PooledObjectState RETURNING Returning to the pool.

VALIDATION	back to summary
public static final PooledObjectState VALIDATION In the queue, currently being validated.

VALIDATION_PREALLOCATED	back to summary
public static final PooledObjectState VALIDATION_PREALLOCATED Not in queue, currently being validated. The object was borrowed while being validated and since testOnBorrow was configured, it was removed from the queue and pre-allocated. It should be allocated once validation completes.

VALIDATION_RETURN_TO_HEAD	back to summary
public static final PooledObjectState VALIDATION_RETURN_TO_HEAD Not in queue, currently being validated. An attempt to borrow the object was made while previously being tested for eviction which removed it from the queue. It should be returned to the head of the queue once validation completes.

Constructor Detail

PooledObjectState	back to summary
private PooledObjectState()

Method Detail

valueOf	back to summary
public static PooledObjectState valueOf(String name)

values	back to summary
public static PooledObjectState[] values()