org.jbei.ice.lib.dto.user

Enum PreferenceKey

java.lang.Object

java.lang.Enum<PreferenceKey>

org.jbei.ice.lib.dto.user.PreferenceKey

All Implemented Interfaces:

Serializable, Comparable<PreferenceKey>

public enum PreferenceKey
extends Enum<PreferenceKey>

Preset key for user preferences. Those that map to EntryField should have the same toString().ignoreCase() value when the "_" is replaced with a key. e.g. PRINCIPAL_INVESTIGATOR -> Principal Investigator.

To put it another way

Header.stringToHeader(key.toString)

should not return null if the key is for an entry field (e.g. PI)

Author:

Hector Plahar

Enum Constant Summary

Enum Constants

Enum Constant and Description
FUNDING_SOURCE
PRINCIPAL_INVESTIGATOR

Method Summary

Modifier and Type	Method and Description
static PreferenceKey	fromString(String key)
String	toString()
static PreferenceKey	valueOf(String name) Returns the enum constant of this type with the specified name.
static PreferenceKey[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PRINCIPAL_INVESTIGATOR

public static final PreferenceKey PRINCIPAL_INVESTIGATOR

FUNDING_SOURCE

public static final PreferenceKey FUNDING_SOURCE

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Overrides:

toString in class Enum<PreferenceKey>

fromString

public static PreferenceKey fromString(String key)