Package com.bdtripp.hauntedhouse.model

Enum Class PlayerStat

java.lang.Object

java.lang.Enum<PlayerStat>

com.bdtripp.hauntedhouse.model.PlayerStat

All Implemented Interfaces:

Serializable, Comparable<PlayerStat>, Constable

public enum PlayerStat
extends Enum<PlayerStat>

Enumerates all supported stat types.

Author:

Brian Tripp

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
HEALTH	The player's health stat.
MAX_CARRY_WEIGHT	The player's maximum carry weight stat.
NONE	Indicates that the item does not affect any player stat.
STRENGTH	The player's strength stat.

Method Summary

Modifier and Type	Method	Description
String	toString()	Returns the enum name in lowercase with underscores replaced by spaces.
static PlayerStat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PlayerStat[]	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

NONE

public static final PlayerStat NONE

Indicates that the item does not affect any player stat.

HEALTH

public static final PlayerStat HEALTH

The player's health stat.

STRENGTH

public static final PlayerStat STRENGTH

The player's strength stat.

MAX_CARRY_WEIGHT

public static final PlayerStat MAX_CARRY_WEIGHT

The player's maximum carry weight stat.

Method Details

values

public static PlayerStat[] 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 PlayerStat 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

toString

public String toString()

Returns the enum name in lowercase with underscores replaced by spaces.

Overrides:

toString in class Enum<PlayerStat>

Returns:

the formatted stat name