org.springframework.boot.cli.command

Interface Command

    • Method Detail

      • getName

        String getName()
        Returns the name of the command.
        Returns:
        the command's name
      • getDescription

        String getDescription()
        Returns a description of the command.
        Returns:
        the command's description
      • getUsageHelp

        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
      • getHelp

        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
      • getOptionsHelp

        Collection<OptionHelp> getOptionsHelp()
        Returns help for each supported option.
        Returns:
        help for each of the command's options
      • getExamples

        Collection<HelpExample> getExamples()
        Return some examples for the command.
        Returns:
        the command's examples
      • run

        ExitStatus run(String... args)
                throws Exception
        Run the command.
        Parameters:
        args - command arguments (this will not include the command itself)
        Returns:
        the outcome of the command
        Throws:
        Exception - if the command fails