org.forgerock.opendj.ldap

Class SearchScope

java.lang.Object

org.forgerock.opendj.ldap.SearchScope

public final class SearchScope
extends Object

A Search operation search scope as defined in RFC 4511 section 4.5.1.2 is used to specify the scope of a Search operation.

See Also:

RFC 4511 - Lightweight Directory Access Protocol (LDAP): The Protocol , draft-sermersheim-ldap-subordinate-scope - Subordinate Subtree Search Scope for LDAP

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchScope.Enum Contains equivalent values for the SearchScope values.

Field Summary

Fields

Modifier and Type	Field and Description
static SearchScope	BASE_OBJECT The scope is constrained to the search base entry.
static SearchScope	SINGLE_LEVEL The scope is constrained to the immediate subordinates of the search base entry.
static SearchScope	SUBORDINATES The scope is constrained to all the subordinates of the search base entry, but does not include the search base entry itself (as wholeSubtree does).
static SearchScope	WHOLE_SUBTREE The scope is constrained to the search base entry and to all its subordinates.

Method Summary

Modifier and Type	Method and Description
SearchScope.Enum	asEnum() Returns the enum equivalent for this search scope.
boolean	equals(Object obj)
int	hashCode()
int	intValue() Returns the integer value of this search scope as defined in RFC 4511 section 4.5.1.2.
String	toString() Returns the string representation of this search scope as defined in RFC 4516.
static SearchScope	valueOf(int intValue) Returns the search scope having the specified integer value as defined in RFC 4511 section 4.5.1.2.
static SearchScope	valueOf(String name) Returns the search scope having the specified name as defined in RFC 4511 section 4.5.1.2.
static List<SearchScope>	values() Returns an unmodifiable list containing the set of available search scopes indexed on their integer value as defined in RFC 4511 section 4.5.1.2.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

BASE_OBJECT

public static final SearchScope BASE_OBJECT

The scope is constrained to the search base entry.

SINGLE_LEVEL

public static final SearchScope SINGLE_LEVEL

The scope is constrained to the immediate subordinates of the search base entry.

WHOLE_SUBTREE

public static final SearchScope WHOLE_SUBTREE

The scope is constrained to the search base entry and to all its subordinates.

SUBORDINATES

public static final SearchScope SUBORDINATES

The scope is constrained to all the subordinates of the search base entry, but does not include the search base entry itself (as wholeSubtree does).

Method Detail

valueOf

public static SearchScope valueOf(int intValue)

Returns the search scope having the specified integer value as defined in RFC 4511 section 4.5.1.2.

Parameters:

intValue - The integer value of the search scope.

Returns:

The search scope, or null if there was no search scope associated with intValue.

valueOf

public static SearchScope valueOf(String name)

Returns the search scope having the specified name as defined in RFC 4511 section 4.5.1.2.

Parameters:

name - the name of the search scope to return

Returns:

The search scope, or null if there was no search scope associated with name.

Throws:

NullPointerException - if name is null

values

public static List<SearchScope> values()

Returns an unmodifiable list containing the set of available search scopes indexed on their integer value as defined in RFC 4511 section 4.5.1.2.

Returns:

An unmodifiable list containing the set of available search scopes.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

intValue

public int intValue()

Returns the integer value of this search scope as defined in RFC 4511 section 4.5.1.2.

Returns:

The integer value of this search scope.

asEnum

public SearchScope.Enum asEnum()

Returns the enum equivalent for this search scope.

Returns:

The enum equivalent for this search scope when a known mapping exists, or SearchScope.Enum.UNKNOWN if this is an unknown search scope.

toString

public String toString()

Returns the string representation of this search scope as defined in RFC 4516.

Overrides:

toString in class Object

Returns:

The string representation of this search scope.