edu.internet2.middleware.grouper

Enum Stem.Scope

java.lang.Object

java.lang.Enum<Stem.Scope>

edu.internet2.middleware.grouper.Stem.Scope

All Implemented Interfaces:

Serializable, Comparable<Stem.Scope>

Enclosing class:

Stem

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

Search scope: one-level or subtree.

Since:

1.2.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
ONE one level (direct children)
SUB all decendents

Method Summary

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

ONE

public static final Stem.Scope ONE

one level (direct children)

SUB

public static final Stem.Scope SUB

all decendents

Method Detail

values

public static Stem.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 (Stem.Scope c : Stem.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 Stem.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

valueOfIgnoreCase

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