Enum LDAPSearchScope
- java.lang.Object
-
- java.lang.Enum<LDAPSearchScope>
-
- com.opencloud.slee.resources.ldap.objects.LDAPSearchScope
-
- All Implemented Interfaces:
Serializable
,Comparable<LDAPSearchScope>
public enum LDAPSearchScope extends Enum<LDAPSearchScope>
Represents a data type for search scope values.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 Summary
Enum Constants Enum Constant 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.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.
-
-
-
Enum Constant Detail
-
BASE
public static final LDAPSearchScope BASE
Search only the base DN.
-
ONE
public static final LDAPSearchScope ONE
Search only entries under the base DN.
-
SUB
public static final LDAPSearchScope SUB
Search the base DN and all entries within its subtree.
-
SUBORDINATE_SUBTREE
public static final LDAPSearchScope SUBORDINATE_SUBTREE
Search any subordinate entries (to any depth) below the base DN, exclude the base entry.
-
-
Method Detail
-
values
public static LDAPSearchScope[] 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 (LDAPSearchScope c : LDAPSearchScope.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static LDAPSearchScope 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 nameNullPointerException
- if the argument is null
-
valueOf
public static LDAPSearchScope valueOf(int intValue)
Returns the search scope with the specified integer value.- Parameters:
intValue
- the integer value for which to get the matching search scope.- Returns:
- the search scope with the specified integer value.
- Throws:
IllegalArgumentException
- if the specified value does not match any of the predefined scopes.
-
intValue
public int intValue()
Returns the integer value for this search scope.- Returns:
- the integer value for this search scope.
-
-