Enum Class PersistentSearchChangeType

java.lang.Object
java.lang.Enum<PersistentSearchChangeType>
org.forgerock.opendj.ldap.controls.PersistentSearchChangeType
All Implemented Interfaces:
Serializable, Comparable<PersistentSearchChangeType>, java.lang.constant.Constable

public enum PersistentSearchChangeType extends Enum<PersistentSearchChangeType>
A persistent search change type as defined in draft-ietf-ldapext-psearch is used to indicate the type of update operation that caused an entry change notification to occur.
See Also:
  • Enum Constant Details

    • ADD

      public static final PersistentSearchChangeType ADD
      Indicates that an Add operation triggered the entry change notification.
    • DELETE

      public static final PersistentSearchChangeType DELETE
      Indicates that an Delete operation triggered the entry change notification.
    • MODIFY

      public static final PersistentSearchChangeType MODIFY
      Indicates that an Modify operation triggered the entry change notification.
    • MODIFY_DN

      public static final PersistentSearchChangeType MODIFY_DN
      Indicates that an Modify DN operation triggered the entry change notification.
  • Method Details

    • values

      public static PersistentSearchChangeType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static PersistentSearchChangeType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null
    • toString

      public String toString()
      Overrides:
      toString in class Enum<PersistentSearchChangeType>
    • intValue

      public int intValue()
      Returns the integer value for this change type as defined in the internet draft.
      Returns:
      The integer value for this change type.
    • valueOf

      public static PersistentSearchChangeType valueOf(int value)
      Returns the enum value that would return the provided argument value from its intValue method.
      Parameters:
      value - The value to match.
      Returns:
      The appropriate enum value.
    • toSet

      public static Set<PersistentSearchChangeType> toSet(int changeTypes) throws DecodeException
      Returns the set of enum values corresponding to the encoded persistent change types.
      Parameters:
      changeTypes - The persistent change types encoded as an int.
      Returns:
      set of enum values corresponding to the encoded persistent change types.
      Throws:
      DecodeException - if the change types value is invalid