Enum VariableStateResult

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

    public enum VariableStateResult
    extends java.lang.Enum<VariableStateResult>
    Indicates the outcome of attempting to restrict the possible values of a variable.
    See Also:
    VariableState
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FAILED
      Applying the restriction would leave the variable with no possible values.
      NO_CHANGE
      The variable already conformed to the restriction.
      UPDATED
      The possible values of the variable were updated.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private VariableStateResult()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static VariableStateResult valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static VariableStateResult[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • UPDATED

        public static final VariableStateResult UPDATED
        The possible values of the variable were updated.

        e.g. Given X has a minimum value of 4 and a maximum value of 7, this result would be returned when attempting to set the maximum value to 6.

      • FAILED

        public static final VariableStateResult FAILED
        Applying the restriction would leave the variable with no possible values.

        e.g. Given X has a minimum value of 4 and a maximum value of 7, this result would be returned when attempting to set the maximum value to 3.

      • NO_CHANGE

        public static final VariableStateResult NO_CHANGE
        The variable already conformed to the restriction.

        e.g. Given X has a minimum value of 4 and a maximum value of 7, this result would be returned when attempting to set the maximum value to 8.

    • Constructor Detail

      • VariableStateResult

        private VariableStateResult()
    • Method Detail

      • values

        public static VariableStateResult[] 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 (VariableStateResult c : VariableStateResult.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static VariableStateResult 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