edu.internet2.middleware.grouper.ldap

Enum LdapSearchScope

java.lang.Object

java.lang.Enum<LdapSearchScope>

edu.internet2.middleware.grouper.ldap.LdapSearchScope

All Implemented Interfaces:

Serializable, Comparable<LdapSearchScope>

public enum LdapSearchScope
extends Enum<LdapSearchScope>

ldap search scope

Enum Constant Summary

Enum Constants

Enum Constant and Description
OBJECT_SCOPE search an object
ONELEVEL_SCOPE search in the one level DN of the tree
SUBTREE_SCOPE search in subtrees of the DN of the tree

Method Summary

Methods

Modifier and Type	Method and Description
abstract int	getSeachControlsConstant()
static LdapSearchScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static LdapSearchScope	valueOfIgnoreCase(String string, boolean exceptionOnNull) do a case-insensitive matching
static LdapSearchScope[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OBJECT_SCOPE

public static final LdapSearchScope OBJECT_SCOPE

search an object

ONELEVEL_SCOPE

public static final LdapSearchScope ONELEVEL_SCOPE

search in the one level DN of the tree

SUBTREE_SCOPE

public static final LdapSearchScope SUBTREE_SCOPE

search in subtrees of the DN of the tree

Method Detail

values

public static LdapSearchScope[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LdapSearchScope c : LdapSearchScope.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LdapSearchScope valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getSeachControlsConstant

public abstract int getSeachControlsConstant()

Returns:

the constant

valueOfIgnoreCase

public static LdapSearchScope valueOfIgnoreCase(String string,
                                boolean exceptionOnNull)

do a case-insensitive matching

Parameters:

string -

exceptionOnNull - will not allow null or blank entries

Returns:

the enum or null or exception if not found