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

Class CLIParameter

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

  • Constructor Details

    • CLIParameter

      public CLIParameter()

  • Method Details

    • getName

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

    • setName

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

    • getType

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

    • setType

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

    • getDescription

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

    • setDescription

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

    • getOptional

      public Boolean getOptional()
      Return whether the parameter is optional
      Returns:
      true if the parameter is optional, false otherwise

    • setOptional

      public void setOptional(Boolean optional)
      Set whether the parameter is optional
      Parameters:
      optional - true if the parameter is to be optional, false otherwise

    • getRepeatable

      public Boolean getRepeatable()
      Return whether the parameter is repeatable
      Returns:
      true if the parameter is repeatable, false otherwise

    • setRepeatable

      public void setRepeatable(Boolean repeatable)
      Set whether the parameter is repeatable
      Parameters:
      repeatable - true if the parameter is to be repeatable, false otherwise

    • toString

      public String toString()
      Returns a String representation of the parameter
      Overrides:
      toString in class Object
      Returns:
      a String representation of the parameter

    • printHTML

      public StringBuilder printHTML(StringBuilder htmlDoc)
      Appends the StringBuilder provided by the caller with HTML code that prints a table with the parameter's name and a description. If applicable, the parameter is marked as optional and/or repeatable.
      Parameters:
      htmlDoc - A StringBuilder that may already contain information.
      Returns:
      The same StringBuilder, appended information on the option.