Package edu.internet2.middleware.grouper.ws.query

Enum Class StemScope

java.lang.Object

java.lang.Enum<StemScope>

edu.internet2.middleware.grouper.ws.query.StemScope

All Implemented Interfaces:

Serializable, Comparable<StemScope>, Constable

public enum StemScope
extends Enum<StemScope>

scope of groups under a stem. either all or just one level (immediate)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL_IN_SUBTREE	all children in the subtree below the stem
ONE_LEVEL	just direct immediate chlidren

Method Summary

Modifier and Type	Method	Description
abstract Stem.Scope	convertToScope()	convert this to a real Grouper scope
static StemScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StemScope	valueOfIgnoreCase(String string)	do a case-insensitive matching
static StemScope[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ONE_LEVEL

public static final StemScope ONE_LEVEL

just direct immediate chlidren

ALL_IN_SUBTREE

public static final StemScope ALL_IN_SUBTREE

all children in the subtree below the stem

Method Details

values

public static StemScope[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static StemScope valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

valueOfIgnoreCase

public static StemScope valueOfIgnoreCase(String string)

do a case-insensitive matching

Parameters:

string -

Returns:

the enum or null or exception if not found

convertToScope

public abstract Stem.Scope convertToScope()

convert this to a real Grouper scope

Returns:

the scope