public final class SearchScope extends Object
Modifier and Type | Class and Description |
---|---|
static class |
SearchScope.Enum
Contains equivalent values for the SearchScope values.
|
Modifier and Type | Field and Description |
---|---|
static SearchScope |
BASE_OBJECT
The scope is constrained to the search base entry.
|
static SearchScope |
SINGLE_LEVEL
The scope is constrained to the immediate subordinates of the search base entry.
|
static SearchScope |
SUBORDINATES
The scope is constrained to all the subordinates of the search base
entry, but does not include the search base entry itself (as wholeSubtree
does).
|
static SearchScope |
WHOLE_SUBTREE
The scope is constrained to the search base entry and to all its subordinates.
|
Modifier and Type | Method and Description |
---|---|
SearchScope.Enum |
asEnum()
Returns the enum equivalent for this search scope.
|
boolean |
equals(Object obj) |
int |
hashCode() |
int |
intValue()
Returns the integer value of this search scope as defined in RFC 4511
section 4.5.1.2.
|
String |
toString()
Returns the string representation of this search scope as defined in RFC
4516.
|
static SearchScope |
valueOf(int intValue)
Returns the search scope having the specified integer value as defined in
RFC 4511 section 4.5.1.2.
|
static SearchScope |
valueOf(String name)
Returns the search scope having the specified name as defined in RFC 4511
section 4.5.1.2.
|
static List<SearchScope> |
values()
Returns an unmodifiable list containing the set of available search
scopes indexed on their integer value as defined in RFC 4511 section
4.5.1.2.
|
public static final SearchScope BASE_OBJECT
public static final SearchScope SINGLE_LEVEL
public static final SearchScope WHOLE_SUBTREE
public static final SearchScope SUBORDINATES
public static SearchScope valueOf(int intValue)
intValue
- The integer value of the search scope.null
if there was no search scope
associated with intValue
.public static SearchScope valueOf(String name)
name
- the name of the search scope to returnnull
if there was no search scope
associated with name
.NullPointerException
- if name is nullpublic static List<SearchScope> values()
public int intValue()
public SearchScope.Enum asEnum()
SearchScope.Enum.UNKNOWN
if this is an unknown search scope.Copyright 2010-2022 ForgeRock AS.