Enum OptionState

  • All Implemented Interfaces:
    Serializable, Comparable<OptionState>

    public enum OptionState
    extends Enum<OptionState>

    The state of processing a change to an option. One of:

    • RequiresIndexDocuments: The option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
    • Processing: The option's latest value is in the process of being activated.
    • Active: The option's latest value is fully deployed.
    • FailedToValidate: The option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
    • Enum Constant Detail

      • RequiresIndexDocuments

        public static final OptionState RequiresIndexDocuments
      • Processing

        public static final OptionState Processing
      • FailedToValidate

        public static final OptionState FailedToValidate
    • Method Detail

      • values

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

        public static OptionState valueOf​(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:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • fromValue

        public static OptionState fromValue​(String value)
        Use this in place of valueOf.
        Parameters:
        value - real value
        Returns:
        OptionState corresponding to the value