com.prosyst.mprm.commands.composite

Class BatchCommand

java.lang.Object

com.prosyst.mprm.commands.composite.BatchCommand

All Implemented Interfaces:

Command, Externalizable

public class BatchCommand
extends java.lang.Object
implements Command

Represents a command which is a sequence of other commands.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BATCH_COMMAND_TYPE

Fields inherited from interface com.prosyst.mprm.commands.Command

COMMAND_TYPE_BATCH_COMMAND, COMMAND_TYPE_CONDITIONAL, COMMAND_TYPE_CU, COMMAND_TYPE_CU_INSTANCE, COMMAND_TYPE_SCRIPT, COMMAND_TYPE_SERIALIZED_COMMAND

Constructor Summary

Constructors

Constructor and Description
BatchCommand() Empty constructor.

Method Summary

Modifier and Type	Method and Description
void	addCommand(Command command) Adds command to this batch.
Command[]	getCommands() Returns commands contained in this batch command.
java.lang.String	getType() Returns BATCH_COMMAND_TYPE constant.
void	insertCommandAt(Command command, int index) Inserts the specified command as a component in this batch at the specified index.
void	readObject(java.io.InputStream in) Method used for serialization
boolean	removeCommand(Command command) Removes the first (lowest-indexed) occurrence of the argument command from this batch.
void	removeCommandAt(int index) Removes the command at the specified index.
void	setCommandAt(Command command, int index) Sets the command at the specified index of this batch to be the specified command object.
int	size() Returns the number of commands in this batch.
java.lang.String	toString()
void	writeObject(java.io.OutputStream out) Method used for serialization

Methods inherited from class java.lang.Object

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

Field Detail

BATCH_COMMAND_TYPE

public static final java.lang.String BATCH_COMMAND_TYPE

See Also:

Constant Field Values

Constructor Detail

BatchCommand

public BatchCommand()

Empty constructor.

Method Detail

getType

public java.lang.String getType()

Returns BATCH_COMMAND_TYPE constant.

Specified by:

getType in interface Command

Returns:

the type of the command object which is defined with BATCH_COMMAND_TYPE constant.

addCommand

public void addCommand(Command command)

Adds command to this batch.

Parameters:

command - being added to the batch command.

insertCommandAt

public void insertCommandAt(Command command,
                            int index)

Inserts the specified command as a component in this batch at the specified index. Each command in this batch with an index greater or equal to the specified index is shifted upward to have an index one greater than the value it had previously.
The index must be a value greater than or equal to 0 and less than or equal to the current size of the batch.

Parameters:

command - being added to the batch command.

index - the specified index.

setCommandAt

public void setCommandAt(Command command,
                         int index)

Sets the command at the specified index of this batch to be the specified command object. The previous command at that position is discarded.
The index must be a value greater than or equal to 0 and less than the current size of the batch.

Parameters:

index - the specified index.

command - what the command is to be set to.

removeCommand

public boolean removeCommand(Command command)

Removes the first (lowest-indexed) occurrence of the argument command from this batch. If the command exists in this batch, each command in the batch with an index greater or equal to the command's index is shifted downward to have an index one smaller than the value it had previously.

Parameters:

command - the command to be removed.

Returns:

true if the argument command was a component of this batch; false otherwise.

removeCommandAt

public void removeCommandAt(int index)

Removes the command at the specified index. Each command in this batch with an index greater or equal to the specified index is shifted downward to have an index one smaller than the value it had previously. The size of this batch is decreased by 1.
The index must be a value greater than or equal to 0 and less than the current size of the batch.

Parameters:

index - the index of the command to remove.

getCommands

public Command[] getCommands()

Returns commands contained in this batch command.

Returns:

array of commands of this batch command.

size

public int size()

Returns the number of commands in this batch.

Returns:

the number of commands in this batch.

readObject

public void readObject(java.io.InputStream in)
                throws java.lang.Exception

Method used for serialization

Specified by:

readObject in interface Externalizable

Throws:

java.lang.Exception

writeObject

public void writeObject(java.io.OutputStream out)
                 throws java.lang.Exception

Method used for serialization

Specified by:

writeObject in interface Externalizable

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object