Modifier and Type | Class and Description |
---|---|
static interface |
TestCommand.Handle |
Constructor and Description |
---|
TestCommand(String name) |
TestCommand(String name,
TestCommand.Handle r) |
Modifier and Type | Method and Description |
---|---|
void |
addOptions(org.apache.commons.cli.Option... options) |
String |
getDescription()
A short description for the command indicating what it does.
|
String |
getName()
Returns a name for this command.
|
org.apache.commons.cli.Options |
getOptions()
Returns the Options that the command is prepared to handle.
|
String |
getUsage()
How the user should invoke this command
|
boolean |
isAvailableInShell()
Whether the command is available to be invoked from within the shell.
|
boolean |
isAvailableOutsideShell()
Indicates if the command is available to be invoked from outside the
shell (from the main command line).
|
boolean |
isStorageRequired() |
void |
run(CommandContext ctx)
Execute the command
|
void |
setDescription(String desc) |
void |
setStorageRequired(boolean storageRequired) |
void |
setUsage(String usage) |
public TestCommand(String name)
public TestCommand(String name, TestCommand.Handle r)
public void run(CommandContext ctx) throws CommandException
Command
run
in interface Command
CommandException
public String getName()
Command
public String getDescription()
Command
getDescription
in interface Command
public void setDescription(String desc)
public String getUsage()
Command
public void setUsage(String usage)
public org.apache.commons.cli.Options getOptions()
Command
getOptions
in interface Command
public void addOptions(org.apache.commons.cli.Option... options)
public boolean isStorageRequired()
isStorageRequired
in interface Command
public void setStorageRequired(boolean storageRequired)
public boolean isAvailableInShell()
Command
isAvailableInShell
in interface Command
public boolean isAvailableOutsideShell()
Command
isAvailableOutsideShell
in interface Command
Copyright © 2013. All Rights Reserved.