com.planet_ink.coffee_mud.Libraries.interfaces
Enum CharCreationLibrary.NewCharNameCheckResult

java.lang.Object
  java.lang.Enum<CharCreationLibrary.NewCharNameCheckResult>
      com.planet_ink.coffee_mud.Libraries.interfaces.CharCreationLibrary.NewCharNameCheckResult

All Implemented Interfaces:

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

Enclosing interface:

CharCreationLibrary

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

A response object from one of the name checking methods, telling the caller some specifics about the attempt to create a new character by testing a new name.

Enum Constant Summary

BAD_USED_NAME
Either the name was a bad one, or used before by someone else

CREATE_LIMIT_REACHED
The limits on character creation have been reached for this player or ip

NO_NEW_LOGINS
Cannot create a character because new logins aren't allowed

NO_NEW_PLAYERS
Cannot create a character because new players aren't allowed

OK
All is well, proceed

Method Summary

static CharCreationLibrary.NewCharNameCheckResult	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CharCreationLibrary.NewCharNameCheckResult[]	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

OK

public static final CharCreationLibrary.NewCharNameCheckResult OK

All is well, proceed

NO_NEW_PLAYERS

public static final CharCreationLibrary.NewCharNameCheckResult NO_NEW_PLAYERS

Cannot create a character because new players aren't allowed

NO_NEW_LOGINS

public static final CharCreationLibrary.NewCharNameCheckResult NO_NEW_LOGINS

Cannot create a character because new logins aren't allowed

BAD_USED_NAME

public static final CharCreationLibrary.NewCharNameCheckResult BAD_USED_NAME

Either the name was a bad one, or used before by someone else

CREATE_LIMIT_REACHED

public static final CharCreationLibrary.NewCharNameCheckResult CREATE_LIMIT_REACHED

The limits on character creation have been reached for this player or ip

Method Detail

values

public static CharCreationLibrary.NewCharNameCheckResult[] 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.NewCharNameCheckResult c : CharCreationLibrary.NewCharNameCheckResult.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.NewCharNameCheckResult 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