org.spf4j.recyclable.impl

Class SharingObjectPool<T>

java.lang.Object

org.spf4j.recyclable.impl.SharingObjectPool<T>

All Implemented Interfaces:

AutoCloseable, BlockingDisposable, Disposable, NonValidatingRecyclingSupplier<T>, RecyclingSupplier<T>

public final class SharingObjectPool<T>
extends Object
implements RecyclingSupplier<T>

a object sharing pool. this pool allows for non exclusive object sharing. will always return the least shared object. TODO: synchronization is too coarse, can be improved.

Author:

zoly

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SharingObjectPool.SharedObject<T>

Nested classes/interfaces inherited from interface org.spf4j.recyclable.RecyclingSupplier

RecyclingSupplier.Factory<T>

Constructor Summary

Constructors

Constructor and Description
SharingObjectPool(RecyclingSupplier.Factory<T> factory, int coreSize, int maxSize)
SharingObjectPool(RecyclingSupplier.Factory<T> factory, int coreSize, int maxSize, boolean asyncValidate)

Method Summary

Modifier and Type	Method and Description
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.
String	toString()
boolean	tryDispose(long timeoutMillis)
T	tryGet(long deadlineNanos)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.spf4j.recyclable.RecyclingSupplier

get, get, tryGet

Methods inherited from interface org.spf4j.recyclable.BlockingDisposable

close, dispose, dispose

Constructor Detail

SharingObjectPool

public SharingObjectPool(RecyclingSupplier.Factory<T> factory,
                         int coreSize,
                         int maxSize)
                  throws ObjectCreationException

Throws:

ObjectCreationException

SharingObjectPool

public SharingObjectPool(RecyclingSupplier.Factory<T> factory,
                         int coreSize,
                         int maxSize,
                         boolean asyncValidate)
                  throws ObjectCreationException

Throws:

ObjectCreationException

Method Detail

tryGet

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

Specified by:

tryGet in interface RecyclingSupplier<T>

Throws:

ObjectBorrowException

ObjectCreationException

recycle

public void recycle(T object,
                    Exception e)

Description copied from interface: RecyclingSupplier

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.

Specified by:

recycle in interface RecyclingSupplier<T>

Parameters:

object - - object to recycle.

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

recycle

public void recycle(T object)

Description copied from interface: RecyclingSupplier

recycle object.

Specified by:

recycle in interface NonValidatingRecyclingSupplier<T>

Specified by:

recycle in interface RecyclingSupplier<T>

Parameters:

object - - object to recycle.

tryDispose

public boolean tryDispose(long timeoutMillis)
                   throws ObjectDisposeException,
                          InterruptedException

Specified by:

tryDispose in interface BlockingDisposable

Throws:

ObjectDisposeException

InterruptedException

toString

public String toString()

Overrides:

toString in class Object