Module dev.civl.mc
Package dev.civl.mc.model.IF

Enum Class CIVLProperty

java.lang.Object
java.lang.Enum<CIVLProperty>
dev.civl.mc.model.IF.CIVLProperty
All Implemented Interfaces:
Serializable, Comparable<CIVLProperty>, Constable
public enum CIVLProperty extends Enum<CIVLProperty>
Enum class for representing different properties that CIVL checks for. Each CIVLProperty specifies its title which is displayed in the list of standard properties checked after an error free run of civl verify. Most CIVLProperties are configurable by a command line option which is part of their specification. CIVLProperties which do not have an associated command line option are called unconfigurable.

  • Enum Constant Details

  • Method Details

    • values

      public static CIVLProperty[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static CIVLProperty valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getAllUnconfigurableProperties

      public static final List<CIVLProperty> getAllUnconfigurableProperties()
      Returns:
      returns all of the CIVLProperty's which are unconfigurable

    • getAllConfigurableProperties

      public static final List<CIVLProperty> getAllConfigurableProperties()
      Returns:
      returns all of the CIVLProperty's which are configurable

    • getOption

      public dev.civl.gmc.Option getOption()
      Returns:
      returns the option which controls this property if it is configurable. Returns null if it is unconfigurable,

    • getPropertyTitle

      public String getPropertyTitle()
      Returns:
      returns the property's title.