Package com.unboundid.ldap.sdk.controls

Enum PersistentSearchChangeType

java.lang.Object
java.lang.Enum<PersistentSearchChangeType>
com.unboundid.ldap.sdk.controls.PersistentSearchChangeType
All Implemented Interfaces:
Serializable, Comparable<PersistentSearchChangeType>, java.lang.constant.Constable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum PersistentSearchChangeType extends Enum<PersistentSearchChangeType>
This enum defines a set of change types that can be associated with persistent search operations. Change types may be used in the PersistentSearchRequestControl, as well as in EntryChangeNotificationControls returned in search result entries as part of a persistent search.

  • Enum Constant Details

  • Method Details

    • values

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

    • valueOf

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

    • getName

      @NotNull public 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

      @Nullable 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

      @Nullable public static PersistentSearchChangeType forName(@NotNull 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.

    • allChangeTypes

      @NotNull public static Set<PersistentSearchChangeType> allChangeTypes()
      Retrieves a set containing all defined change types.
      Returns:
      A set containing all defined change types.

    • encodeChangeTypes

      public static int encodeChangeTypes(@NotNull 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(@NotNull 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

      @NotNull public static Set<PersistentSearchChangeType> decodeChangeTypes(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

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