com.cerner.ccl.j4ccl.impl

Class CommandQueue

java.lang.Object

com.cerner.ccl.j4ccl.impl.CommandQueue

public class CommandQueue
extends Object

An object that can be used to store contributions of commands to be executed during and outside of a CCL session.

Author:

Joshua Hyde

Constructor Summary

Constructors

Constructor and Description
CommandQueue()

Method Summary

Modifier and Type	Method and Description
CommandQueue	addInCclSessionCommand(AbstractCclCommand command) Add a command to be run during an open CCL session.
CommandQueue	addOnCclCloseCommand(AbstractCclCommand command) Add a command to be executed immediately prior to the closing of the CCL session.
CommandQueue	addOnCclStartCommand(AbstractCclCommand command) Add a command to be executed immediately after the opening of the CCL session.
void	execute(CclCommandTerminal cclTerminal) Execute a set of commands.
Collection<? extends AbstractCclCommand>	getInCclSessionCommands() Get all commands that are to be executed within an open CCL session.
Collection<? extends AbstractCclCommand>	getOnCclCloseCommands() Get all commands that are to be executed immediately prior to the closing of a CCL session.
Collection<? extends AbstractCclCommand>	getOnCclStartCommands() Get all commands that are to be executed immediately prior to the opening of a CCL session.
boolean	isEmpty() Determine whether or not this queue contains any commands to be executed.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandQueue

public CommandQueue()

Method Detail

addInCclSessionCommand

public CommandQueue addInCclSessionCommand(AbstractCclCommand command)

Add a command to be run during an open CCL session.

Parameters:

command - A AbstractCclCommand object.

Returns:

This object.

addOnCclCloseCommand

public CommandQueue addOnCclCloseCommand(AbstractCclCommand command)

Add a command to be executed immediately prior to the closing of the CCL session.

Parameters:

command - A AbstractCclCommand object.

Returns:

This object.

addOnCclStartCommand

public CommandQueue addOnCclStartCommand(AbstractCclCommand command)

Add a command to be executed immediately after the opening of the CCL session.

Parameters:

command - A AbstractCclCommand object.

Returns:

This object.

execute

public void execute(CclCommandTerminal cclTerminal)

Execute a set of commands.

Parameters:

cclTerminal - A CclCommandTerminal object representing the terminal in which the commands are to be executed.

getInCclSessionCommands

public Collection<? extends AbstractCclCommand> getInCclSessionCommands()

Get all commands that are to be executed within an open CCL session.

Returns:

An immutable Collection of objects that extend AbstractCclCommand.

getOnCclCloseCommands

public Collection<? extends AbstractCclCommand> getOnCclCloseCommands()

Get all commands that are to be executed immediately prior to the closing of a CCL session.

Returns:

An immutable Collection of objects that extend AbstractCclCommand.

getOnCclStartCommands

public Collection<? extends AbstractCclCommand> getOnCclStartCommands()

Get all commands that are to be executed immediately prior to the opening of a CCL session.

Returns:

An immutable Collection of objects that extend AbstractCclCommand.

isEmpty

public boolean isEmpty()

Determine whether or not this queue contains any commands to be executed.

Returns:

true if this queue contains no commands to be, false if there are commands to be run.