Package com.planet_ink.coffee_mud.Libraries.interfaces

Enum CharCreationLibrary.LoginResult

java.lang.Object

java.lang.Enum<CharCreationLibrary.LoginResult>

com.planet_ink.coffee_mud.Libraries.interfaces.CharCreationLibrary.LoginResult

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CharCreationLibrary.LoginResult>

Enclosing interface:

CharCreationLibrary

public static enum CharCreationLibrary.LoginResult
extends java.lang.Enum<CharCreationLibrary.LoginResult>

A response object from one of the login system methods, basically telling the caller something about the results of what was attempted.

Enum Constant Summary

Enum Constants

Enum Constant	Description
INPUT_REQUIRED	User input required before proceeding
NO_LOGIN	Nothing happened, try again
NORMAL_LOGIN	Login completed, proceed

Method Summary

Modifier and Type	Method	Description
static CharCreationLibrary.LoginResult	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static CharCreationLibrary.LoginResult[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_LOGIN

public static final CharCreationLibrary.LoginResult NO_LOGIN

Nothing happened, try again

NORMAL_LOGIN

public static final CharCreationLibrary.LoginResult NORMAL_LOGIN

Login completed, proceed

INPUT_REQUIRED

public static final CharCreationLibrary.LoginResult INPUT_REQUIRED

User input required before proceeding

Method Detail

values

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

Returns:

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

valueOf

public static CharCreationLibrary.LoginResult 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