org.apache.directory.shared.ldap.filter
Enum SearchScope

java.lang.Object
  extended by java.lang.Enum<SearchScope>
      extended by org.apache.directory.shared.ldap.filter.SearchScope
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SearchScope>

public enum SearchScope
extends java.lang.Enum<SearchScope>

A search scope enumerated type.

Version:
$Rev$, $Date$
Author:
Apache Directory Project

Enum Constant Summary
OBJECT
           
ONELEVEL
           
SUBTREE
           
 
Method Summary
 java.lang.String getLdapUrlValue()
          Gets the LDAP URL value for the scope: according to RFC 2255 this is either base, one, or sub.
 int getScope()
          Gets the corresponding scope constant value as defined in RFC 4511.
static SearchScope getSearchScope(int scope)
          Gets the SearchScope enumerated type for the corresponding scope numeric value.
static int getSearchScope(java.lang.String ldapUrlValue)
          Gets the SearchScope enumerated type for the corresponding LDAP URL scope value of either base, one or sub.
 java.lang.String toString()
          
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 are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

OBJECT

public static final SearchScope OBJECT

ONELEVEL

public static final SearchScope ONELEVEL

SUBTREE

public static final SearchScope SUBTREE
Method Detail

values

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

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

valueOf

public static SearchScope valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getLdapUrlValue

public java.lang.String getLdapUrlValue()
Gets the LDAP URL value for the scope: according to RFC 2255 this is either base, one, or sub.

See Also:
RFC 2255

getScope

public int getScope()
Gets the corresponding scope constant value as defined in RFC 4511.

Returns:
the scope

getSearchScope

public static SearchScope getSearchScope(int scope)
Gets the SearchScope enumerated type for the corresponding scope numeric value.

Parameters:
scope - the numeric value to get SearchScope for
Returns:
the SearchScope enumerated type for the scope numeric value

getSearchScope

public static int getSearchScope(java.lang.String ldapUrlValue)
Gets the SearchScope enumerated type for the corresponding LDAP URL scope value of either base, one or sub.

Parameters:
ldapUrlValue - the LDAP URL scope value to get SearchScope for
Returns:
the SearchScope enumerated type for the LDAP URL scope value

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Enum<SearchScope>


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.