Package com.tameif.tame.lang

Enum ArgumentType

java.lang.Object

java.lang.Enum<ArgumentType>

com.tameif.tame.lang.ArgumentType

public enum ArgumentType
extends java.lang.Enum<ArgumentType>

Describes argument types.

Author:

Matthew Tropiano

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTION Argument accepts any action.
ACTION_DITRANSITIVE Argument accepts ditransitive actions.
ACTION_GENERAL Argument accepts general actions.
ACTION_MODAL_OPEN Argument accepts modal or open actions.
ACTION_TRANSITIVE_DITRANSITIVE Argument accepts transitive/ditransitive actions.
CONTAINER Argument must accept a container.
ELEMENT Argument must accept an element (object/player/room/container/world).
ELEMENT_ANY Argument must accept an element (object/player/room/container/world) - can be archetype.
OBJECT Argument must accept an object.
OBJECT_ANY Argument must accept an object or an archetype object.
OBJECT_CONTAINER Argument must accept an object container (player/room/container/world).
OBJECT_CONTAINER_ANY Argument must accept an object container (player/room/container/world) - can be archetype.
PLAYER Argument must accept a player.
ROOM Argument must accept a room.
VALUE Argument accepts a single literal value, can be anything.
VARIABLE Argument must accept a variable.

Method Summary

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

ACTION

public static final ArgumentType ACTION

Argument accepts any action.

ACTION_DITRANSITIVE

public static final ArgumentType ACTION_DITRANSITIVE

Argument accepts ditransitive actions.

ACTION_GENERAL

public static final ArgumentType ACTION_GENERAL

Argument accepts general actions.

ACTION_MODAL_OPEN

public static final ArgumentType ACTION_MODAL_OPEN

Argument accepts modal or open actions.

ACTION_TRANSITIVE_DITRANSITIVE

public static final ArgumentType ACTION_TRANSITIVE_DITRANSITIVE

Argument accepts transitive/ditransitive actions.

CONTAINER

public static final ArgumentType CONTAINER

Argument must accept a container.

ELEMENT

public static final ArgumentType ELEMENT

Argument must accept an element (object/player/room/container/world).

ELEMENT_ANY

public static final ArgumentType ELEMENT_ANY

Argument must accept an element (object/player/room/container/world) - can be archetype.

OBJECT

public static final ArgumentType OBJECT

Argument must accept an object.

OBJECT_ANY

public static final ArgumentType OBJECT_ANY

Argument must accept an object or an archetype object.

OBJECT_CONTAINER

public static final ArgumentType OBJECT_CONTAINER

Argument must accept an object container (player/room/container/world).

OBJECT_CONTAINER_ANY

public static final ArgumentType OBJECT_CONTAINER_ANY

Argument must accept an object container (player/room/container/world) - can be archetype.

PLAYER

public static final ArgumentType PLAYER

Argument must accept a player.

ROOM

public static final ArgumentType ROOM

Argument must accept a room.

VALUE

public static final ArgumentType VALUE

Argument accepts a single literal value, can be anything.

VARIABLE

public static final ArgumentType VARIABLE

Argument must accept a variable.

Method Detail

values

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

Returns:

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

valueOf

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