Constructor Detail

• public CommandRunner(java.lang.String name)

  Create a new CommandRunner instance.

  Parameters:

  name - the name of the runner or null

Method Detail

• public void addCommand(Command command)

  Add the specified command.

  Parameters:

  command - the command to add.

• public void addCommands(java.lang.Iterable<Command> commands)

  Add the specified commands.

  Parameters:

  commands - the commands to add

• protected void afterRun(Command command)

  Subclass hook called after a command has run.

  Parameters:

  command - the command that has run

• protected void beforeRun(Command command)

  Subclass hook called before a command is run.

  Parameters:

  command - the command about to run

• protected boolean errorMessage(java.lang.String message)

• public Command findCommand(java.lang.String name)

  Find a command by name.

  Parameters:

  name - the name of the command

  Returns:

  the command or null if not found

• protected final java.util.List<Command> getCommands()

• public java.lang.String getName()

  Return the name of the runner or an empty string. Non-empty names will include a trailing space character so that they can be used as a prefix.

  Returns:

  the name of the runner

• public boolean isOptionCommand(Command command)

  Returns if the specified command is an option command.

  Parameters:

  command - the command to test

  Returns:

  true if the command is an option command

  See Also:

  setOptionCommands(Class...)

• @java.lang.Override
  public java.util.Iterator<Command> iterator()

• protected void printStackTrace(java.lang.Exception ex)

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

  Parse the arguments and run a suitable command.

  throws:

  Exception if the command fails

  Parameters:

  args - the arguments

  Returns:

  the outcome of the command

• public int runAndHandleErrors(java.lang.String args)

  Run the appropriate and handle and errors.

  Parameters:

  args - the input arguments

  Returns:

  a return status code (non boot is used to indicate an error)

• public void setHiddenCommands(java.lang.Class<?> commandClasses)

  Set the command classes which should be hidden (i.e. executed but not displayed in the available commands list).

  Parameters:

  commandClasses - the classes of hidden commands

• public void setOptionCommands(java.lang.Class<?> commandClasses)

  Set the command classes which should be considered option commands. An option command is a special type of command that usually makes more sense to present as if it is an option. For example '--version'.

  Parameters:

  commandClasses - the classes of option commands.

  See Also:

  isOptionCommand(org.springframework.boot.cli.command.Command)

• protected void showUsage()