Interface Command

    • Method Detail

      • getName

        String getName()
        Returns the name of the command that is implemented by the interface. The command name should not contain whitespace and should also be unique.
        Returns:
        the name of the command.
      • getUsage

        String getUsage()
        Returns the usage string for the command. The usage string is a short string that illustrates how to use the command on the command line. This information is used when generating command help information. An example usage string for the install command is:
             install  [ ...]
         
        Returns:
        the usage string for the command.
      • getShortDescription

        String getShortDescription()
        Returns a short description of the command; this description should be as short as possible. This information is used when generating the command help information.
        Returns:
        a short description of the command.
      • execute

        void execute​(String line,
                     PrintStream out,
                     PrintStream err)
        Executes the command using the supplied command line, output print stream, and error print stream.
        Parameters:
        line - the complete command line, including the command name.
        out - the print stream to use for standard output.
        err - the print stream to use for standard error.