edu.internet2.middleware.grouper.member
Enum SortStringEnum

java.lang.Object
  java.lang.Enum<SortStringEnum>
      edu.internet2.middleware.grouper.member.SortStringEnum

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SortStringEnum>

public enum SortStringEnum
extends java.lang.Enum<SortStringEnum>

Author:

shilen

Enum Constant Summary

SORT_STRING_0
sortString0

SORT_STRING_1
sortString1

SORT_STRING_2
sortString2

SORT_STRING_3
sortString3

SORT_STRING_4
sortString4

Method Summary

static SortStringEnum	getDefaultSortString()
abstract java.lang.String	getFieldName()
abstract int	getIndex()
abstract boolean	hasAccess()
static SortStringEnum	newInstance(int index)
static SortStringEnum	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SortStringEnum[]	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

SORT_STRING_0

public static final SortStringEnum SORT_STRING_0

sortString0

SORT_STRING_1

public static final SortStringEnum SORT_STRING_1

sortString1

SORT_STRING_2

public static final SortStringEnum SORT_STRING_2

sortString2

SORT_STRING_3

public static final SortStringEnum SORT_STRING_3

sortString3

SORT_STRING_4

public static final SortStringEnum SORT_STRING_4

sortString4

Method Detail

values

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

Returns:

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

valueOf

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

getFieldName

public abstract java.lang.String getFieldName()

Returns:

the field name for a particular sort string

hasAccess

public abstract boolean hasAccess()

Returns:

true if the user has access to a particular sort string

getIndex

public abstract int getIndex()

Returns:

the index

getDefaultSortString

public static SortStringEnum getDefaultSortString()

Returns:

get the default sort string based on what this subject has access to or null if the subject doesn't have access to any.

newInstance

public static SortStringEnum newInstance(int index)

Parameters:

index -

Returns:

return enum based on the index value