org.bbottema.genericobjectpool

Class GenericObjectPool<T>

java.lang.Object

org.bbottema.genericobjectpool.GenericObjectPool<T>

public class GenericObjectPool<T>
extends Object

Constructor Summary

Constructors

Constructor and Description
GenericObjectPool(PoolConfig<T> poolConfig, @NotNull Allocator<T> allocator)

Method Summary

Modifier and Type	Method and Description
@NotNull PoolableObject<T>	claim() Delegates to claim(Timeout) with unlimited timeout.
@Nullable PoolableObject<T>	claim(long timeout, TimeUnit timeUnit) Delegates to claim(Timeout).
@Nullable PoolableObject<T>	claim(Timeout timeout) Will claim available object, create a new one if there is room to grow the pool, or else wait until either become true.
int	getCurrentlyAllocated() Gets the allocation size.
@NotNull PoolMetrics	getPoolMetrics()
Future<Void>	shutdown() Shuts down the current Pool stopping new allocations and triggering deallocations on all other available objects.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenericObjectPool

public GenericObjectPool(PoolConfig<T> poolConfig,
                         @NotNull
                         @NotNull Allocator<T> allocator)

Method Detail

claim

@NotNull
public @NotNull PoolableObject<T> claim()
                                          throws InterruptedException

Delegates to claim(Timeout) with unlimited timeout.

Throws:

InterruptedException

claim

@Nullable
public @Nullable PoolableObject<T> claim(long timeout,
                                                   TimeUnit timeUnit)
                                            throws InterruptedException

Delegates to claim(Timeout).

Throws:

InterruptedException

claim

@Nullable
public @Nullable PoolableObject<T> claim(Timeout timeout)
                                            throws InterruptedException,
                                                   IllegalStateException

Will claim available object, create a new one if there is room to grow the pool, or else wait until either become true.

Throws:

IllegalStateException - if you try a new claim while the pool is shut down

InterruptedException - if the pool was waiting and the pool shut down in the mean time

shutdown

public Future<Void> shutdown()

Shuts down the current Pool stopping new allocations and triggering deallocations on all other available objects. Waits for claimed objects to become available.

getCurrentlyAllocated

public int getCurrentlyAllocated()

Gets the allocation size.

Returns:

the allocation size

getPoolMetrics

@NotNull
public @NotNull PoolMetrics getPoolMetrics()

See Also:

PoolMetrics