Enum ExpectedValueType

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

    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public enum ExpectedValueType
    extends java.lang.Enum<ExpectedValueType>
    An enum that defines the possible values that may be used for the expectedType element of a ContainsFieldJSONObjectFilter.
    NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BOOLEAN
      Indicates that the target field may have a value of true or false.
      EMPTY_ARRAY
      Indicates that the target field may have a value that is an array containing zero elements.
      NON_EMPTY_ARRAY
      Indicates that the target field may have a value that is an array containing at least one element.
      NULL
      Indicates that the target field may have a value of null.
      NUMBER
      Indicates that the target field may have a value that is a number.
      OBJECT
      Indicates that the target field may have a value that is a JSON object.
      STRING
      Indicates that the target field may have a value that is a string.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ExpectedValueType forName​(java.lang.String name)
      Retrieves the expected value type with the specified name.
      java.lang.String toString()
      Retrieves a string representation of this expected value type.
      static ExpectedValueType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ExpectedValueType[] 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, valueOf
      • Methods inherited from class java.lang.Object

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

      • BOOLEAN

        public static final ExpectedValueType BOOLEAN
        Indicates that the target field may have a value of true or false.
      • EMPTY_ARRAY

        public static final ExpectedValueType EMPTY_ARRAY
        Indicates that the target field may have a value that is an array containing zero elements.
      • NON_EMPTY_ARRAY

        public static final ExpectedValueType NON_EMPTY_ARRAY
        Indicates that the target field may have a value that is an array containing at least one element. No restriction will be placed on the type of elements that may be held in the array.
      • NULL

        public static final ExpectedValueType NULL
        Indicates that the target field may have a value of null. null.
      • NUMBER

        public static final ExpectedValueType NUMBER
        Indicates that the target field may have a value that is a number.
      • OBJECT

        public static final ExpectedValueType OBJECT
        Indicates that the target field may have a value that is a JSON object.
      • STRING

        public static final ExpectedValueType STRING
        Indicates that the target field may have a value that is a string.
    • Method Detail

      • values

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

        public static ExpectedValueType 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
      • forName

        public static ExpectedValueType forName​(java.lang.String name)
        Retrieves the expected value type with the specified name.
        Parameters:
        name - The name of the expected value type to retrieve.
        Returns:
        The expected value type with the specified name, ro null if there is no type with the given name.
      • toString

        public java.lang.String toString()
        Retrieves a string representation of this expected value type.
        Overrides:
        toString in class java.lang.Enum<ExpectedValueType>
        Returns:
        A string representation of this expected value type.