Package a5.util

Enum Class PlayerType

java.lang.Object

java.lang.Enum<PlayerType>

a5.util.PlayerType

All Implemented Interfaces:

Serializable, Comparable<PlayerType>, Constable

public enum PlayerType
extends Enum<PlayerType>

An enum representing the type of player. Each type is associated with a string name that represents the player's type.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AI
AI2
HUMAN

Method Summary

Modifier and Type	Method	Description
static Maybe<PlayerType>	fromString(String name)	Returns: the type of player whose name matches.
static String	options()	Returns: a string representing a list of all valid player types.
String	toString()
static PlayerType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PlayerType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AI

public static final PlayerType AI

HUMAN

public static final PlayerType HUMAN

AI2

public static final PlayerType AI2

Method Details

values

public static PlayerType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static PlayerType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static Maybe<PlayerType> fromString(String name)

Returns: the type of player whose name matches. It is case-insensitive.

Parameters:

name - type of the player

toString

public String toString()

Overrides:

toString in class Enum<PlayerType>

options

public static String options()

Returns: a string representing a list of all valid player types. The format is: <playertype1|playertype2...>