Class CLOption.SimpleKey

Object
SimpleKey
All Implemented Interfaces:
CLOption.Key
Enclosing class:
CLOption

public static class CLOption.SimpleKey extends Object implements CLOption.Key
Simple key for command line options. Keys are similar to enums but more flexible because the set of keys can be modified at runtime.
  • Field Details

    • key

      String key
      The key of the command line option.
    • title

      String title
      The title of the command line option. Brief description of the key for the help screen.
  • Constructor Details

    • SimpleKey

      public SimpleKey(String key, String title)
      Create a new key with the name key and title title.
      Parameters:
      key - the key of the command line option
      title - the title of the command line option
  • Method Details

    • getKey

      public String getKey()
      Description copied from interface: CLOption.Key
      Return key of in this collection. Used when parsing command line options.
      Specified by:
      getKey in interface CLOption.Key
      Returns:
      the key of the command line option
    • getTitle

      public String getTitle()
      Description copied from interface: CLOption.Key
      Brief description of purpose of this key. Used in GUI and in help display.
      Specified by:
      getTitle in interface CLOption.Key
      Returns:
      the title of the command line option
      See Also: