Package org.evoludo.util

Class CLOption.Category

Object
Category
Enclosing class:
CLOption
public static class CLOption.Category extends Object
Handle different categories of options. This is mostly used to provide a more readable and useful help screen for options organized in categories.

  • Field Details

    • priority

      int priority
      The priority of this category. Higher priorities are printed first.

    • Global

      public static final CLOption.Category Global
      The category for global options.

    • GUI

      public static final CLOption.Category GUI
      The category for user interface specific options.

    • Simulation

      public static final CLOption.Category Simulation
      The category for simulation specific options.

    • Model

      public static final CLOption.Category Model
      The category for model specific options.

    • Module

      public static final CLOption.Category Module
      The category for module specific options.

  • Constructor Details

    • Category

      public Category(String header)
      Create a new category with the header header. The priority is set to 0.
      Parameters:
      header - the header of the category

    • Category

      public Category(String header, int priority)
      Create a new category with header and priority.
      Parameters:
      header - the header of the category
      priority - the priority of the category

  • Method Details

    • getPriority

      public int getPriority()
      Get the priority of this category. Parameters are grouped by priority in help display.
      Returns:
      the priority

    • setHeader

      public void setHeader(String header)
      Set the header of category for help display.
      Parameters:
      header - the header

    • getHeader

      public String getHeader()
      Get the header of category for help display.
      Returns:
      the header