net.sf.cuf.appevent

Class BindEvent

java.lang.Object

java.util.EventObject

net.sf.cuf.appevent.AppEvent

net.sf.cuf.appevent.BindEvent

All Implemented Interfaces:

Serializable

public class BindEvent
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, String pMethodToCallBack, Class<? extends AppEvent> pAppEventToBindTo) The constructor creates a BindEvent with the handed values and an unbound hop-count.
BindEvent(Object pSource, String pMethodToCallBack, Class<? extends AppEvent> pAppEventToBindTo, int pHopCount) The constructor creates a BindEvent with the handed values.

Method Summary

Methods

Modifier and Type	Method and Description
void	forward() During the propagation in the chain of responsibilty, at each hop the forward() method should be called according to the AppEventSupport "contract".
Method	getMethod() Returns the method object for the target object.
Object	getTarget() Returns the target for the binding.
Class<? extends AppEvent>	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,
         String pMethodToCallBack,
         Class<? extends AppEvent> 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<? extends AppEvent> 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 responsibilty, at each hop the forward() method should be called according to the AppEventSupport "contract". We use this to consume ourselfs if we had a hop count.

Overrides:

forward in class AppEvent

getTarget

public Object getTarget()

Returns the target for the binding.

Returns:

target object

getMethod

public Method getMethod()

Returns the method object for the target object.

Returns:

method of the target object

getTriggerClass

public Class<? extends AppEvent> getTriggerClass()

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

Returns:

trigger class