casa.actions.rf3

Class CompositeAction<T extends Action>

java.lang.Object

casa.actions.rf3.AbstractAction

casa.actions.rf3.CompositeAction<T>

Type Parameters:

T - The parameter class must extend Action.

All Implemented Interfaces:

Action, Comparable<Action>, Iterable<T>, Collection<T>

Direct Known Subclasses:

AbstractAngelicChoice

public class CompositeAction<T extends Action>
extends AbstractAction
implements Collection<T>

A composite action is a Collection of zero or more actions. It is enabled if all of it's contained actions are enabled.

Author:

Rob Kremer

Field Summary

Fields

Modifier and Type	Field and Description
private Collection<T>	actions

Constructor Summary

Constructors

Constructor and Description
CompositeAction(Collection<T> theActions)
CompositeAction(String theName, Collection<T> theActions)
CompositeAction(String theName, T... theActions)
CompositeAction(T... theActions)

Method Summary

Modifier and Type	Method and Description
boolean	add(T theAction)
boolean	addAll(Collection<? extends T> theActions)
void	clear()
int	compareTo(Action theAction) Compares based on: the String.compareTo(String) of AbstractAction.getName() the compareTo() of the sorted members of the preconditions the compareTo() of the sorted members of the postconditions
boolean	contains(Object theObject)
boolean	containsAll(Collection<?> theObjects)
boolean	isEmpty()
boolean	isEnabled()
Iterator<T>	iterator()
boolean	remove(Object theObject)
boolean	removeAll(Collection<?> theObjects)
boolean	retainAll(Collection<?> theObjects)
Status	run(Object... theParameters) This is the actual action of the action.
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] theObjects)

Methods inherited from class casa.actions.rf3.AbstractAction

addPostCondition, addPostConditions, addPreCondition, addPreConditions, clearPostConditions, clearPreConditions, equals, execute, getName, getPostConditions, getPreConditions, removePostCondition, removePreCondition

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

actions

private Collection<T extends Action> actions

Constructor Detail

CompositeAction

public CompositeAction(String theName,
                       T... theActions)

CompositeAction

public CompositeAction(T... theActions)

CompositeAction

public CompositeAction(Collection<T> theActions)

CompositeAction

public CompositeAction(String theName,
                       Collection<T> theActions)

Method Detail

isEnabled

public final boolean isEnabled()

Specified by:

isEnabled in interface Action

Overrides:

isEnabled in class AbstractAction

Returns:

True iff all of the preconditions are true.

run

public Status run(Object... theParameters)
           throws IllegalOperationException

Description copied from class: AbstractAction

This is the actual action of the action. It should only be called by AbstractAction.execute(Object...).

Specified by:

run in class AbstractAction

Parameters:

theParameters - Any parameters required by the specific override of this method.

Returns:

Any Status object, according the the specific override of this method.

Throws:

IllegalOperationException

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T extends Action>

Specified by:

iterator in interface Collection<T extends Action>

add

public boolean add(T theAction)

Specified by:

add in interface Collection<T extends Action>

addAll

public boolean addAll(Collection<? extends T> theActions)

Specified by:

addAll in interface Collection<T extends Action>

clear

public void clear()

Specified by:

clear in interface Collection<T extends Action>

contains

public boolean contains(Object theObject)

Specified by:

contains in interface Collection<T extends Action>

containsAll

public boolean containsAll(Collection<?> theObjects)

Specified by:

containsAll in interface Collection<T extends Action>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T extends Action>

remove

public boolean remove(Object theObject)

Specified by:

remove in interface Collection<T extends Action>

removeAll

public boolean removeAll(Collection<?> theObjects)

Specified by:

removeAll in interface Collection<T extends Action>

retainAll

public boolean retainAll(Collection<?> theObjects)

Specified by:

retainAll in interface Collection<T extends Action>

size

public int size()

Specified by:

size in interface Collection<T extends Action>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T extends Action>

toArray

public <T> T[] toArray(T[] theObjects)

Specified by:

toArray in interface Collection<T extends Action>

compareTo

public int compareTo(Action theAction)

Description copied from class: AbstractAction

Compares based on:

1. the String.compareTo(String) of AbstractAction.getName()
2. the compareTo() of the sorted members of the preconditions
3. the compareTo() of the sorted members of the postconditions

Specified by:

compareTo in interface Comparable<Action>

Overrides:

compareTo in class AbstractAction