org.jvoicexml.implementation.pool

Class KeyedResourcePool<T extends ExternalResource>

java.lang.Object

org.jvoicexml.implementation.pool.KeyedResourcePool<T>

Type Parameters:

T - Type of ExternalResource to produce in this factory.

public final class KeyedResourcePool<T extends ExternalResource>
extends java.lang.Object

Pool to hold all instantiated resources of type T.

The KeyedResourcePool uses a ResourceFactory to create new objects for the pool until the number of instances is exceeded that is set by the factory.

Since:

0.5.1

Constructor Summary

Constructors

Constructor and Description
KeyedResourcePool() Constructs a new object.

Method Summary

Modifier and Type	Method and Description
void	addResourceFactory(ResourceFactory<T> resourceFactory) Adds the given resource factory.
T	borrowObject(java.lang.Object key) Type safe return of the object to borrow from the pool.
void	close() Closes all pools for all keys.
java.util.Collection<java.lang.String>	getKeys() Retrieves the available keys of this pool.
int	getNumActive() Retrieves the number of active resources in all pools.
int	getNumActive(java.lang.String key) Retrieves the number of active resources in the pool for the given key.
int	getNumIdle() Retrieves the number of idle resources in all pools.
int	getNumIdle(java.lang.String key) Retrieves the number of idle resources in the pool for the given key.
void	returnObject(java.lang.String key, T resource) Returns a previously borrowed resource to the pool.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyedResourcePool

public KeyedResourcePool()

Constructs a new object.

Method Detail

addResourceFactory

public void addResourceFactory(ResourceFactory<T> resourceFactory)
                        throws java.lang.Exception

Adds the given resource factory.

Parameters:

resourceFactory - The ResourceFactory to add.

Throws:

java.lang.Exception - error populating the pool

borrowObject

public T borrowObject(java.lang.Object key)
               throws NoresourceError

Type safe return of the object to borrow from the pool.

Parameters:

key - the type of the object to borrow from the pool

Returns:

borrowed object

Throws:

NoresourceError - the object could not be borrowed

returnObject

public void returnObject(java.lang.String key,
                         T resource)
                  throws NoresourceError

Returns a previously borrowed resource to the pool.

Parameters:

key - resource type.

resource - resource to return.

Throws:

NoresourceError - Error returning the object to the pool.

Since:

0.6

getNumActive

public int getNumActive()

Retrieves the number of active resources in all pools.

Returns:

number of active resources

Since:

0.7.3

getNumActive

public int getNumActive(java.lang.String key)

Retrieves the number of active resources in the pool for the given key.

Parameters:

key - the key

Returns:

number of active resources

Since:

0.7.3

getNumIdle

public int getNumIdle()

Retrieves the number of idle resources in all pools.

Returns:

number of idle resources

Since:

0.7.3

getNumIdle

public int getNumIdle(java.lang.String key)

Retrieves the number of idle resources in the pool for the given key.

Parameters:

key - the key

Returns:

number of idle resources, -1 if there is no resource with that key

Since:

0.7.3

getKeys

public java.util.Collection<java.lang.String> getKeys()

Retrieves the available keys of this pool.

Returns:

available keys.

Since:

0.7.4

close

public void close()
           throws java.lang.Exception

Closes all pools for all keys.

Throws:

java.lang.Exception - error closing a pool

Since:

0.7.3