com.unboundid.ldap.sdk.unboundidds.controls

Enum MatchingEntryCountType

java.lang.Object

java.lang.Enum<MatchingEntryCountType>

com.unboundid.ldap.sdk.unboundidds.controls.MatchingEntryCountType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MatchingEntryCountType>

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum MatchingEntryCountType
extends java.lang.Enum<MatchingEntryCountType>

This enum defines the set of count types that may be used in a matching entry count response control.

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 and Description
EXAMINED_COUNT The count type that indicates that the server was able to determine the exact number of entries matching the search criteria and examined them to exclude any entries that would not be returned to the client in the course of processing a normal search with the same criteria.
UNEXAMINED_COUNT The count type that indicates that the server was able to determine the exact number of entries matching the search criteria, but did not examine them to exclude any entries that might not actually be returned to the client in the course of processing a normal search with the same criteria (e.g., entries that the requester doesn't have permission to access, or entries like LDAP subentries, replication conflict entries, or soft-deleted entries that are returned only for special types of requests).
UNKNOWN The count type that indicates that the server was unable to make any meaningful determination about the number of entries matching the search criteria.
UPPER_BOUND The count type that indicates that the server was unable to determine the exact number of entries matching the search criteria, but was able to determine an upper bound for the number of matching entries.

Method Summary

Modifier and Type	Method and Description
static MatchingEntryCountType	forName(java.lang.String name) Retrieves the matching entry count type with the specified name.
byte	getBERType() Retrieves the BER type for this count type value.
boolean	isLessSpecificThan(MatchingEntryCountType t) Indicates whether this matching entry count type is considered less specific than the provided count type.
boolean	isMoreSpecificThan(MatchingEntryCountType t) Indicates whether this matching entry count type is considered more specific than the provided count type.
static MatchingEntryCountType	valueOf(byte berType) Retrieves the count type value for the provided BER type.
static MatchingEntryCountType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MatchingEntryCountType[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EXAMINED_COUNT

public static final MatchingEntryCountType EXAMINED_COUNT

The count type that indicates that the server was able to determine the exact number of entries matching the search criteria and examined them to exclude any entries that would not be returned to the client in the course of processing a normal search with the same criteria.

UNEXAMINED_COUNT

public static final MatchingEntryCountType UNEXAMINED_COUNT

The count type that indicates that the server was able to determine the exact number of entries matching the search criteria, but did not examine them to exclude any entries that might not actually be returned to the client in the course of processing a normal search with the same criteria (e.g., entries that the requester doesn't have permission to access, or entries like LDAP subentries, replication conflict entries, or soft-deleted entries that are returned only for special types of requests).

UPPER_BOUND

public static final MatchingEntryCountType UPPER_BOUND

The count type that indicates that the server was unable to determine the exact number of entries matching the search criteria, but was able to determine an upper bound for the number of matching entries.

UNKNOWN

public static final MatchingEntryCountType UNKNOWN

The count type that indicates that the server was unable to make any meaningful determination about the number of entries matching the search criteria.

Method Detail

values

public static MatchingEntryCountType[] 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 (MatchingEntryCountType c : MatchingEntryCountType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

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

getBERType

public byte getBERType()

Retrieves the BER type for this count type value.

Returns:

The BER type for this count type value.

isMoreSpecificThan

public boolean isMoreSpecificThan(@NotNull
                                  MatchingEntryCountType t)

Indicates whether this matching entry count type is considered more specific than the provided count type. The following order of precedence, from most specific to least specific, will be used:

1. EXAMINED_COUNT
2. UNEXAMINED_COUNT
3. UPPER_BOUND
4. UNKNOWN

Parameters:

t - The matching entry count type value to compare against this matching entry count type. It must not be null.

Returns:

true if the provided matching entry count type value is considered more specific than this matching entry count type, or false if the provided count type is the same as or less specific than this count type.

isLessSpecificThan

public boolean isLessSpecificThan(@NotNull
                                  MatchingEntryCountType t)

Indicates whether this matching entry count type is considered less specific than the provided count type. The following order of precedence, from most specific to least specific, will be used:

1. EXAMINED_COUNT
2. UNEXAMINED_COUNT
3. UPPER_BOUND
4. UNKNOWN

Parameters:

t - The matching entry count type value to compare against this matching entry count type. It must not be null.

Returns:

true if the provided matching entry count type value is considered less specific than this matching entry count type, or false if the provided count type is the same as or more specific than this count type.

valueOf

@Nullable
public static MatchingEntryCountType valueOf(byte berType)

Retrieves the count type value for the provided BER type.

Parameters:

berType - The BER type for the count type value to retrieve.

Returns:

The count type value that corresponds to the provided BER type, or null if there is no corresponding count type value.

forName

@Nullable
public static MatchingEntryCountType forName(@NotNull
                                                       java.lang.String name)

Retrieves the matching entry count type with the specified name.

Parameters:

name - The name of the matching entry count type to retrieve. It must not be null.

Returns:

The requested matching entry count type, or null if no such type is defined.