Package org.bitbrawl.foodfight.field

Enum Player.Hand

java.lang.Object

java.lang.Enum<Player.Hand>

org.bitbrawl.foodfight.field.Player.Hand

All Implemented Interfaces:

Serializable, Comparable<Player.Hand>

Enclosing interface:

Player

@Immutable
public static enum Player.Hand
extends Enum<Player.Hand>

A player's hand, either left or right. This enum is used in methods that need to refer to a specific side of a player, for example in the Inventory methods.

Author:

Finn

Enum Constant Summary

Enum Constants

Enum Constant	Description
LEFT	A player's left hand.
RIGHT	A player's right hand.

Method Summary

Modifier and Type	Method	Description
String	toString()	Returns a human-readable name for this hand, either "Left hand" or "Right hand".
static Player.Hand	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Player.Hand[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LEFT

@SerializedName("left")
public static final Player.Hand LEFT

A player's left hand.

RIGHT

@SerializedName("right")
public static final Player.Hand RIGHT

A player's right hand.

Method Detail

values

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

Returns:

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

valueOf

public static Player.Hand 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

toString

public String toString()

Returns a human-readable name for this hand, either "Left hand" or "Right hand". This is primarily intended for debugging purposes.

Overrides:

toString in class Enum<Player.Hand>

Returns:

a human-readable name for this hand