com.planet_ink.coffee_mud.Common.interfaces
Enum CMMsg.CheckedMsgResponse

java.lang.Object
  java.lang.Enum<CMMsg.CheckedMsgResponse>
      com.planet_ink.coffee_mud.Common.interfaces.CMMsg.CheckedMsgResponse

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CMMsg.CheckedMsgResponse>

Enclosing interface:

CMMsg

public static enum CMMsg.CheckedMsgResponse
extends java.lang.Enum<CMMsg.CheckedMsgResponse>

An enum to use for an external message check from inside an okMessage method. Can force the caller to either immediate return true, false, or check the parent.

Enum Constant Summary

CANCEL

CONTINUE

FORCEDOK

Method Summary

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

FORCEDOK

public static final CMMsg.CheckedMsgResponse FORCEDOK

CANCEL

public static final CMMsg.CheckedMsgResponse CANCEL

CONTINUE

public static final CMMsg.CheckedMsgResponse CONTINUE

Method Detail

values

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

Returns:

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

valueOf

public static CMMsg.CheckedMsgResponse 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