org.apache.commons.scxml.model
Class Log

java.lang.Object
  |
  +--org.apache.commons.scxml.model.Action
        |
        +--org.apache.commons.scxml.model.Log

public class Log

extends Action

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

Constructor Summary

Log()
Constructor.

Method Summary

void	execute(EventDispatcher evtDispatcher, ErrorReporter errRep, SCInstance scInstance, org.apache.commons.logging.Log appLog, Collection derivedEvents) Execute this action instance.
String	getExpr() Get the log expression.
String	getLabel() Get the log label.
void	setExpr(String expr) Set the log expression.
void	setLabel(String label) Set the log label.

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

getParent, getParentState, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

Log

public Log()

Constructor.

Method Detail

getExpr

public final String getExpr()

Get the log expression.

Returns:

Returns the expression.

setExpr

public final void setExpr(String expr)

Set the log expression.

Parameters:

expr - The expr to set.

getLabel

public final String getLabel()

Get the log label.

Returns:

Returns the label.

setLabel

public final void setLabel(String label)

Set the log label.

Parameters:

label - The label to set.

execute

public void execute(EventDispatcher evtDispatcher,
                    ErrorReporter errRep,
                    SCInstance scInstance,
                    org.apache.commons.logging.Log appLog,
                    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:

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

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