Enum PersistentSearchChangeType

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ADD
      Indicates that the change type is for an add operation.
      DELETE
      Indicates that the change type is for a delete operation.
      MODIFY
      Indicates that the change type is for a modify operation.
      MODIFY_DN
      Indicates that the change type is for a modify DN operation.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.Set<PersistentSearchChangeType> allChangeTypes()
      Retrieves a set containing all defined change types.
      static java.util.Set<PersistentSearchChangeType> decodeChangeTypes​(int changeTypes)
      Decodes the provided set of change types from the provided value.
      static int encodeChangeTypes​(PersistentSearchChangeType... changeTypes)
      Encodes the provided set of change types into an integer value suitable for use as the change types for the persistent search request control.
      static int encodeChangeTypes​(java.util.Collection<PersistentSearchChangeType> changeTypes)
      Encodes the provided set of change types into an integer value suitable for use as the change types for the persistent search request control.
      static PersistentSearchChangeType forName​(java.lang.String name)
      Retrieves the persistent search change type with the specified name.
      java.lang.String getName()
      Retrieves the human-readable name for this change type.
      int intValue()
      Retrieves the integer value for this change type.
      java.lang.String toString()
      Retrieves a string representation for this persistent search change type.
      static PersistentSearchChangeType valueOf​(int intValue)
      Retrieves the persistent search change type with the specified int value.
      static PersistentSearchChangeType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PersistentSearchChangeType[] 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
    • Method Detail

      • values

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

        public static PersistentSearchChangeType 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
      • getName

        public java.lang.String getName()
        Retrieves the human-readable name for this change type.
        Returns:
        The human-readable name for this change type.
      • intValue

        public int intValue()
        Retrieves the integer value for this change type.
        Returns:
        The integer value for this change type.
      • valueOf

        public static PersistentSearchChangeType valueOf​(int intValue)
        Retrieves the persistent search change type with the specified int value.
        Parameters:
        intValue - the numeric value associated with the change type.
        Returns:
        The associated change type, or null if there is no persistent search change type with the specified set of values.
      • forName

        public static PersistentSearchChangeType forName​(java.lang.String name)
        Retrieves the persistent search change type with the specified name.
        Parameters:
        name - The name of the change type for which to retrieve the name. It must not be null.
        Returns:
        The requested persistent search change type, or null if there is no change type with the given name.
      • encodeChangeTypes

        public static int encodeChangeTypes​(PersistentSearchChangeType... changeTypes)
        Encodes the provided set of change types into an integer value suitable for use as the change types for the persistent search request control.
        Parameters:
        changeTypes - The set of change types to be encoded.
        Returns:
        An integer value containing the encoded representation of the change types.
      • encodeChangeTypes

        public static int encodeChangeTypes​(java.util.Collection<PersistentSearchChangeType> changeTypes)
        Encodes the provided set of change types into an integer value suitable for use as the change types for the persistent search request control.
        Parameters:
        changeTypes - The set of change types to be encoded.
        Returns:
        An integer value containing the encoded representation of the change types.
      • decodeChangeTypes

        public static java.util.Set<PersistentSearchChangeTypedecodeChangeTypes​(int changeTypes)
        Decodes the provided set of change types from the provided value.
        Parameters:
        changeTypes - The int value representing the encoded set of change types.
        Returns:
        A list of the change types encoded in the provided value.
      • toString

        public java.lang.String toString()
        Retrieves a string representation for this persistent search change type.
        Overrides:
        toString in class java.lang.Enum<PersistentSearchChangeType>
        Returns:
        A string representation for this persistent search change type.