Package de.dlr.proseo.ui.cli.parser

Class CLICommand

java.lang.Object
de.dlr.proseo.ui.cli.parser.CLICommand
public class CLICommand extends Object
Class representing a prosEO CLI command
Author:
Thomas Bassler

  • Constructor Details

    • CLICommand

      public CLICommand()

  • Method Details

    • getName

      public String getName()
      Gets the command name
      Returns:
      the name

    • setName

      public void setName(String name)
      Sets the command name
      Parameters:
      name - the name to set

    • getDescription

      public String getDescription()
      Gets the command description
      Returns:
      the description

    • setDescription

      public void setDescription(String description)
      Sets the command description
      Parameters:
      description - the description to set

    • getSubcommands

      public List<CLICommand> getSubcommands()
      Gets the command's subcommands
      Returns:
      the subcommands

    • setSubcommands

      public void setSubcommands(List<CLICommand> subcommands)
      Sets the command's subcommands
      Parameters:
      subcommands - the subcommands to set

    • getOptions

      public List<CLIOption> getOptions()
      Gets the command's options
      Returns:
      the options

    • setOptions

      public void setOptions(List<CLIOption> options)
      Sets the command's options
      Parameters:
      options - the options to set

    • getParameters

      public List<CLIParameter> getParameters()
      Gets the command's parameters
      Returns:
      the parameters

    • setParameters

      public void setParameters(List<CLIParameter> parameters)
      Sets the command's parameters
      Parameters:
      parameters - the parameters to set

    • printHelp

      public void printHelp(PrintStream out)
      Print help information for this command on the given print stream
      Parameters:
      out - the print stream to write to

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • printHTML

      public StringBuilder printHTML(StringBuilder htmlDoc)
      Appends the StringBuilder provided by the caller with HTML code that prints a table with the command's name and description and calls - if applicable - the printHTML() methods of subcommands, options and parameters.
      Parameters:
      htmlDoc - A StringBuilder that may already contain information.
      Returns:
      The same StringBuilder, appended information on the command.