burlap.shell.command

Interface ShellCommand

All Known Implementing Classes:

AddStateObjectCommand, AddStateObjectSGCommand, AliasCommand, AliasesCommand, CommandsCommand, EpisodeRecordingCommands.EpisodeBrowserCommand, EpisodeRecordingCommands.RecordCommand, ExecuteActionCommand, GameCommand, GenerateStateCommand, HelpCommand, IsTerminalCommand, IsTerminalSGCommand, JointActionCommand, LastJointActionCommand, ListActionsCommand, ListPropFunctions, ManualAgentsCommands.ListManualAgents, ManualAgentsCommands.LSManualAgentActionsCommands, ManualAgentsCommands.RegisterAgentCommand, ManualAgentsCommands.SetAgentAction, ObservationCommand, QuitCommand, RemoveStateObjectCommand, RemoveStateObjectSGCommand, ResetEnvCommand, RewardCommand, RewardsCommand, SetVarCommand, SetVarSGCommand, VisualExplorer.LivePollCommand, WorldObservationCommand

public interface ShellCommand

An interface for implementing shell commands. Requires implementing a default name for the command and a call command for what should be executed when the command is called. When executed, commands return a return code. -1 indicates a parsing error. 0 indicates standard completion. 1 indicates that an important external variable, such as the state of an Environment was changed.

Author:

James MacGlashan.

Method Summary

Modifier and Type	Method and Description
int	call(BurlapShell shell, java.lang.String argString, java.util.Scanner is, java.io.PrintStream os) Executes this command.
java.lang.String	commandName() Returns the default name of this command.

Method Detail

commandName

java.lang.String commandName()

Returns the default name of this command.

Returns:

the default name of this command.

call

int call(BurlapShell shell,
         java.lang.String argString,
         java.util.Scanner is,
         java.io.PrintStream os)

Executes this command.

Parameters:

shell - the calling BurlapShell

argString - the argument string that was associated with this command.

is - a Scanner that can be used to read input from a user.

os - a OutputStream to write output

Returns:

a return code of the command. -1 indicates a parsing error. 0 indicates standard completion. 1 indicates that an important external variable, such as the state of an Environment was changed.