burlap.shell.command.reserved

Class CommandsCommand

java.lang.Object

burlap.shell.command.reserved.CommandsCommand

All Implemented Interfaces:

ShellCommand

public class CommandsCommand
extends java.lang.Object
implements ShellCommand

A reserved ShellCommand for listing all shell commands. Use the -h option for help information.

Author:

James MacGlashan.

Field Summary

Fields

Modifier and Type	Field and Description
protected joptsimple.OptionParser	parser

Constructor Summary

Constructors

Constructor and Description
CommandsCommand()

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.

Methods inherited from class java.lang.Object

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

Field Detail

parser

protected joptsimple.OptionParser parser

Constructor Detail

CommandsCommand

public CommandsCommand()

Method Detail

commandName

public java.lang.String commandName()

Description copied from interface: ShellCommand

Returns the default name of this command.

Specified by:

commandName in interface ShellCommand

Returns:

the default name of this command.

call

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

Description copied from interface: ShellCommand

Executes this command.

Specified by:

call in interface ShellCommand

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.