public enum SearchScope extends Enum<SearchScope>
Enum Constant and Description |
---|
OBJECT
Base scope
|
ONELEVEL
One Level scope
|
SUBTREE
Subtree scope
|
Modifier and Type | Method and Description |
---|---|
String |
getLdapUrlValue()
Gets the LDAP URL value for the scope: according to RFC 2255 this is
either base, one, or sub.
|
int |
getScope()
Gets the corresponding scope constant value as defined in
RFC 4511.
|
SearchScope |
getScope(String scope)
Gets the SearchScope associated with a scope String
|
static SearchScope |
getSearchScope(int scope)
Gets the SearchScope enumerated type for the corresponding
scope numeric value.
|
static int |
getSearchScope(String scope)
Gets the SearchScope enumerated type for the corresponding
scope value of either base, one or sub.
|
String |
toString() |
static SearchScope |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static SearchScope[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final SearchScope OBJECT
public static final SearchScope ONELEVEL
public static final SearchScope SUBTREE
public static SearchScope[] values()
for (SearchScope c : SearchScope.values()) System.out.println(c);
public static SearchScope 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 String getLdapUrlValue()
public int getScope()
public static SearchScope getSearchScope(int scope)
scope
- the numeric value to get SearchScope forpublic SearchScope getScope(String scope)
scope
- The scope we are looking forpublic static int getSearchScope(String scope)
scope
- the scope value to get SearchScope forpublic String toString()
toString
in class Enum<SearchScope>
Copyright © 2003–2020 The Apache Software Foundation. All rights reserved.