Package org.rribbit.creation

Class ObjectBasedListenerObjectCreator

java.lang.Object

org.rribbit.creation.ObjectBasedListenerObjectCreator

All Implemented Interfaces:

ListenerObjectCreator

Direct Known Subclasses:

AbstractClassBasedListenerObjectCreator

public class ObjectBasedListenerObjectCreator
extends Object
implements ListenerObjectCreator

This ListenerObjectCreator creates ListenerObjects from objects. Users can pass in Objects and this class will scan the Object's class and create ListenerObjects for the public methods that are annotated with Listener. This includes all public methods that are declared in superclasses.

Please note that in Java, method annotations are NOT inherited. This means that, if you override/implement a method in a subclass or subinterface, and the overriding/implementing method does not have the annotation, then that method will not inherit it. If a class or interface just inherits a method, without overriding it, then the annotation WILL exist.

Subclasses of this class are required to call notifyObserversOnClassAdded(Class) whenever a class is scanned and its listeners are created.

Author:

G.J. Schouten

Field Summary

Fields

Modifier and Type	Field	Description
protected Collection<ListenerObject>	listenerObjects	Subclasses are recommended to use this Collection to store the ListenerObjects in.
protected Collection<ListenerObjectCreationObserver>	observers

Constructor Summary

Constructors

Constructor	Description
ObjectBasedListenerObjectCreator(Object... objects)	Initializes the Collection of ListenerObjects and calls addObject(Object) for each given Object.

Method Summary

Modifier and Type	Method	Description
void	addObject(Object object)	Scans all public methods of the dynamic runtime Class of the given Object (the Class returned by Object.getClass()) and creates ListenerObjects for them if they have a Listener annotation, then initializes those ListenerObjects with the given Object as execution target.
protected Collection<ListenerObject>	getIncompleteListenerObjectsFromClass(Class<?> clazz)	Scans all public methods in the given Class, including those inherited from superclasses / superinterfaces and creates ListenerObjects for them if they have a Listener annotation.
Collection<ListenerObject>	getListenerObjects()	Get ListenerObjects from methods that have registered themselves as a Listener.
protected void	notifyObserversOnClassAdded(Class<?> addedClass)	Notifies all registered ListenerObjectCreationObservers that a class is scanned and its listeners created.
void	registerObserver(ListenerObjectCreationObserver listenerObjectCreationObserver)	Adds a ListenerObjectCreationObserver to the list of ListenerObjectCreationObservers to be notified when a class is scanned and its listeners created.

Methods inherited from class java.lang.Object

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

Field Details

listenerObjects

protected Collection<ListenerObject> listenerObjects

Subclasses are recommended to use this Collection to store the ListenerObjects in.

observers

protected Collection<ListenerObjectCreationObserver> observers

Constructor Details

ObjectBasedListenerObjectCreator

public ObjectBasedListenerObjectCreator(Object... objects)

Initializes the Collection of ListenerObjects and calls addObject(Object) for each given Object.

Parameters:

objects -

Method Details

addObject

public void addObject(Object object)

Scans all public methods of the dynamic runtime Class of the given Object (the Class returned by Object.getClass()) and creates ListenerObjects for them if they have a Listener annotation, then initializes those ListenerObjects with the given Object as execution target.

Parameters:

object -

getIncompleteListenerObjectsFromClass

protected Collection<ListenerObject> getIncompleteListenerObjectsFromClass(Class<?> clazz)

Scans all public methods in the given Class, including those inherited from superclasses / superinterfaces and creates ListenerObjects for them if they have a Listener annotation. These ListenerObject have their target Object NOT YET SET! This is the responsibility of the caller of this method.

Parameters:

clazz - the class to scan

Returns:

a Collection of incomplete ListenerObjects that have their target Object not yet set.

notifyObserversOnClassAdded

protected void notifyObserversOnClassAdded(Class<?> addedClass)

Notifies all registered ListenerObjectCreationObservers that a class is scanned and its listeners created.

Parameters:

addedClass -

getListenerObjects

public Collection<ListenerObject> getListenerObjects()

Description copied from interface: ListenerObjectCreator

Get ListenerObjects from methods that have registered themselves as a Listener. Implementations are responsible for keeping a local copy of this Collection instead of recreating it everytime this method is called.

Specified by:

getListenerObjects in interface ListenerObjectCreator

Returns:

a Collection of ListenerObject from methods that have registered themselves as a Listener or an empty Collection if there are no such methods

registerObserver

public void registerObserver(ListenerObjectCreationObserver listenerObjectCreationObserver)

Description copied from interface: ListenerObjectCreator

Adds a ListenerObjectCreationObserver to the list of ListenerObjectCreationObservers to be notified when a class is scanned and its listeners created.

Specified by:

registerObserver in interface ListenerObjectCreator

Parameters:

listenerObjectCreationObserver -