org.refcodes.factory.impls

Class AbstractRecyclableTypeFactory<T>

java.lang.Object

org.refcodes.factory.impls.AbstractRecyclableTypeFactory<T>

Type Parameters:

T - The type of the instances being served by the factory.

All Implemented Interfaces:

org.refcodes.collection.Clearable, RecyclableTypeFactory<T>, TypeFactory<T>, TypeRecyclable<T>

public abstract class AbstractRecyclableTypeFactory<T>
extends Object
implements RecyclableTypeFactory<T>

The AbstractRecyclableTypeFactory is an abstract implementation of the RecyclableTypeFactory taking care on recycling and reusing instances.

In case you want to support configuration of a recyclable instance with Properties via the toInstance(Properties) method, make sure your recyclable instances provide some method for reconfiguring your instances with the provided Properties.

Implement the Configurable interface with the context being of type Properties, so that your recyclable instances are re-configured via the Configurable.initialize(Object) method; this is the default behavior of the toInstance(Properties) implementation when serving recycled instances. Override that method in case you take care yourself on configuration of a reusable instance.

CAUTION: The recyclable instances provided are stored in a WeakHashMap using WeakReferences in order to prevent filling up of the recyclable objects which could cause a memory leak.

Also a given maximum of recycled instances to be contained in this factory can be configured. In case the max number of recycled instances being managed is reached, then calls to recycleInstance(Object) will be ignored, meaning that no more instances will be internally be stored. This measure can be used in addition to the weak collection we use for this Implementation.

Constructor Summary

Constructors

Constructor and Description
AbstractRecyclableTypeFactory() Default constructor creating a AbstractRecyclableTypeFactory.
AbstractRecyclableTypeFactory(int aMaxRecycledInstanceNumber) Constructor creating a AbstractRecyclableTypeFactory which allows only a given maximum of recycled instances to be contained in this factory.

Method Summary

Modifier and Type	Method and Description
void	clear()
int	getInstanceCount() Returns the number of recycled instances currently being managed by the AbstractRecyclableTypeFactory.
protected abstract T	newInstance() To be implemented by you, called by toInstance() in case there are no more recycled objects available (provided via recycleInstance(Object)). ------------------------------------------------------------------------- This method creates / retrieves an instance of the given type with the given identifier (name) constructed as defined in one to many configuration files.
protected abstract T	newInstance(Properties aProperties) To be implemented by you, called by toInstance(Properties) in case there are no more recycled objects available (provided via recycleInstance(Object)). ------------------------------------------------------------------------- This method creates / retrieves an instance of the given type with the given identifier (name) constructed as defined in one to many configuration files.
void	recycleInstance(T aInstance) Makes the provided instance available for reuse by the factory.
T	toInstance() This method creates / retrieves an instance of the given type with the given identifier (name) constructed as defined in one to many configuration files.
T	toInstance(Properties aProperties) This method creates / retrieves an instance of the given type with the given identifier (name) constructed as defined in one to many configuration files.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRecyclableTypeFactory

public AbstractRecyclableTypeFactory()

Default constructor creating a AbstractRecyclableTypeFactory.

AbstractRecyclableTypeFactory

public AbstractRecyclableTypeFactory(int aMaxRecycledInstanceNumber)

Constructor creating a AbstractRecyclableTypeFactory which allows only a given maximum of recycled instances to be contained in this factory. In case the max number of recycled instances being managed is reached, then calls to recycleInstance(Object) will be ignored, meaning that no more instances will be internally be stored. This measure can be used in addition to the weak collection we use for this Implementation.

Parameters:

aMaxRecycledInstanceNumber - The max number of recycled instances which is not to be exceeded when internally storing recycled instances. A value of -1 does disable that limit.

Method Detail

toInstance

public T toInstance()

Description copied from interface: TypeFactory

This method creates / retrieves an instance of the given type with the given identifier (name) constructed as defined in one to many configuration files. How the instance is configured, created or retrieved is up to the nature (implementation) of the according factory.

Specified by:

toInstance in interface TypeFactory<T>

Returns:

The instance being fabricated by this factory.

toInstance

public T toInstance(Properties aProperties)

Description copied from interface: TypeFactory

This method creates / retrieves an instance of the given type with the given identifier (name) constructed as defined in one to many configuration files. How the instance is configured, created or retrieved is up to the nature (implementation) of the according factory.

Specified by:

toInstance in interface TypeFactory<T>

Parameters:

aProperties - The dynamic properties which are used to configure the desired bean.

Returns:

The instance being fabricated by this factory.

recycleInstance

public void recycleInstance(T aInstance)

Description copied from interface: TypeRecyclable

Makes the provided instance available for reuse by the factory. Instead of creating a new instance, one recycle instance is returned. In case an instance to be recycled implements the Clearable interface, then the provided instance is cleared by invoking the Clearable.clear() method. In case an instance to be recycled implements the Resetable interface, then the provided instance is reseted by invoking the Resetable.reset() method.

Specified by:

recycleInstance in interface TypeRecyclable<T>

Parameters:

aInstance - The object to be recycled and offered fore reuse.

clear

public void clear()

Specified by:

clear in interface org.refcodes.collection.Clearable

getInstanceCount

public int getInstanceCount()

Returns the number of recycled instances currently being managed by the AbstractRecyclableTypeFactory.

Returns:

The number of managed recycled instances ready for being served upon toInstance() (or toInstance(Properties)) invocation.

newInstance

protected abstract T newInstance()

To be implemented by you, called by toInstance() in case there are no more recycled objects available (provided via recycleInstance(Object)). ------------------------------------------------------------------------- This method creates / retrieves an instance of the given type with the given identifier (name) constructed as defined in one to many configuration files. How the instance is configured, created or retrieved is up to the nature (implementation) of the according factory.

Type Parameters:

T - The type which is to be fabricated by the factory method.

Returns:

An instance of the required type for the given instance name (identifier).

Throws:

ClassCastException - in case the fabricated type is not type compatible with the required type T.

newInstance

protected abstract T newInstance(Properties aProperties)

To be implemented by you, called by toInstance(Properties) in case there are no more recycled objects available (provided via recycleInstance(Object)). ------------------------------------------------------------------------- This method creates / retrieves an instance of the given type with the given identifier (name) constructed as defined in one to many configuration files. How the instance is configured, created or retrieved is up to the nature (implementation) of the according factory.

Type Parameters:

T - The type which is to be fabricated by the factory method.

Parameters:

aProperties - The dynamic properties which are used to configure the desired bean.

Returns:

An instance of the required type for the given instance name (identifier).

Throws:

ClassCastException - in case the fabricated type is not type compatible with the required type T.