Top Description Fields Constructors Methods
org.apache.commons.pool2

public final Enum PooledObjectState

extends Enum<PooledObjectState>
Class Inheritance

Provides all possible states of a PooledObject.
Since
2.0

Field Summary

Modifier and TypeField 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

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static PooledObjectState
public static PooledObjectState[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ABANDONEDback to summary
public static final PooledObjectState ABANDONED

Deemed abandoned, to be invalidated.

ALLOCATEDback to summary
public static final PooledObjectState ALLOCATED

In use.

EVICTIONback to summary
public static final PooledObjectState EVICTION

In the queue, currently being tested for possible eviction.

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

IDLEback to summary
public static final PooledObjectState IDLE

In the queue, not in use.

INVALIDback to summary
public static final PooledObjectState INVALID

Failed maintenance (e.g. eviction test or validation) and will be / has been destroyed

RETURNINGback to summary
public static final PooledObjectState RETURNING

Returning to the pool.

VALIDATIONback to summary
public static final PooledObjectState VALIDATION

In the queue, currently being validated.

VALIDATION_PREALLOCATEDback 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_HEADback 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

PooledObjectStateback to summary
private PooledObjectState()

Method Detail

valueOfback to summary
public static PooledObjectState valueOf(String name)
valuesback to summary
public static PooledObjectState[] values()