Foreach (Apache Commons SCXML 2.0-SNAPSHOT API)

java.lang.Object
- org.apache.commons.scxml2.model.Action
- - org.apache.commons.scxml2.model.Foreach

All Implemented Interfaces:

Serializable, ActionsContainer, NamespacePrefixesHolder
```
public class Foreach
extends Action
implements ActionsContainer
```
The class in this SCXML object model that corresponds to the <foreach> SCXML element, which allows an SCXML application to iterate through a collection in the data model and to execute the actions contained within it for each item in the collection.

See Also:
Serialized Form

Field Summary
- Fields inherited from interface org.apache.commons.scxml2.model.ActionsContainer
  ELEM_FOREACH, ELEM_IF

Constructor Summary

Constructors
Constructor and Description

Foreach()

Constructors
Constructor and Description
`Foreach()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAction(Action action)` Add an Action to the list of executable actions contained in this <container>.
`void`	`execute(ActionExecutionContext exctx)` Execute this action instance.
`List<Action>`	`getActions()` Get the executable actions contained in this <container>.
`String`	`getArray()`
`String`	`getContainerElementName()` Get the Document element type for this <container>.
`String`	`getIndex()`
`String`	`getItem()`
`void`	`setArray(String array)`
`void`	`setIndex(String index)`
`void`	`setItem(String item)`

Methods inherited from class org.apache.commons.scxml2.model.Action
getNamespaces, getNamespacesKey, getParent, getParentEnterableState, getTextContentIfNodeResult, setNamespaces, setParent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Foreach
```
public Foreach()
```
- Method Detail
  - getContainerElementName
```
public final String getContainerElementName()
```
    Description copied from interface: ActionsContainer
    
    Get the Document element type for this <container>.
    
    Specified by:
    
    getContainerElementName in interface ActionsContainer
    
    Returns:
    Returns the element type
  - getActions
```
public final List<Action> getActions()
```
    Description copied from interface: ActionsContainer
    
    Get the executable actions contained in this <container>.
    
    Specified by:
    
    getActions in interface ActionsContainer
    
    Returns:
    Returns the actions.
  - addAction
```
public final void addAction(Action action)
```
    Description copied from interface: ActionsContainer
    
    Add an Action to the list of executable actions contained in this <container>.
    
    Specified by:
    
    addAction in interface ActionsContainer
    
    Parameters:
    action - The action to add.
  - getArray
```
public String getArray()
```
  - setArray
```
public void setArray(String array)
```
  - getItem
```
public String getItem()
```
  - setItem
```
public void setItem(String item)
```
  - getIndex
```
public String getIndex()
```
  - setIndex
```
public void setIndex(String index)
```
  - execute
```
public void execute(ActionExecutionContext exctx)
             throws ModelException,
                    SCXMLExpressionException
```
    Execute this action instance.
    
    Specified by:
    
    execute in class Action
    
    Parameters:
    exctx - The ActionExecutionContext for this execution instance
    
    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.

Class Foreach

Field Summary

Fields inherited from interface org.apache.commons.scxml2.model.ActionsContainer

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

Foreach

Method Detail

getContainerElementName

getActions

addAction

getArray

setArray

getItem

setItem

getIndex

setIndex

execute