public enum LDAPSearchScope extends Enum<LDAPSearchScope>
The following search scope values are defined:
BASE
-- search only the base DN.ONE
-- search only entries under the base DN.SUB
-- search the base DN and all entries within its subtree.SUBORDINATE_SUBTREE
-- search any subordinate entries below the base DN,
exclude the base entry.Enum Constant and Description |
---|
BASE
Search only the base DN.
|
ONE
Search only entries under the base DN.
|
SUB
Search the base DN and all entries within its subtree.
|
SUBORDINATE_SUBTREE
Search any subordinate entries (to any depth) below the base DN, exclude the base entry.
|
Modifier and Type | Method and Description |
---|---|
int |
intValue()
Returns the integer value for this search scope.
|
static LDAPSearchScope |
valueOf(int intValue)
Returns the search scope with the specified integer value.
|
static LDAPSearchScope |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static LDAPSearchScope[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final LDAPSearchScope BASE
public static final LDAPSearchScope ONE
public static final LDAPSearchScope SUB
public static final LDAPSearchScope SUBORDINATE_SUBTREE
public static LDAPSearchScope[] values()
for (LDAPSearchScope c : LDAPSearchScope.values()) System.out.println(c);
public static LDAPSearchScope valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic static LDAPSearchScope valueOf(int intValue)
intValue
- the integer value for which to get the matching search scope.IllegalArgumentException
- if the specified value does not match any of
the predefined scopes.public int intValue()