Package org.rribbit.retrieval

Class CachedListenerObjectRetriever

java.lang.Object

org.rribbit.retrieval.DefaultListenerObjectRetriever

org.rribbit.retrieval.CachedListenerObjectRetriever

All Implemented Interfaces:

ListenerObjectCreationObserver, ListenerObjectRetriever

public class CachedListenerObjectRetriever
extends DefaultListenerObjectRetriever
implements ListenerObjectCreationObserver

This ListenerObjectRetriever implements caching to be able to retrieve ListenerObjects more quickly. It keeps a local Map where requests are mapped to Collections of ListenerObjects. This class extends from DefaultListenerObjectRetriever and adds caching to the retrieval methods, except DefaultListenerObjectRetriever.getListenerObjects(), because that one simply returns all ListenerObjects. This class implements the ListenerObjectCreationObserver in order to clear the cache if any new ListenerObjects are created by any of the ListenerObjectCreators that are associated with this CachedListenerObjectRetriever. Also, if you add a ListenerObjectCreator to this CachedListenerObjectRetriever, the cache will be cleared as well.

Author:

G.J. Schouten

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	CachedListenerObjectRetriever.RetrievalRequest	This class represents the request made to this CachedListenerObjectRetriever.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<CachedListenerObjectRetriever.RetrievalRequest,Collection<ListenerObject>>	cache	The cache of Collections of ListenerObjects.

Fields inherited from class org.rribbit.retrieval.DefaultListenerObjectRetriever

listenerObjectCreators

Constructor Summary

Constructors

Constructor	Description
CachedListenerObjectRetriever()	Whenever you use this constructor, be sure to set the ListenerObjectCreator with the setter provided by this class.
CachedListenerObjectRetriever(ListenerObjectCreator... listenerObjectCreators)	This constructor is recommended, since it forces you to specify the ListenerObjectCreator.

Method Summary

Modifier and Type	Method	Description
void	addListenerObjectCreator(ListenerObjectCreator listenerObjectCreator)	Adds a ListenerObjectCreator to this DefaultListenerObjectRetriever.
protected void	checkHint(String hint)	Checks whether the hint is null, in order to be able to fullfill the ListenerObjectRetriever contract.
protected void	checkReturnType(Class<?> returnType)	Checks whether the returntype is null, in order to be able to fullfill the ListenerObjectRetriever contract.
protected void	clearCache()
Collection<ListenerObject>	getListenerObjects(Class<?> returnType)	Returns a Collection of ListenerObjects that satisfy the following requirements.
Collection<ListenerObject>	getListenerObjects(Class<?> returnType, String hint)	Returns a Collection of ListenerObjects that satisfy the following requirements.
Collection<ListenerObject>	getListenerObjects(String hint)	Returns a Collection of ListenerObjects that satisfy the following requirements.
protected void	init()	Initializes the cache of this CachedListenerObjectRetriever.
void	onClassAdded(Class<?> addedClass)	Clears the cache.
void	setListenerObjectCreator(ListenerObjectCreator listenerObjectCreator)	Removes all ListenerObjectCreators from this DefaultListenerObjectRetriever and adds only the given one.

Methods inherited from class org.rribbit.retrieval.DefaultListenerObjectRetriever

getListenerObjectCreators, getListenerObjects, getListenerObjectsFromAllCreators, matchesHint, matchesReturnType

Methods inherited from class java.lang.Object

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

Field Details

cache

protected Map<CachedListenerObjectRetriever.RetrievalRequest,Collection<ListenerObject>> cache

The cache of Collections of ListenerObjects.

Constructor Details

CachedListenerObjectRetriever

public CachedListenerObjectRetriever()

Whenever you use this constructor, be sure to set the ListenerObjectCreator with the setter provided by this class. If you don't, runtime NullPointerExceptions will occur.

CachedListenerObjectRetriever

public CachedListenerObjectRetriever(ListenerObjectCreator... listenerObjectCreators)

This constructor is recommended, since it forces you to specify the ListenerObjectCreator. Passing a null value for this will result in runtime NullPointerExceptions.

Parameters:

listenerObjectCreators -

Method Details

init

protected void init()

Initializes the cache of this CachedListenerObjectRetriever.

onClassAdded

public void onClassAdded(Class<?> addedClass)

Clears the cache.

Specified by:

onClassAdded in interface ListenerObjectCreationObserver

Parameters:

addedClass -

getListenerObjects

public Collection<ListenerObject> getListenerObjects(Class<?> returnType)

Description copied from interface: ListenerObjectRetriever

Returns a Collection of ListenerObjects that satisfy the following requirements.

• The parameter 'returnType' is assignable from the returntype of the ListenerObject

Specified by:

getListenerObjects in interface ListenerObjectRetriever

Overrides:

getListenerObjects in class DefaultListenerObjectRetriever

Parameters:

returnType - the return type that has to be assignable from the returntype of each ListenerObject

Returns:

a Collection of ListenerObjects that satisfy the above requirements, or an empty Collection if there were no matches. This method never returns null.

getListenerObjects

public Collection<ListenerObject> getListenerObjects(String hint)

Description copied from interface: ListenerObjectRetriever

Returns a Collection of ListenerObjects that satisfy the following requirements.

• The hints of the ListenerObject must contain the 'hint' parameter

Specified by:

getListenerObjects in interface ListenerObjectRetriever

Overrides:

getListenerObjects in class DefaultListenerObjectRetriever

Parameters:

hint - the hint that has to be contained by the hints of each ListenerObject

Returns:

a Collection of ListenerObjects that satisfy the above requirements, or an empty Collection if there were no matches. This method never returns null.

getListenerObjects

public Collection<ListenerObject> getListenerObjects(Class<?> returnType,
 String hint)

Description copied from interface: ListenerObjectRetriever

Returns a Collection of ListenerObjects that satisfy the following requirements.

• The parameter 'returnType' is assignable from the returntype of the ListenerObject
• The hints of the ListenerObject must contain the 'hint' parameter

Specified by:

getListenerObjects in interface ListenerObjectRetriever

Overrides:

getListenerObjects in class DefaultListenerObjectRetriever

Parameters:

returnType - the return type that has to be assignable from the returntype of each ListenerObject

hint - the hint that has to be contained by the hints of each ListenerObject

Returns:

a Collection of ListenerObjects that satisfy the above requirements, or an empty Collection if there were no matches. This method never returns null.

addListenerObjectCreator

public void addListenerObjectCreator(ListenerObjectCreator listenerObjectCreator)

Description copied from class: DefaultListenerObjectRetriever

Adds a ListenerObjectCreator to this DefaultListenerObjectRetriever.

Overrides:

addListenerObjectCreator in class DefaultListenerObjectRetriever

Parameters:

listenerObjectCreator - The ListenerObjectCreator that needs to be added to this DefaultListenerObjectRetriever

setListenerObjectCreator

public void setListenerObjectCreator(ListenerObjectCreator listenerObjectCreator)

Description copied from class: DefaultListenerObjectRetriever

Removes all ListenerObjectCreators from this DefaultListenerObjectRetriever and adds only the given one. After invoking this method, only the given ListenerObjectCreator will be used by this DefaultListenerObjectRetriever.

Overrides:

setListenerObjectCreator in class DefaultListenerObjectRetriever

Parameters:

listenerObjectCreator - The ListenerObjectCreator that must be the sole ListenerObjectCreator used by this DefaultListenerObjectRetriever

checkHint

protected void checkHint(String hint)

Checks whether the hint is null, in order to be able to fullfill the ListenerObjectRetriever contract.

Parameters:

hint -

checkReturnType

protected void checkReturnType(Class<?> returnType)

Checks whether the returntype is null, in order to be able to fullfill the ListenerObjectRetriever contract.

Parameters:

returnType -

clearCache

protected void clearCache()