Interface CLOption.Key

All Known Implementing Classes:
CLOption.SimpleKey, Continuous.Benefits, Continuous.ColorModelType, Continuous.Costs, GeometryType, IBS.MigrationType, IBS.ScoringType, IBS.Statistics.Type, IBSC.Init.Type, IBSD.Init.Type, IBSD.OptimizationType, IBSGroup.SamplingType, Map2Fitness.Map, ModelType, Mutation.Continuous.Type, Mutation.Discrete.Type, ODEInitialize.InitType, PDEInitialize.Type, PlayerUpdate.Type, PopulationUpdate.Type, SpeciesUpdate.Type
Enclosing class:
CLOption
public static interface CLOption.Key
The interface for keys of command line options. Options may offer several distinct settings in the form of keys.
Author:
Christoph Hauert

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    getDescription()
    Optional: long description of purpose of this key.
    String
    getKey()
    Return key of in this collection.
    String
    getTitle()
    Brief description of purpose of this key.

  • Method Details

    • getKey

      String getKey()
      Return key of in this collection. Used when parsing command line options.
      Returns:
      the key of the command line option

    • getTitle

      String getTitle()
      Brief description of purpose of this key. Used in GUI and in help display.
      Returns:
      the title of the command line option
      See Also:

    • getDescription

      default String getDescription()
      Optional: long description of purpose of this key. Used in help display. Defaults to brief description.

      Note: the description string may contain any UTF-8 characters as well as HTML character entities. If necessary they will be escaped and converted to UTF-8 for display in XML documents.

      Returns:
      the description of the command line option
      See Also: