org.projectnyx.command

Class Command

java.lang.Object

org.projectnyx.command.Command

Direct Known Subclasses:

StopCommand

public abstract class Command
extends Object

Parent class for all commands.

Each concrete command class should be like singleton (even though without a static getInstance() method), i.e. a command should only be instantiated when registering.

Constructor Summary

Constructors

Constructor and Description
Command(String name)
Command(String name, String description, String usage)
Command(String name, UIText description, UIText usage)

Method Summary

Modifier and Type	Method and Description
void	execute(CommandIssuer issuer, String line) Trigger this command.
List<String>	getAliases() Aliases of this command.
String[]	getArgs() The argument line line split at whitespaces
String	getArgsLine() The exact line of command without the command name.
UIText	getDescription() This command's description, which can be displayed to users.
String	getName() A unique String identifier of this command.
UIText	getUsage() This command's usage, which can be displayed to users.
org.apache.commons.cli.CommandLine	parseArgs(org.apache.commons.cli.Options options) Parse command arguments using Commons CLI
org.apache.commons.cli.CommandLine	parseArgs(org.apache.commons.cli.Options options, boolean stopAtNonOption) Parse command arguments using Commons CLI
protected abstract void	run() Implementation of the command.
Command	setDescription(UIText description) This command's description, which can be displayed to users.
Command	setUsage(UIText usage) This command's usage, which can be displayed to users.

Methods inherited from class java.lang.Object

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

Constructor Detail

Command

public Command(String name)

Command

public Command(String name,
               String description,
               String usage)

Command

public Command(String name,
               UIText description,
               UIText usage)

Method Detail

execute

public final void execute(CommandIssuer issuer,
                          String line)

Trigger this command.

Parameters:

issuer - the CommandIssuer who issued this command.

line - the rest of the arguments in the command.

run

protected abstract void run()

Implementation of the command.

Arguments for this execution can be found using these methods:

See Also:

getArgsLine(), getArgs(), parseArgs(Options)

getArgsLine

public String getArgsLine()

The exact line of command without the command name.

Returns:

getArgs

public String[] getArgs()

The argument line line split at whitespaces

Returns:

parseArgs

public org.apache.commons.cli.CommandLine parseArgs(org.apache.commons.cli.Options options)
                                             throws org.apache.commons.cli.ParseException

Parse command arguments using Commons CLI

Parameters:

options - Options to look for

Returns:

the CommandLine result from Commons CLI

Throws:

org.apache.commons.cli.ParseException - if CommandLineParser encountered problems parsing arguments

parseArgs

public org.apache.commons.cli.CommandLine parseArgs(org.apache.commons.cli.Options options,
                                                    boolean stopAtNonOption)
                                             throws org.apache.commons.cli.ParseException

Parse command arguments using Commons CLI

Parameters:

options - Options to look for

stopAtNonOption - Stop parsing options if there is an unrecognized option

Returns:

the CommandLine result from Commons CLI

Throws:

org.apache.commons.cli.ParseException - if CommandLineParser encountered problems parsing arguments

getName

public String getName()

A unique String identifier of this command.

getDescription

public UIText getDescription()

This command's description, which can be displayed to users.

setDescription

public Command setDescription(UIText description)

This command's description, which can be displayed to users.

Returns:

this

getUsage

public UIText getUsage()

This command's usage, which can be displayed to users.

setUsage

public Command setUsage(UIText usage)

This command's usage, which can be displayed to users.

Returns:

this

getAliases

public List<String> getAliases()

Aliases of this command.

These are alternative names that have lower priority than names. If a command's name is the same as another command's alias, it will override.