类 HelpCommand

构造器详细资料

• HelpCommand

  public HelpCommand​(CommandRunner commandRunner)

方法详细资料

• getUsageHelp

  public String getUsageHelp()

  从接口复制的说明: Command
  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.

  指定者:

  getUsageHelp 在接口中 Command

  覆盖:

  getUsageHelp 在类中 AbstractCommand

  返回:

  the command's usage help

• getHelp

  public String getHelp()

  从接口复制的说明: Command
  Gets full help text for the command, e.g. a longer description and one line per option.

  指定者:

  getHelp 在接口中 Command

  覆盖:

  getHelp 在类中 AbstractCommand

  返回:

  the command's help text

• getOptionsHelp

  public Collection<OptionHelp> getOptionsHelp()

  从接口复制的说明: Command
  Returns help for each supported option.

  指定者:

  getOptionsHelp 在接口中 Command

  覆盖:

  getOptionsHelp 在类中 AbstractCommand

  返回:

  help for each of the command's options

• run

  public ExitStatus run​(String... args)
                 throws Exception

  从接口复制的说明: Command
  Run the command.

  参数:

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

  返回:

  the outcome of the command

  抛出:

  Exception - if the command fails