|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<MatchingEntryCountType>
com.unboundid.ldap.sdk.unboundidds.controls.MatchingEntryCountType
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum MatchingEntryCountType
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.This enum defines the set of count types that may be used in a matching entry count response control.
Enum Constant Summary | |
---|---|
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 | |
---|---|
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 |
---|
public static final MatchingEntryCountType EXAMINED_COUNT
public static final MatchingEntryCountType UNEXAMINED_COUNT
public static final MatchingEntryCountType UPPER_BOUND
public static final MatchingEntryCountType UNKNOWN
Method Detail |
---|
public static MatchingEntryCountType[] values()
for (MatchingEntryCountType c : MatchingEntryCountType.values()) System.out.println(c);
public static MatchingEntryCountType valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.
java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified name
java.lang.NullPointerException
- if the argument is nullpublic byte getBERType()
public boolean isMoreSpecificThan(MatchingEntryCountType t)
t
- The matching entry count type value to compare against this
matching entry count type. It must not be null
.
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.public boolean isLessSpecificThan(MatchingEntryCountType t)
t
- The matching entry count type value to compare against this
matching entry count type. It must not be null
.
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.public static MatchingEntryCountType valueOf(byte berType)
berType
- The BER type for the count type value to retrieve.
null
if there is no corresponding count type value.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |