net.sf.cuf.appevent

Class BindEvent<T extends AppEvent>

java.lang.Object

java.util.EventObject

net.sf.cuf.appevent.AppEvent

net.sf.cuf.appevent.BindEvent<T>

All Implemented Interfaces:

Serializable

public class BindEvent<T extends AppEvent>
extends AppEvent

A BindEvent object is used to bind AppEvent classes to (any number of) event receivers.

See Also:

UnbindEvent, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
BindEvent(Object pSource, AppEventListener<T> pMethodToCallBack, Class<T> pAppEventToBindTo) The constructor creates a BindEvent with the handed values and an unbound hop-count.
BindEvent(Object pSource, AppEventListener<T> pMethodToCallBack, Class<T> pAppEventToBindTo, int pHopCount) The constructor creates a BindEvent with the handed values.
BindEvent(Object pSource, String pMethodToCallBack, Class<T> pAppEventToBindTo) The constructor creates a BindEvent with the handed values and an unbound hop-count.
BindEvent(Object pSource, String pMethodToCallBack, Class<T> pAppEventToBindTo, int pHopCount) The constructor creates a BindEvent with the handed values.

Method Summary

Modifier and Type	Method and Description
void	forward() During the propagation in the chain of responsibility, at each hop the forward() method should be called according to the AppEventSupport "contract".
AppEventListener	getMethodToCallBack() Returns the method to call back.
Class<T>	getTriggerClass() Returns the AppEvent derived class that the target is interested in.

Methods inherited from class net.sf.cuf.appevent.AppEvent

consume, isConsumed, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

BindEvent

public BindEvent(Object pSource,
                 AppEventListener<T> pMethodToCallBack,
                 Class<T> pAppEventToBindTo)

The constructor creates a BindEvent with the handed values and an unbound hop-count.

Parameters:

pSource - sender object, will receive the callback

pMethodToCallBack - method ot call back for the given AppEvent class

pAppEventToBindTo - trigger class, must be a subclass of AppEvent

Throws:

IllegalArgumentException - if one of the arguments is null or the method is not known/not public.

BindEvent

public BindEvent(Object pSource,
                 AppEventListener<T> pMethodToCallBack,
                 Class<T> pAppEventToBindTo,
                 int pHopCount)

The constructor creates a BindEvent with the handed values.

Parameters:

pSource - sender object, will receive the callback

pMethodToCallBack - method ot call back for the given AppEvent class

pAppEventToBindTo - trigger class, must be a subclass of AppEvent

pHopCount - number of hops this event gets forwarded before it consumes itself. If pHopCount is 0, there is no hop limit.

Throws:

IllegalArgumentException - if one of the arguments is null, pHopCount is negative or the method is not known/not public.

BindEvent

public BindEvent(Object pSource,
                 String pMethodToCallBack,
                 Class<T> pAppEventToBindTo)

The constructor creates a BindEvent with the handed values and an unbound hop-count.

Parameters:

pSource - sender object, will receive the callback

pMethodToCallBack - method name of pSource

pAppEventToBindTo - trigger class, must be a subclass of AppEvent

Throws:

IllegalArgumentException - if one of the arguments is null or the method is not known/not public.

BindEvent

public BindEvent(Object pSource,
                 String pMethodToCallBack,
                 Class<T> pAppEventToBindTo,
                 int pHopCount)

The constructor creates a BindEvent with the handed values.

Parameters:

pSource - sender object, will receive the callback

pMethodToCallBack - method name of pSource

pAppEventToBindTo - trigger class, must be a subclass of AppEvent

pHopCount - number of hops this event gets forwarded before it consumes itself. If pHopCount is 0, there is no hop limit.

Throws:

IllegalArgumentException - if one of the arguments is null, pHopCount is negative or the method is not known/not public.

Method Detail

forward

public void forward()

During the propagation in the chain of responsibility, at each hop the forward() method should be called according to the AppEventSupport "contract". We use this to consume ourselves if we had a hop count.

Overrides:

forward in class AppEvent

getMethodToCallBack

public AppEventListener getMethodToCallBack()

Returns the method to call back.

Returns:

the method to call back

getTriggerClass

public Class<T> getTriggerClass()

Returns the AppEvent derived class that the target is interested in.

Returns:

trigger class