StemHierarchyType

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

edu.internet2.middleware.grouper.stem
Enum StemHierarchyType

java.lang.Object
  java.lang.Enum<StemHierarchyType>
      edu.internet2.middleware.grouper.stem.StemHierarchyType

All Implemented Interfaces:: Serializable, Comparable<StemHierarchyType>

public enum StemHierarchyType
extends Enum<StemHierarchyType>
extends Enum<StemHierarchyType>

Type of assignment: immediate for direct assignment (immediate child), effective for an assignment due to another assignment, or self for each stem (so we can do a simple join)

Author:: shilen $Id$

Enum Constant Summary
`effective` effective for an assignment due to another assignment
`immediate` immediate for a direct assignment (immediate child)
`self` row for self so we can do a simple join

Method Summary
`static StemHierarchyType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static StemHierarchyType`	`valueOfIgnoreCase(String string, boolean exceptionOnNull)` do a case-insensitive matching
`static StemHierarchyType[]`	`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

immediate

public static final StemHierarchyType immediate

immediate for a direct assignment (immediate child)

self

public static final StemHierarchyType self

row for self so we can do a simple join

effective

public static final StemHierarchyType effective

effective for an assignment due to another assignment

Method Detail

values

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

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

valueOf

public static StemHierarchyType 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 StemHierarchyType 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