net.sourceforge.cilib.games.items
Enum GameToken.TicTacToe

java.lang.Object
  extended by java.lang.Enum<GameToken.TicTacToe>
      extended by net.sourceforge.cilib.games.items.GameToken.TicTacToe
All Implemented Interfaces:
Serializable, Comparable<GameToken.TicTacToe>, GameEnum
Enclosing class:
GameToken

public static enum GameToken.TicTacToe
extends Enum<GameToken.TicTacToe>
implements GameEnum

Tick Tack Toe tokens

Author:
leo

Enum Constant Summary
CROSS
           
NOUGHT
           
 
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.TicTacToe valueOf(String name)
          Returns the enum constant of this type with the specified name.
static GameToken.TicTacToe[] 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

NOUGHT

public static final GameToken.TicTacToe NOUGHT

CROSS

public static final GameToken.TicTacToe CROSS
Method Detail

values

public static GameToken.TicTacToe[] 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.TicTacToe c : GameToken.TicTacToe.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.TicTacToe 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.


Copyright © 2009 CIRG. All Rights Reserved.