Package com.bdtripp.hauntedhouse.model

Enum Class RoomName

java.lang.Object

java.lang.Enum<RoomName>

com.bdtripp.hauntedhouse.model.RoomName

All Implemented Interfaces:

Serializable, Comparable<RoomName>, Constable

public enum RoomName
extends Enum<RoomName>

Enumerates all supported room names.

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
BATHROOM	A bathroom.
BILLIARD_ROOM	A billiard room.
DEN	A den.
HALLWAY	A hallway in the house.
INDOOR_GARDEN	An indoor garden area.
LIBRARY	The library.
OUTSIDE	The area outside the house.
ROOT_CELLAR	A storage cellar.
STUDY	A study room.
WINE_CELLAR	A wine storage cellar.

Method Summary

Modifier and Type	Method	Description
static RoomName	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RoomName[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HALLWAY

public static final RoomName HALLWAY

A hallway in the house.

STUDY

public static final RoomName STUDY

A study room.

INDOOR_GARDEN

public static final RoomName INDOOR_GARDEN

An indoor garden area.

ROOT_CELLAR

public static final RoomName ROOT_CELLAR

A storage cellar.

LIBRARY

public static final RoomName LIBRARY

The library.

BILLIARD_ROOM

public static final RoomName BILLIARD_ROOM

A billiard room.

DEN

public static final RoomName DEN

A den.

WINE_CELLAR

public static final RoomName WINE_CELLAR

A wine storage cellar.

BATHROOM

public static final RoomName BATHROOM

A bathroom.

OUTSIDE

public static final RoomName OUTSIDE

The area outside the house.

Method Details

values

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