|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<SearchScope>
org.apache.directory.shared.ldap.filter.SearchScope
public enum SearchScope
A search scope enumerated type.
Enum Constant Summary | |
---|---|
OBJECT
|
|
ONELEVEL
|
|
SUBTREE
|
Method Summary | |
---|---|
java.lang.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. |
static SearchScope |
getSearchScope(int scope)
Gets the SearchScope enumerated type for the corresponding scope numeric value. |
static int |
getSearchScope(java.lang.String ldapUrlValue)
Gets the SearchScope enumerated type for the corresponding LDAP URL scope value of either base, one or sub. |
java.lang.String |
toString()
|
static SearchScope |
valueOf(java.lang.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. |
Methods inherited from class java.lang.Enum |
---|
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Enum Constant Detail |
---|
public static final SearchScope OBJECT
public static final SearchScope ONELEVEL
public static final SearchScope SUBTREE
Method Detail |
---|
public static SearchScope[] values()
for (SearchScope c : SearchScope.values()) System.out.println(c);
public static SearchScope valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.
java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified name
java.lang.NullPointerException
- if the argument is nullpublic java.lang.String getLdapUrlValue()
public int getScope()
public static SearchScope getSearchScope(int scope)
scope
- the numeric value to get SearchScope for
public static int getSearchScope(java.lang.String ldapUrlValue)
ldapUrlValue
- the LDAP URL scope value to get SearchScope for
public java.lang.String toString()
toString
in class java.lang.Enum<SearchScope>
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |