Package org.rribbit.retrieval

Interface ListenerObjectRetriever

All Known Implementing Classes:

CachedListenerObjectRetriever, DefaultListenerObjectRetriever

public interface ListenerObjectRetriever

A ListenerObjectRetriever retrieves the ListenerObjects that were created by one or more ListenerObjectCreators.

Author:

G.J. Schouten

Method Summary

Modifier and Type	Method	Description
Collection<ListenerObject>	getListenerObjects()	Returns a Collection of all ListenerObjects that are known to this ListenerObjectRetriever.
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.

Method Details

getListenerObjects

Collection<ListenerObject> getListenerObjects()

Returns a Collection of all ListenerObjects that are known to this ListenerObjectRetriever.

Returns:

a Collection of all known ListenerObjects, or an empty Collection if there are none. This method never returns null.

getListenerObjects

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

Returns a Collection of ListenerObjects that satisfy the following requirements.

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

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.

Throws:

IllegalArgumentException - when 'returnType' is 'null'

getListenerObjects

Collection<ListenerObject> getListenerObjects(String hint)

Returns a Collection of ListenerObjects that satisfy the following requirements.

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

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.

Throws:

IllegalArgumentException - when 'hint' is 'null'

getListenerObjects

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

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

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.

Throws:

IllegalArgumentException - when 'returnType' or 'hint' is 'null'