SearchStringEnum

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.member
Enum SearchStringEnum

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

All Implemented Interfaces:: Serializable, Comparable<SearchStringEnum>

public enum SearchStringEnum
extends Enum<SearchStringEnum>
extends Enum<SearchStringEnum>

Author:: shilen

Enum Constant Summary
`SEARCH_STRING_0` searchString0
`SEARCH_STRING_1` searchString1
`SEARCH_STRING_2` searchString2
`SEARCH_STRING_3` searchString3
`SEARCH_STRING_4` searchString4

Method Summary
`static SearchStringEnum`	`getDefaultSearchString()`
`abstract String`	`getFieldName()`
`abstract int`	`getIndex()`
`abstract boolean`	`hasAccess()`
`static SearchStringEnum`	`newInstance(int index)`
`static SearchStringEnum`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SearchStringEnum[]`	`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

SEARCH_STRING_0

public static final SearchStringEnum SEARCH_STRING_0

searchString0

SEARCH_STRING_1

public static final SearchStringEnum SEARCH_STRING_1

searchString1

SEARCH_STRING_2

public static final SearchStringEnum SEARCH_STRING_2

searchString2

SEARCH_STRING_3

public static final SearchStringEnum SEARCH_STRING_3

searchString3

SEARCH_STRING_4

public static final SearchStringEnum SEARCH_STRING_4

searchString4

Method Detail

values

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

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

valueOf

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

getFieldName

public abstract String getFieldName()

Returns:: the field name for a particular search string

hasAccess

public abstract boolean hasAccess()

Returns:: true if the user has access to a particular search string

getIndex

public abstract int getIndex()

Returns:: the index

getDefaultSearchString

public static SearchStringEnum getDefaultSearchString()

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

newInstance

public static SearchStringEnum newInstance(int index)

Parameters:: index -
Returns:: return enum based on the index value