Package adams.core.option

Enum UserMode

java.lang.Object

java.lang.Enum<UserMode>

adams.core.option.UserMode

All Implemented Interfaces:

EnumWithCustomDisplay<UserMode>, EnumWithCustomParsing<UserMode>, Serializable, Comparable<UserMode>

public enum UserMode
extends Enum<UserMode>
implements EnumWithCustomDisplay<UserMode>

The user mode, determines the knowledge level of the user.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Enum Constant Summary

Enum Constants

Enum Constant	Description
BASIC	basic.
DEBUGGER	for debugging purposes only.
DEVELOPER	developer.
EXPERT	expert.

Field Summary

Fields

Modifier and Type	Field	Description
static UserMode	HIGHEST
static UserMode	LOWEST

Method Summary

Modifier and Type	Method	Description
static boolean	isAtLeast(UserMode mode, UserMode minMode)	Checks whether the given user mode is at least the specified minimum.
UserMode	parse(String s)	Parses the given string and returns the associated enum.
String	toDisplay()	Returns the display string.
String	toRaw()	Returns the raw enum string.
String	toString()	Returns the display string.
static UserMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static UserMode[]	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

BASIC

public static final UserMode BASIC

basic.

EXPERT

public static final UserMode EXPERT

expert.

DEVELOPER

public static final UserMode DEVELOPER

developer.

DEBUGGER

public static final UserMode DEBUGGER

for debugging purposes only.

Field Detail

LOWEST

public static final UserMode LOWEST

HIGHEST

public static final UserMode HIGHEST

Method Detail

values

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

Returns:

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

valueOf

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

toDisplay

public String toDisplay()

Returns the display string.

Specified by:

toDisplay in interface EnumWithCustomDisplay<UserMode>

Returns:

the display string

toRaw

public String toRaw()

Returns the raw enum string.

Specified by:

toRaw in interface EnumWithCustomDisplay<UserMode>

Returns:

the raw enum string

toString

public String toString()

Returns the display string.

Overrides:

toString in class Enum<UserMode>

Returns:

the display string

parse

public UserMode parse(String s)

Parses the given string and returns the associated enum.

Specified by:

parse in interface EnumWithCustomParsing<UserMode>

Parameters:

s - the string to parse

Returns:

the enum or null if not found

isAtLeast

public static boolean isAtLeast(UserMode mode,
                                UserMode minMode)

Checks whether the given user mode is at least the specified minimum.

Parameters:

mode - the mode to check

minMode - the minimum mode that is required

Returns:

true if mode is at least the specified minimum