oracle.igf.ids

Enum ReadOptions.SearchScope

java.lang.Object

java.lang.Enum<ReadOptions.SearchScope>

oracle.igf.ids.ReadOptions.SearchScope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ReadOptions.SearchScope>

Enclosing class:

ReadOptions

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

Search scope

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASE
ONELEVEL
SUBTREE

Method Summary

Modifier and Type	Method and Description
java.lang.String	value()
static ReadOptions.SearchScope	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ReadOptions.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

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BASE

public static final ReadOptions.SearchScope BASE

ONELEVEL

public static final ReadOptions.SearchScope ONELEVEL

SUBTREE

public static final ReadOptions.SearchScope SUBTREE

Method Detail

values

public static ReadOptions.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 (ReadOptions.SearchScope c : ReadOptions.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 ReadOptions.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

value

public java.lang.String value()