TableIndexType

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.tableIndex
Enum TableIndexType

java.lang.Object
  java.lang.Enum<TableIndexType>
      edu.internet2.middleware.grouper.tableIndex.TableIndexType

All Implemented Interfaces:: Serializable, Comparable<TableIndexType>

public enum TableIndexType
extends Enum<TableIndexType>
extends Enum<TableIndexType>

Enum Constant Summary
`attributeDef` index assigned to an attribute def
`attributeDefName` index assigned to an attribute name
`group` index assigned to a group
`stem` index assigned to a stem

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

group

public static final TableIndexType group

index assigned to a group

stem

public static final TableIndexType stem

index assigned to a stem

attributeDef

public static final TableIndexType attributeDef

index assigned to an attribute def

attributeDefName

public static final TableIndexType attributeDefName

index assigned to an attribute name

Method Detail

values

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

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

valueOf

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

tableName

public abstract String tableName()

table name in grouper

Returns:: the name of the table

valueOfIgnoreCase

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