K
- the type of keys in this poolV
- the type of objects held in this poolpublic abstract class BaseKeyedPoolableObjectFactory<K,V> extends Object implements KeyedPoolableObjectFactory<K,V>
KeyedPoolableObjectFactory
.
All operations defined here are essentially no-op's.
KeyedPoolableObjectFactory
Constructor and Description |
---|
BaseKeyedPoolableObjectFactory() |
Modifier and Type | Method and Description |
---|---|
void |
activateObject(K key,
V obj)
Reinitialize an instance to be returned by the pool.
|
void |
destroyObject(K key,
V obj)
Destroy an instance no longer needed by the pool.
|
abstract V |
makeObject(K key)
Create an instance that can be served by the pool.
|
void |
passivateObject(K key,
V obj)
Uninitialize an instance to be returned to the idle object pool.
|
boolean |
validateObject(K key,
V obj)
Ensures that the instance is safe to be returned by the pool.
|
public abstract V makeObject(K key) throws Exception
makeObject
in interface KeyedPoolableObjectFactory<K,V>
key
- the key used when constructing the objectException
- if there is a problem creating a new instance,
this will be propagated to the code requesting an object.public void destroyObject(K key, V obj) throws Exception
The default implementation is a no-op.
destroyObject
in interface KeyedPoolableObjectFactory<K,V>
key
- the key used when selecting the instanceobj
- the instance to be destroyedException
- should be avoided as it may be swallowed by
the pool implementation.KeyedPoolableObjectFactory.validateObject(K, V)
,
KeyedObjectPool.invalidateObject(K, V)
public boolean validateObject(K key, V obj)
The default implementation always returns true
.
validateObject
in interface KeyedPoolableObjectFactory<K,V>
key
- the key used when selecting the objectobj
- the instance to be validatedtrue
in the default implementationpublic void activateObject(K key, V obj) throws Exception
The default implementation is a no-op.
activateObject
in interface KeyedPoolableObjectFactory<K,V>
key
- the key used when selecting the objectobj
- the instance to be activatedException
- if there is a problem activating obj
,
this exception may be swallowed by the pool.KeyedPoolableObjectFactory.destroyObject(K, V)
public void passivateObject(K key, V obj) throws Exception
The default implementation is a no-op.
passivateObject
in interface KeyedPoolableObjectFactory<K,V>
key
- the key used when selecting the objectobj
- the instance to be passivatedException
- if there is a problem passivating obj
,
this exception may be swallowed by the pool.KeyedPoolableObjectFactory.destroyObject(K, V)
Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.