org.millstone.base.event
Interface MethodEventSource

All Known Implementing Classes:

AbstractComponent, EventRouter

public interface MethodEventSource

Interface for classes supporting registeration of methods as event receivers.

For more information on the MillStone inheritable event mechanism see the org.millstone.base.event.

Since:

3.0

Version:

3.0.3

Author:

IT Mill Ltd.

Method Summary

void	addListener(java.lang.Class eventType, java.lang.Object object, java.lang.reflect.Method method) Registers a new event listener with the specified activation method to listen events generated by this component.
void	addListener(java.lang.Class eventType, java.lang.Object object, java.lang.String methodName) Registers a new listener with the specified activation method to listen events generated by this component.
void	removeListener(java.lang.Class eventType, java.lang.Object target) Removes all registered listeners matching the given parameters.
void	removeListener(java.lang.Class eventType, java.lang.Object target, java.lang.reflect.Method method) Removes one registered listener method.
void	removeListener(java.lang.Class eventType, java.lang.Object target, java.lang.String methodName) Removes one registered listener method.

Method Detail

addListener

public void addListener(java.lang.Class eventType,
                        java.lang.Object object,
                        java.lang.reflect.Method method)

Registers a new event listener with the specified activation method to listen events generated by this component. If the activation method does not have any arguments the event object will not be passed to it when it's called.

For more information on the MillStone inheritable event mechanism see the org.millstone.base.event.

Parameters:

eventType - type of the listened event. Events of this type or its subclasses activate the listener.

object - the object instance who owns the activation method

method - the activation method

Throws:

java.lang.IllegalArgumentException - unless method has exactly one match in object

addListener

public void addListener(java.lang.Class eventType,
                        java.lang.Object object,
                        java.lang.String methodName)

Registers a new listener with the specified activation method to listen events generated by this component. If the activation method does not have any arguments the event object will not be passed to it when it's called.

This version of addListener gets the name of the activation method as a parameter. The actual method is reflected from object, and unless exactly one match is found, java.lang.IllegalArgumentException is thrown.

For more information on the MillStone inheritable event mechanism see the org.millstone.base.event.

Parameters:

eventType - type of the listened event. Events of this type or its subclasses activate the listener.

object - the object instance who owns the activation method

methodName - the name of the activation method

Throws:

java.lang.IllegalArgumentException - unless method has exactly one match in object

removeListener

public void removeListener(java.lang.Class eventType,
                           java.lang.Object target)

Removes all registered listeners matching the given parameters. Since this method receives the event type and the listener object as parameters, it will unregister all object's methods that are registered to listen to events of type eventType generated by this component.

For more information on the MillStone inheritable event mechanism see the org.millstone.base.event.

Parameters:

eventType - exact event type the object listens to

target - target object that has registered to listen to events of type eventType with one or more methods

removeListener

public void removeListener(java.lang.Class eventType,
                           java.lang.Object target,
                           java.lang.reflect.Method method)

Removes one registered listener method. The given method owned by the given object will no longer be called when the specified events are generated by this component.

For more information on the MillStone inheritable event mechanism see the org.millstone.base.event.

Parameters:

eventType - exact event type the object listens to

target - target object that has registered to listen to events of type eventType with one or more methods

method - the method owned by target that's registered to listen to events of type eventType

removeListener

public void removeListener(java.lang.Class eventType,
                           java.lang.Object target,
                           java.lang.String methodName)

Removes one registered listener method. The given method owned by the given object will no longer be called when the specified events are generated by this component.

This version of removeListener gets the name of the activation method as a parameter. The actual method is reflected from target, and unless exactly one match is found, java.lang.IllegalArgumentException is thrown.

For more information on the MillStone inheritable event mechanism see the org.millstone.base.event.

Parameters:

eventType - exact event type the object listens to

target - target object that has registered to listen to events of type eventType with one or more methods

methodName - name of the method owned by target that's registered to listen to events of type eventType