|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.shared.ldap.util.Enum
org.apache.directory.shared.ldap.util.ValuedEnum
org.apache.directory.shared.ldap.message.ScopeEnum
public class ScopeEnum
Type-safe scope parameter enumeration.
Field Summary | |
---|---|
static ScopeEnum |
BASEOBJECT
Search scope parameter enum for base object search |
static int |
BASEOBJECT_LDAPVAL
LDAP search scope parameter value for base object search |
static int |
BASEOBJECT_VAL
Search scope parameter value for base object search |
static ScopeEnum |
SINGLELEVEL
Search scope parameter enum for single level search |
static int |
SINGLELEVEL_LDAPVAL
LDAP search scope parameter value for single level search |
static int |
SINGLELEVEL_VAL
Search scope parameter value for single level search |
static ScopeEnum |
WHOLESUBTREE
Search scope parameter enum for whole subtree level search |
static int |
WHOLESUBTREE_LDAPVAL
LDAP search scope parameter value for whole subtree level search |
static int |
WHOLESUBTREE_VAL
Search scope parameter value for whole subtree level search |
Fields inherited from class org.apache.directory.shared.ldap.util.Enum |
---|
iToString |
Method Summary | |
---|---|
int |
getLdapValue()
Gets the LdapValue for the scope enumeration as opposed to the JNDI value which is returned using getValue(). |
static ScopeEnum |
getScope(SearchControls a_controls)
Gets the type safe enumeration constant corresponding to a SearchControls scope value. |
Methods inherited from class org.apache.directory.shared.ldap.util.ValuedEnum |
---|
compareTo, getEnum, getValue, toString |
Methods inherited from class org.apache.directory.shared.ldap.util.Enum |
---|
equals, getEnum, getEnumClass, getEnumList, getEnumMap, getName, hashCode, iterator, readResolve |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int BASEOBJECT_VAL
public static final int SINGLELEVEL_VAL
public static final int WHOLESUBTREE_VAL
public static final int BASEOBJECT_LDAPVAL
public static final int SINGLELEVEL_LDAPVAL
public static final int WHOLESUBTREE_LDAPVAL
public static final ScopeEnum BASEOBJECT
public static final ScopeEnum SINGLELEVEL
public static final ScopeEnum WHOLESUBTREE
Method Detail |
---|
public static ScopeEnum getScope(SearchControls a_controls)
a_controls
- the SearchControls whose scope value we convert to enum
public int getLdapValue()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |