org.spf4j.recyclable

Interface RecyclingSupplier<T>

Type Parameters:

T - - type of recycled objects

All Superinterfaces:

AutoCloseable, BlockingDisposable, Disposable, NonValidatingRecyclingSupplier<T>

All Known Implementing Classes:

SharingObjectPool

@ParametersAreNonnullByDefault
public interface RecyclingSupplier<T>
extends NonValidatingRecyclingSupplier<T>, BlockingDisposable

Object pool interface. My goal is to create a simpler and better object pool interface and implementation.

Author:

zoly

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RecyclingSupplier.Factory<T>

Method Summary

Modifier and Type	Method and Description
default T	get() block until a object is available and return it.
default T	get(long timeout, TimeUnit unit)
default void	recycle(T object) recycle object.
void	recycle(T object, Exception e) return a object previously borrowed from the pool, together with a optional exception in case one was encountered while using the object.
T	tryGet(long deadlineNanos)
default T	tryGet(long timeout, TimeUnit unit)

Methods inherited from interface org.spf4j.recyclable.BlockingDisposable

close, dispose, dispose, tryDispose

Method Detail

get

@Nonnull
default T get()
                throws ObjectCreationException,
                       ObjectBorrowException,
                       InterruptedException,
                       TimeoutException

Description copied from interface: NonValidatingRecyclingSupplier

block until a object is available and return it.

Specified by:

get in interface NonValidatingRecyclingSupplier<T>

Returns:

- a object instance returned by this supplier.

Throws:

ObjectCreationException - - cannot create an object.

ObjectBorrowException - - cannot borrow an object.

InterruptedException - - interrupted.

TimeoutException - - timed out while getting object.

get

@Nonnull
default T get(long timeout,
                       TimeUnit unit)
                throws ObjectCreationException,
                       ObjectBorrowException,
                       InterruptedException,
                       TimeoutException

Throws:

ObjectCreationException

ObjectBorrowException

InterruptedException

TimeoutException

tryGet

@Nullable
default T tryGet(long timeout,
                           TimeUnit unit)
                    throws ObjectCreationException,
                           ObjectBorrowException,
                           InterruptedException

Throws:

ObjectCreationException

ObjectBorrowException

InterruptedException

tryGet

@Nullable
T tryGet(long deadlineNanos)
            throws ObjectCreationException,
                   ObjectBorrowException,
                   InterruptedException

Throws:

ObjectCreationException

ObjectBorrowException

InterruptedException

recycle

void recycle(T object,
             @Nullable
             Exception e)

return a object previously borrowed from the pool, together with a optional exception in case one was encountered while using the object. passing an exception will cause the object to be validated and potentially retired from the pool.

Parameters:

object - - object to recycle.

e - - exception encountered while handling the object. this is useful for the recycle to validate/retire object

recycle

default void recycle(T object)

recycle object.

Specified by:

recycle in interface NonValidatingRecyclingSupplier<T>

Parameters:

object - - object to recycle.