|
||||||||||
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 | |
---|---|
int |
getJndiScope()
Gets the corresponding JNDI scope constant value as defined in SearchControls. |
java.lang.String |
getLdapUrlValue()
Gets the LDAP URL value for the scope: according to RFC 2255 this is either base, one, or sub. |
static SearchScope |
getSearchScope(int jndiScope)
Gets the SearchScope enumerated type for the corresponding SearchControls scope setting. |
static SearchScope |
getSearchScope(javax.naming.directory.SearchControls searchControls)
Gets the SearchScope enumerated type for the corresponding SearchControls scope setting. |
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're declared. |
Methods inherited from class java.lang.Enum |
---|
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
Methods inherited from class java.lang.Object |
---|
finalize, 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 final 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 namepublic java.lang.String getLdapUrlValue()
public int getJndiScope()
SearchControls.OBJECT_SCOPE
,
SearchControls.ONELEVEL_SCOPE
,
SearchControls.SUBTREE_SCOPE
public static SearchScope getSearchScope(javax.naming.directory.SearchControls searchControls)
searchControls
- the search controls to get SearchScope for
public static SearchScope getSearchScope(int jndiScope)
searchControls
- the search controls to get SearchScope for
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |