fr.lri.swingstates.events

Class VirtualEvent

java.lang.Object

java.util.EventObject

fr.lri.swingstates.events.VirtualEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

VirtualAnimationEvent, VirtualCanvasEvent, VirtualCElementEvent, VirtualTimerEvent

public class VirtualEvent
extends java.util.EventObject

A virtual event to send to a state machine.

For instance, to send a virtual event "copy" to a state machine sm:

 //Build a virtual event
 VirtualEvent copyEvent =  new VirtualEvent("copy");
 //Send it to a state machine sm
 sm.processEvent(copyEvent);
 

The virtual event can thus be used to fire a transition in sm:

 StateMachine sm = new StateMachine() {
                public State s = new State () {
                        Transition t = new Transition("copy") { ... };
                        ...
                };
                ...
 };
 

Author:

Caroline Appert

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VirtualEvent(java.lang.String n) Builds a virtual event.
VirtualEvent(java.lang.String n, java.lang.Object source) Builds a virtual event.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.LinkedList<Transition>	getMatchingTransitions(State state) Retrieves the transitions that match the name of this event on a given state.
java.lang.String	getNameEvent() Returns the name of the virtual event.
void	setNameEvent(java.lang.String n) Sets the name of a virtual event.
void	setSource(java.lang.Object source) Sets the source of this VirtualEvent.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VirtualEvent

public VirtualEvent(java.lang.String n)

Builds a virtual event.

Parameters:

n - The name of the virtual event.

VirtualEvent

public VirtualEvent(java.lang.String n,
            java.lang.Object source)

Builds a virtual event.

Parameters:

n - The name of the virtual event.

Method Detail

getNameEvent

public java.lang.String getNameEvent()

Returns the name of the virtual event.

Returns:

The name of the virtual event.

setNameEvent

public void setNameEvent(java.lang.String n)

Sets the name of a virtual event.

Parameters:

n - The name of the virtual event to set.

getMatchingTransitions

public java.util.LinkedList<Transition> getMatchingTransitions(State state)

Retrieves the transitions that match the name of this event on a given state.

Parameters:

state - The state.

Returns:

The list of the matching transitions.

setSource

public void setSource(java.lang.Object source)

Sets the source of this VirtualEvent.

Parameters:

source - The new source.