Method Detail

• public java.lang.String getDescription()

  Returns a description of the command.

  Returns:

  the command's description

• public java.util.Collection<HelpExample> getExamples()

  Return some examples for the command.

  Returns:

  the command's examples

• public java.lang.String getHelp()

  Gets full help text for the command, e.g. a longer description and one line per option.

  Returns:

  the command's help text

• public java.lang.String getName()

  Returns the name of the command.

  Returns:

  the command's name

• public java.util.Collection<OptionHelp> getOptionsHelp()

  Returns help for each supported option.

  Returns:

  help for each of the command's options

• public java.lang.String getUsageHelp()

  Returns usage help for the command. This should be a simple one-line string describing basic usage. e.g. '[options] <file>'. Do not include the name of the command in this string.

  Returns:

  the command's usage help

• public ExitStatus run(java.lang.String args)

  Run the command.

  throws:

  Exception if the command fails

  Parameters:

  args - command arguments (this will not include the command itself)

  Returns:

  the outcome of the command