Package org.ldaptive
Enum Class SearchScope
- All Implemented Interfaces:
Serializable
,Comparable<SearchScope>
,Constable
Enum to define the type of search scope.
scope ENUMERATED { baseObject (0), singleLevel (1), wholeSubtree (2), subordinateSubtree (3), ... }
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionbase object search.single level search.subordinate subtree search.whole subtree search. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic SearchScope
Returns the enum constant of this class with the specified name.static SearchScope[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
OBJECT
base object search. -
ONELEVEL
single level search. -
SUBTREE
whole subtree search. -
SUBORDINATE
subordinate subtree search. See draft-sermersheim-ldap-subordinate-scope.
-
-
Constructor Details
-
SearchScope
private SearchScope()
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-