net.sourceforge.cilib.games.items
Enum GameToken

java.lang.Object
  java.lang.Enum<GameToken>
      net.sourceforge.cilib.games.items.GameToken

All Implemented Interfaces:

Serializable, Comparable<GameToken>, GameEnum

public enum GameToken
extends Enum<GameToken>
implements GameEnum

This enum defines descriptors for any game items.

Author:

leo

Nested Class Summary

static class	GameToken.PredatorPrey Predator Prey tokens
static class	GameToken.Tetris Tetris tokens
static class	GameToken.TicTacToe Tick Tack Toe tokens

Enum Constant Summary

DEFAULT

Method Summary

String	getDescription() Return a description of a specific Enum, this description is used in the Game's display() method to show a GameItem
static GameToken	valueOf(String name) Returns the enum constant of this type with the specified name.
static GameToken[]	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

DEFAULT

public static final GameToken DEFAULT

Method Detail

values

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

Returns:

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

valueOf

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

getDescription

public String getDescription()

Return a description of a specific Enum, this description is used in the Game's display() method to show a GameItem

Specified by:

getDescription in interface GameEnum

Returns:

the string description.