ru.d_shap.cli

Interface Command

All Known Implementing Classes:

AbstractCommand, AbstractConfirmCommand, AbstractContainerCommand, AbstractExecutionCommand, AbstractInputBooleanCommand, AbstractInputCommand, AbstractInputDoubleCommand, AbstractInputFloatCommand, AbstractInputIntegerCommand, AbstractInputLongCommand, AbstractInputStringCommand, AbstractMenuCommand, AbstractUserActionCommand, AbstractYesNoCancelCommand, AbstractYesNoCommand, CommandDelegate, SimpleContainerCommand

public interface Command

Command interface.

Author:

Dmitry Shapovalov

Method Summary

Modifier and Type	Method and Description
Command	execute(PrintWriter writer, BufferedReader reader) Execute the command.
CommandRunner	getCommandRunner() Get the command runner.
Context	getContext() Get the command context.
Command	getParentCommand() Get the parent command.
<T extends Command> Command	getParentCommand(Class<T> clazz) Get the parent command with the specified class.
boolean	hasParentCommand() Check if this command has the parent command.
<T extends Command> boolean	hasParentCommand(Class<T> clazz) Check if this command has the parent command with the specified class.
void	reset() Reset the command state.
void	setCommandRunner(CommandRunner commandRunner) Set the command runner.
void	setContext(Context context) Set the command context.

Method Detail

hasParentCommand

boolean hasParentCommand()

Check if this command has the parent command.

Returns:

true if this command has the parent command.

hasParentCommand

<T extends Command> boolean hasParentCommand(Class<T> clazz)

Check if this command has the parent command with the specified class.

Type Parameters:

T - the generic type of the specified class.

Parameters:

clazz - the specified class.

Returns:

true if this command has the parent command with the specified class.

getParentCommand

Command getParentCommand()

Get the parent command.

Returns:

the parent command.

getParentCommand

<T extends Command> Command getParentCommand(Class<T> clazz)

Get the parent command with the specified class.

Type Parameters:

T - the generic type of the specified class.

Parameters:

clazz - the specified class.

Returns:

the parent command.

getContext

Context getContext()

Get the command context.

Returns:

the command context.

setContext

void setContext(Context context)

Set the command context.

Parameters:

context - the command context.

getCommandRunner

CommandRunner getCommandRunner()

Get the command runner.

Returns:

the command runner.

setCommandRunner

void setCommandRunner(CommandRunner commandRunner)

Set the command runner.

Parameters:

commandRunner - the command runner.

execute

Command execute(PrintWriter writer,
                BufferedReader reader)

Execute the command.

Parameters:

writer - the stream to write the command output.

reader - the stream to read the user input.

Returns:

the next command to execute.

reset

void reset()

Reset the command state.