Enum OptionType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<OptionType>

    public enum OptionType
    extends java.lang.Enum<OptionType>
    The available types for Command options.
    • Method Detail

      • values

        public static OptionType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (OptionType c : OptionType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static OptionType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getKey

        public int getKey()
        The raw value for this type or -1 for UNKNOWN
        Returns:
        The raw value
      • canSupportChoices

        public boolean canSupportChoices()
        Whether options of this type support predefined choices.
        Returns:
        True, if you can use choices for this type.
      • fromKey

        @Nonnull
        public static OptionType fromKey​(int key)
        Converts the provided raw type to the enum constant.
        Parameters:
        key - The raw type
        Returns:
        The OptionType constant or UNKNOWN