Package api.advanced

Class Collection

java.lang.Object

api.advanced.Collection

All Implemented Interfaces:

ExecutableCommands

Direct Known Subclasses:

Sequence

public class Collection
extends java.lang.Object
implements ExecutableCommands

A tool to combine multiple ExecutableCommands into one object, which runs all contained commands in parallel.

See Also:

Example4, ExecutableCommands, Bundle, Use a Sequence to execute the commands one after another

Constructor Summary

Constructors

Constructor	Description
Collection()	Create a new, empty Collection.
Collection(ExecutableCommands[] commands)	Create a collection and initialize it with the ExecutableCommands contained in the array

Method Summary

Modifier and Type	Method	Description
void	add(ExecutableCommands command)	Add an ExecutableCommand to the commands contained in this Collection
boolean	equals(java.lang.Object obj)
void	exec()	Call the exec() methods of all contained commands
void	exec(int time)	Call the exec(int) methods of all contained commands with the provided time as the argument
void	execBlocking()	Like ExecutableCommands.exec() but blocks the Thread until the Command has been executed
void	execBlocking(int time)	Like ExecutableCommands.exec(int) but blocks the Thread until the Command has been executed
ExecutableCommands	getCommand(int index)
java.util.ArrayList<ExecutableCommands>	getCommands()
int	getTime()	Get the default execution time of this Command
java.lang.String	getTree()	Returns a String containing a tree showing the hierarchy of ExecutableCommands in this Collection
void	printTree()	Print the result of getTree
void	remove(ExecutableCommands command)	Remove the first occurrence of a command equal to the one provided as an argument from the collection This method is an alias of commands.remove(command)

Methods inherited from class java.lang.Object

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

Constructor Detail

Collection

public Collection()

Create a new, empty Collection.

Collection

public Collection(ExecutableCommands[] commands)

Create a collection and initialize it with the ExecutableCommands contained in the array

Parameters:

commands - An array of ExecutableCommands

Method Detail

exec

public void exec()

Call the exec() methods of all contained commands

Specified by:

exec in interface ExecutableCommands

See Also:

exec(int)

exec

public void exec(int time)

Call the exec(int) methods of all contained commands with the provided time as the argument

Specified by:

exec in interface ExecutableCommands

Parameters:

time - Argument for ExecutableCommands.exec(int)

See Also:

exec()

add

public void add(ExecutableCommands command)

Add an ExecutableCommand to the commands contained in this Collection

Parameters:

command - The ExecutableCommand to be added

remove

public void remove(ExecutableCommands command)

Remove the first occurrence of a command equal to the one provided as an argument from the collection
This method is an alias of commands.remove(command)

Parameters:

command - The command to be removed

printTree

public void printTree()

Print the result of getTree

Specified by:

printTree in interface ExecutableCommands

See Also:

ExecutableCommands.getTree()

getCommands

public java.util.ArrayList<ExecutableCommands> getCommands()

getCommand

public ExecutableCommands getCommand(int index)

getTree

public java.lang.String getTree()

Returns a String containing a tree showing the hierarchy of ExecutableCommands in this Collection

Specified by:

getTree in interface ExecutableCommands

Returns:

The command tree

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getTime

public int getTime()

Description copied from interface: ExecutableCommands

Get the default execution time of this Command

Specified by:

getTime in interface ExecutableCommands

Returns:

The default execution time of this Command

execBlocking

public void execBlocking()

Description copied from interface: ExecutableCommands

Like ExecutableCommands.exec() but blocks the Thread until the Command has been executed

Specified by:

execBlocking in interface ExecutableCommands

execBlocking

public void execBlocking(int time)

Description copied from interface: ExecutableCommands

Like ExecutableCommands.exec(int) but blocks the Thread until the Command has been executed

Specified by:

execBlocking in interface ExecutableCommands

Parameters:

time - The execution time in milliseconds