A B C D E G H I L M P Q R S T V

A

allocate(Slot) - Method in interface stormpot.Allocator

Create a fresh new instance of T for the given slot.

Allocator<T extends Poolable> - Interface in stormpot

An Allocator is responsible for the creation and destruction of Poolable objects.

await(Timeout) - Method in interface stormpot.Completion

Causes the current thread to wait until the completion is finished, or the thread is interrupted, or the specified waiting time elapses.

B

BlazePool<T extends Poolable> - Class in stormpot

BlazePool is a highly optimised LifecycledResizablePool implementation that consists of a queues of Poolable instances, the access to which is made faster with clever use of ThreadLocals.

BlazePool(Config<T>) - Constructor for class stormpot.BlazePool

Construct a new BlazePool instance based on the given Config.

BlazePool<T extends Poolable> - Class in stormpot.bpool

Deprecated.

This class has been moved to the stormpot package.

BlazePool(Config<T>) - Constructor for class stormpot.bpool.BlazePool

Deprecated.

Construct a new BlazePool instance based on the given Config.

C

claim(Timeout) - Method in class stormpot.BlazePool

claim(Timeout) - Method in interface stormpot.Pool

Claim the exclusive rights until released, to an object in the pool.

claim(Timeout) - Method in class stormpot.QueuePool

clone() - Method in class stormpot.Config

Returns a shallow copy of this Config object.

Completion - Interface in stormpot

A Completion represents some task that is going to be completed at some point in the future, or maybe already has completed.

CompoundExpiration<T extends Poolable> - Class in stormpot

Provides a way to compose Expirations.

CompoundExpiration(Expiration<T>, Expiration<T>) - Constructor for class stormpot.CompoundExpiration

Config<T extends Poolable> - Class in stormpot

The basic configuration "bean" class.

Config() - Constructor for class stormpot.Config

Build a new empty Config object.

D

deallocate(T) - Method in interface stormpot.Allocator

Deallocate, if applicable, the given Poolable and free any resources associated with it.

E

equals(Object) - Method in class stormpot.Timeout

Timeouts of equivalent duration are equal, even if they were constructed with different units.

Expiration<T extends Poolable> - Interface in stormpot

The expiration is used to determine if a given slot has expired, or otherwise become invalid.

expire(Poolable) - Method in interface stormpot.Slot

Mark the object represented by this slot as expired.

G

getAgeMillis() - Method in interface stormpot.SlotInfo

Get the approximate number of milliseconds that have transpired since the object was allocated.

getAllocationCount() - Method in class stormpot.BlazePool

getAllocationCount() - Method in interface stormpot.ManagedPool

Return the number of objects the pool has allocated since it was created.

getAllocationCount() - Method in class stormpot.QueuePool

getAllocationFailureLatencyPercentile(double) - Method in class stormpot.BlazePool

getAllocationFailureLatencyPercentile(double) - Method in interface stormpot.ManagedPool

getAllocationFailureLatencyPercentile(double) - Method in interface stormpot.MetricsRecorder

Get the approximate latency value, in milliseconds, for failed allocation latencies within the given percentile/quantile of what has been recorded so far.

getAllocationFailureLatencyPercentile(double) - Method in class stormpot.QueuePool

getAllocationLatencyPercentile(double) - Method in class stormpot.BlazePool

getAllocationLatencyPercentile(double) - Method in interface stormpot.ManagedPool

getAllocationLatencyPercentile(double) - Method in interface stormpot.MetricsRecorder

Get the approximate Poolable object allocation latency value, in milliseconds, of the given percentile/quantile of the values recorded so far.

getAllocationLatencyPercentile(double) - Method in class stormpot.QueuePool

getAllocator() - Method in class stormpot.Config

Get the configured Allocator instance.

getBaseUnit() - Method in class stormpot.Timeout

Get the unit of precision for the underlying clock, that is used by Timeout.getDeadline() and Timeout.getTimeLeft(long).

getClaimCount() - Method in interface stormpot.SlotInfo

Get the number of times the object has been claimed since it was allocated.

getDeadline() - Method in class stormpot.Timeout

Calculate a deadline, as an instant in the future, in terms of the base unit.

getDeallocationLatencyPercentile(double) - Method in class stormpot.BlazePool

getDeallocationLatencyPercentile(double) - Method in interface stormpot.ManagedPool

getDeallocationLatencyPercentile(double) - Method in interface stormpot.MetricsRecorder

Get the approximate latency value, in milliseconds, for deallocation latencies within the given percentile/quantile of what has been recorded so far.

getDeallocationLatencyPercentile(double) - Method in class stormpot.QueuePool

getExpiration() - Method in class stormpot.Config

Get the configured Expiration instance.

getFailedAllocationCount() - Method in class stormpot.BlazePool

getFailedAllocationCount() - Method in interface stormpot.ManagedPool

Return the number of allocations that has failed, either because the allocator threw an exception or because it returned null, since the pool was created.

getFailedAllocationCount() - Method in class stormpot.QueuePool

getLeakedObjectsCount() - Method in class stormpot.BlazePool

getLeakedObjectsCount() - Method in interface stormpot.ManagedPool

If the pool is capable of precise object leak detection, this method will return the number of object leaks that have been detected, and prevented, since the pool was created.

getLeakedObjectsCount() - Method in class stormpot.QueuePool

getMetricsRecorder() - Method in class stormpot.Config

Get the configured MetricsRecorder instance, or null if none has been configured.

getObjectLifetimePercentile(double) - Method in class stormpot.BlazePool

getObjectLifetimePercentile(double) - Method in interface stormpot.ManagedPool

getObjectLifetimePercentile(double) - Method in interface stormpot.MetricsRecorder

Get the approximate object lifetime, in milliseconds, for the given percentile/quantile.

getObjectLifetimePercentile(double) - Method in class stormpot.QueuePool

getPoolable() - Method in interface stormpot.SlotInfo

Get the Poolable object represented by this SlotInfo instance.

getReallocationFailureLatencyPercentile(double) - Method in class stormpot.BlazePool

getReallocationFailureLatencyPercentile(double) - Method in interface stormpot.ManagedPool

getReallocationFailureLatencyPercentile(double) - Method in class stormpot.QueuePool

getReallocationFailurePercentile(double) - Method in interface stormpot.MetricsRecorder

Get the approximate latency value, in milliseconds, for failed reallocation latencies within the given percentile/quantile of what has been recorded so far.

getReallocationLatencyPercentile(double) - Method in class stormpot.BlazePool

getReallocationLatencyPercentile(double) - Method in interface stormpot.ManagedPool

getReallocationLatencyPercentile(double) - Method in interface stormpot.MetricsRecorder

Get the approximate latency value, in milliseconds, for reallocation latencies within the given percentile/quantile of what has been recorded so far.

getReallocationLatencyPercentile(double) - Method in class stormpot.QueuePool

getReallocator() - Method in class stormpot.Config

Get the configured Allocator instance as a Reallocator.

getSize() - Method in class stormpot.Config

Get the currently configured size.

getStamp() - Method in interface stormpot.SlotInfo

Get the stamp value that has been set on this SlotInfo, or 0 if none has been set since the Poolable was allocated.

getTargetSize() - Method in class stormpot.BlazePool

getTargetSize() - Method in interface stormpot.ManagedPool

getTargetSize() - Method in class stormpot.QueuePool

getTargetSize() - Method in interface stormpot.ResizablePool

Get the currently configured target size of the pool.

getThreadFactory() - Method in class stormpot.Config

Get the ThreadFactory that has been configured, and will be used to create the background allocation threads for the pools.

getTimeLeft(long) - Method in class stormpot.Timeout

Calculate the amount of time that is left until the deadline, in terms of the base unit.

getTimeout() - Method in class stormpot.Timeout

Get the timeout value in terms of the unit.

getTimeoutInBaseUnit() - Method in class stormpot.Timeout

Get the timeout value in terms of the base unit.

getUnit() - Method in class stormpot.Timeout

Get the unit for the timeout value.

H

hasExpired(SlotInfo<? extends T>) - Method in class stormpot.CompoundExpiration

Returns true if any of the given Expiration has expired.

hasExpired(SlotInfo<? extends T>) - Method in interface stormpot.Expiration

Test whether the Slot and Poolable object, represented by the given SlotInfo object, is still valid, or if the pool should deallocate it and allocate a replacement.

hasExpired(SlotInfo<? extends T>) - Method in class stormpot.TimeExpiration

Returns true if the Poolable represented by the given SlotInfo is older than the maximum age permitted by this TimeExpiration.

hasExpired(SlotInfo<? extends T>) - Method in class stormpot.TimeSpreadExpiration

Returns true, with uniformly increasing probability, if the Poolable represented by the given SlotInfo is older than the lower bound, eventually returning true with 100% certainty when the age of the Poolable is equal to or greater than the upper bound.

hashCode() - Method in class stormpot.Timeout

I

isBackgroundExpirationEnabled() - Method in class stormpot.Config

Return whether or not background expiration is enabled, which it is not by default.

isPreciseLeakDetectionEnabled() - Method in class stormpot.Config

Return whether or not precise object leak detection is enabled, which is the case by default.

isShutDown() - Method in class stormpot.BlazePool

isShutDown() - Method in interface stormpot.ManagedPool

Returns 'true' if the shut down process has been started on this pool, 'false' otherwise.

isShutDown() - Method in class stormpot.QueuePool

L

LifecycledPool<T extends Poolable> - Interface in stormpot

A LifecycledPool is a Pool that can be shut down to release any internal resources it might be holding on to.

LifecycledResizablePool<T extends Poolable> - Interface in stormpot

An interface for Pools that are both life-cycled and resizable.

M

ManagedPool - Interface in stormpot

This is the JMX management interface for Stormpot object pools.

MetricsRecorder - Interface in stormpot

A MetricsRecorder implementation supplies the pool with the ability to record and report operational metrics.

P

Pool<T extends Poolable> - Interface in stormpot

A Pool is a self-renewable set of objects from which one can claim exclusive access to elements, until they are released back into the pool.

Poolable - Interface in stormpot

Objects contained in a Pool must implement the Poolable interface and adhere to its contract.

PoolException - Exception in stormpot

The PoolException may be thrown by a pool implementation in a number of circumstances:

PoolException(String) - Constructor for exception stormpot.PoolException

Construct a new PoolException with the given message.

PoolException(String, Throwable) - Constructor for exception stormpot.PoolException

Construct a new PoolException with the given message and cause.

Q

QueuePool<T extends Poolable> - Class in stormpot.qpool

Deprecated.

This class has been moved to the stormpot package.

QueuePool(Config<T>) - Constructor for class stormpot.qpool.QueuePool

Deprecated.

Construct a new QueuePool instance based on the given Config.

QueuePool<T extends Poolable> - Class in stormpot

QueuePool is a fairly simple LifecycledResizablePool implementation that basically consists of a queue of Poolable instances, and a Thread to allocate them.

QueuePool(Config<T>) - Constructor for class stormpot.QueuePool

Construct a new QueuePool instance based on the given Config.

R

randomInt() - Method in interface stormpot.SlotInfo

Produce a random int number.

reallocate(Slot, T) - Method in interface stormpot.Reallocator

Possibly reallocate the given instance of T for the given slot, and return it if the reallocation was successful, or a fresh replacement if the instance could not be reallocated.

Reallocator<T extends Poolable> - Interface in stormpot

Reallocators are a special kind of Allocator that can reallocate Poolables that have expired.

recordAllocationFailureLatencySampleMillis(long) - Method in interface stormpot.MetricsRecorder

Record a latency sample of a failed allocation, in milliseconds.

recordAllocationLatencySampleMillis(long) - Method in interface stormpot.MetricsRecorder

Record a latency sample of a successful allocation, in milliseconds.

recordDeallocationLatencySampleMillis(long) - Method in interface stormpot.MetricsRecorder

Record a latency sample of a deallocation, in milliseconds.

recordObjectLifetimeSampleMillis(long) - Method in interface stormpot.MetricsRecorder

Record an object lifetime sample, in milliseconds.

recordReallocationFailureLatencySampleMillis(long) - Method in interface stormpot.MetricsRecorder

Record a latency sample of a failed reallocation, in milliseconds.

recordReallocationLatencySampleMillis(long) - Method in interface stormpot.MetricsRecorder

Record a latency sample of a successful reallocation, in milliseconds.

release() - Method in interface stormpot.Poolable

Release this Poolable object back into the pool from where it came, so that others can claim it, or the pool deallocate it if it has expired.

release(Poolable) - Method in interface stormpot.Slot

Signal to the pool that the currently claimed object in this slot has been released.

ResizablePool<T extends Poolable> - Interface in stormpot

ResizablePools are pools that can change their size after they have been created.

S

setAllocator(Allocator<X>) - Method in class stormpot.Config

Set the Allocator or Reallocator to use for the pools we want to configure.

setBackgroundExpirationEnabled(boolean) - Method in class stormpot.Config

Enable or disable background object expiration checking.

setExpiration(Expiration<? super T>) - Method in class stormpot.Config

Set the Expiration to use for the pools we want to configure.

setMetricsRecorder(MetricsRecorder) - Method in class stormpot.Config

Set the MetricsRecorder to use for the pools we want to configure.

setPreciseLeakDetectionEnabled(boolean) - Method in class stormpot.Config

Enable or disable precise object leak detection.

setSize(int) - Method in class stormpot.Config

Set the size of the pools we want to configure them with.

setStamp(long) - Method in interface stormpot.SlotInfo

Set the stamp value on this SlotInfo.

setTargetSize(int) - Method in class stormpot.BlazePool

setTargetSize(int) - Method in interface stormpot.ManagedPool

setTargetSize(int) - Method in class stormpot.QueuePool

setTargetSize(int) - Method in interface stormpot.ResizablePool

Set the target size for this pool.

setThreadFactory(ThreadFactory) - Method in class stormpot.Config

Set the ThreadFactory that the pools will use to create its background threads with.

shutdown() - Method in class stormpot.BlazePool

shutdown() - Method in interface stormpot.LifecycledPool

Initiate the shut down process on this pool, and return a Completion instance representing the shut down procedure.

shutdown() - Method in class stormpot.QueuePool

Slot - Interface in stormpot

A Slot represents a location in a Pool where objects can be allocated into, so that they can be claimed and released.

SlotInfo<T extends Poolable> - Interface in stormpot

An informative little interface, used by Expiration instances to determine if a slot has expired or is still invalid for claiming.

stormpot - package stormpot

Stormpot

stormpot.bpool - package stormpot.bpool

stormpot.qpool - package stormpot.qpool

T

TimeExpiration<T extends Poolable> - Class in stormpot

This is a time based Expiration.

TimeExpiration(long, TimeUnit) - Constructor for class stormpot.TimeExpiration

Construct a new Expiration that will invalidate objects that are older than the provided span of time in the given unit.

Timeout - Class in stormpot

A Timeout represents the maximum amount of time a caller is willing to wait for a blocking operation to complete.

Timeout(long, TimeUnit) - Constructor for class stormpot.Timeout

Construct a new timeout with the given value and unit.

TimeSpreadExpiration<T extends Poolable> - Class in stormpot

This is the standard time based Expiration.

TimeSpreadExpiration(long, long, TimeUnit) - Constructor for class stormpot.TimeSpreadExpiration

Construct a new Expiration that will invalidate objects that are older than the given lower bound, before they get older than the upper bound, in the given time unit.

toString() - Method in class stormpot.TimeExpiration

toString() - Method in class stormpot.TimeSpreadExpiration

Produces a String representation of this TimeSpreadExpiration.

V

validate() - Method in class stormpot.Config

Deprecated.

This method will be removed in version 3.0. No alternative is provided, because it is really an internal API.

A B C D E G H I L M P Q R S T V