org.apache.commons.scxml.model
Class Event

java.lang.Object
  org.apache.commons.scxml.model.Action
      org.apache.commons.scxml.model.Event

All Implemented Interfaces:

java.io.Serializable, NamespacePrefixesHolder

public class Event
extends Action

The class in this SCXML object model that corresponds to the <event> SCXML element.

Since:

0.7

See Also:

Serialized Form

Constructor Summary

Event()
Constructor.

Method Summary

void	execute(EventDispatcher evtDispatcher, ErrorReporter errRep, SCInstance scInstance, org.apache.commons.logging.Log appLog, java.util.Collection derivedEvents) Execute this action instance.
java.lang.String	getName() Get the event name.
void	setName(java.lang.String name) Set the event name.

Methods inherited from class org.apache.commons.scxml.model.Action

getNamespaces, getNamespacesKey, getParent, getParentState, setNamespaces, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event()

Constructor.

Method Detail

getName

public final java.lang.String getName()

Get the event name.

Returns:

Returns the name.

setName

public final void setName(java.lang.String name)

Set the event name.

Parameters:

name - The event name to set.

execute

public void execute(EventDispatcher evtDispatcher,
                    ErrorReporter errRep,
                    SCInstance scInstance,
                    org.apache.commons.logging.Log appLog,
                    java.util.Collection derivedEvents)
             throws ModelException,
                    SCXMLExpressionException

Execute this action instance.

Specified by:

execute in class Action

Parameters:

evtDispatcher - The EventDispatcher for this execution instance

errRep - The ErrorReporter to broadcast any errors during execution.

scInstance - The state machine execution instance information.

appLog - The application Log.

derivedEvents - The collection to which any internal events arising from the execution of this action must be added.

Throws:

ModelException - If the execution causes the model to enter a non-deterministic state.

SCXMLExpressionException - If the execution involves trying to evaluate an expression which is malformed.