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

Class CLIOption

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

  • Constructor Details

    • CLIOption

      public CLIOption()

  • Method Details

    • getName

      public String getName()
      Gets the option's name
      Returns:
      the name

    • setName

      public void setName(String name)
      Sets the option's name
      Parameters:
      name - the name to set

    • getType

      public String getType()
      Gets the option's type
      Returns:
      the type

    • setType

      public void setType(String type)
      Sets the option's type
      Parameters:
      type - the type to set

    • getDescription

      public String getDescription()
      Gets the option's description
      Returns:
      the description

    • setDescription

      public void setDescription(String description)
      Sets the option's description
      Parameters:
      description - the description to set

    • getShortForm

      public Character getShortForm()
      Gets the option's short form
      Returns:
      the shortForm

    • setShortForm

      public void setShortForm(Character shortForm)
      Sets the option's short form
      Parameters:
      shortForm - the shortForm to set

    • toString

      public String toString()
      Returns the option in string format
      Overrides:
      toString in class Object
      Returns:
      the option in string format

    • printHTML

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