private static class PoolUtils.CheckedObjectPool<T> extends java.lang.Object implements ObjectPool<T>
Modifier and Type | Field and Description |
---|---|
private ObjectPool<T> |
pool
Underlying object pool
|
private java.lang.Class<T> |
type
Type of objects allowed in the pool.
|
Constructor and Description |
---|
CheckedObjectPool(ObjectPool<T> pool,
java.lang.Class<T> type)
Create a CheckedObjectPool accepting objects of the given type using
the given pool.
|
Modifier and Type | Method and Description |
---|---|
void |
addObject()
Create an object using the
factory or other
implementation dependent mechanism, passivate it, and then place it in the idle object pool. |
T |
borrowObject()
Borrow an object from the pool, checking its type.
|
void |
clear()
Clears any objects sitting idle in the pool, releasing any
associated resources (optional operation).
|
void |
close()
Close this pool, and free any resources associated with it.
|
int |
getNumActive()
Return the number of instances
currently borrowed from this pool
(optional operation).
|
int |
getNumIdle()
Return the number of instances
currently idle in this pool (optional operation).
|
void |
invalidateObject(T obj)
Invalidates an object from the pool, verifying that it is of the expected type.
|
void |
returnObject(T obj)
Return an object to the pool, verifying that it is of the correct type.
|
void |
setFactory(PoolableObjectFactory<T> factory)
Deprecated.
to be removed in version 2.0
|
java.lang.String |
toString() |
private final java.lang.Class<T> type
private final ObjectPool<T> pool
CheckedObjectPool(ObjectPool<T> pool, java.lang.Class<T> type)
pool
- underlying object pooltype
- expected pooled object typejava.lang.IllegalArgumentException
- if either parameter is nullpublic T borrowObject() throws java.lang.Exception, java.util.NoSuchElementException, java.lang.IllegalStateException
borrowObject
in interface ObjectPool<T>
java.lang.ClassCastException
- if the object returned by the pool is not of the expected typejava.lang.IllegalStateException
- after close
has been called on this pool.java.lang.Exception
- when makeObject
throws an exception.java.util.NoSuchElementException
- when the pool is exhausted and cannot or will not return another instance.public void returnObject(T obj)
returnObject
in interface ObjectPool<T>
obj
- object to returnjava.lang.ClassCastException
- if obj is not of the expected typepublic void invalidateObject(T obj)
invalidateObject
in interface ObjectPool<T>
obj
- object to invalidatejava.lang.ClassCastException
- if obj is not of the expected typepublic void addObject() throws java.lang.Exception, java.lang.IllegalStateException, java.lang.UnsupportedOperationException
factory
or other
implementation dependent mechanism, passivate it, and then place it in the idle object pool.
addObject
is useful for "pre-loading" a pool with idle objects.
(Optional operation).addObject
in interface ObjectPool<T>
java.lang.Exception
- when PoolableObjectFactory.makeObject()
fails.java.lang.IllegalStateException
- after ObjectPool.close()
has been called on this pool.java.lang.UnsupportedOperationException
- when this pool cannot add new idle objects.public int getNumIdle() throws java.lang.UnsupportedOperationException
borrowed
without creating any new instances.
Returns a negative value if this information is not available.getNumIdle
in interface ObjectPool<T>
java.lang.UnsupportedOperationException
- deprecated: if this implementation does not support the operationpublic int getNumActive() throws java.lang.UnsupportedOperationException
getNumActive
in interface ObjectPool<T>
java.lang.UnsupportedOperationException
- deprecated: if this implementation does not support the operationpublic void clear() throws java.lang.Exception, java.lang.UnsupportedOperationException
destroyed
.clear
in interface ObjectPool<T>
java.lang.UnsupportedOperationException
- if this implementation does not support the operationjava.lang.Exception
public void close()
Calling ObjectPool.addObject()
or ObjectPool.borrowObject()
after invoking
this method on a pool will cause them to throw an
IllegalStateException
.
close
in interface ObjectPool<T>
@Deprecated public void setFactory(PoolableObjectFactory<T> factory) throws java.lang.IllegalStateException, java.lang.UnsupportedOperationException
setFactory
in interface ObjectPool<T>
factory
- object factoryjava.lang.IllegalStateException
- when the factory cannot be set at this timejava.lang.UnsupportedOperationException
- if this implementation does not support the operationpublic java.lang.String toString()
toString
in class java.lang.Object