net.java.sip.communicator.service.ldap
Enum LdapConstants.Scope

java.lang.Object
  java.lang.Enum<LdapConstants.Scope>
      net.java.sip.communicator.service.ldap.LdapConstants.Scope

All Implemented Interfaces:

Serializable, Comparable<LdapConstants.Scope>

Enclosing interface:

LdapConstants

public static enum LdapConstants.Scope
extends Enum<LdapConstants.Scope>

search scope in the directory: one level, subtree

Enum Constant Summary

ONE
One level search.

SUB
Subtree search.

Method Summary

static LdapConstants.Scope	defaultValue() Returns default value for scope.
int	getConstant() Returns the matching constant field from SearchControls
static LdapConstants.Scope	valueOf(String name) Returns the enum constant of this type with the specified name.
static LdapConstants.Scope[]	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

SUB

public static final LdapConstants.Scope SUB

Subtree search.

ONE

public static final LdapConstants.Scope ONE

One level search.

Method Detail

values

public static LdapConstants.Scope[] 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 (LdapConstants.Scope c : LdapConstants.Scope.values())
    System.out.println(c);

Returns:

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

valueOf

public static LdapConstants.Scope 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

defaultValue

public static LdapConstants.Scope defaultValue()

Returns default value for scope.

Returns:

default value for scope

getConstant

public int getConstant()

Returns the matching constant field from SearchControls

Returns:

the matching constant field