Package com.bdtripp.hauntedhouse.model

Enum Class Direction

java.lang.Object

java.lang.Enum<Direction>

com.bdtripp.hauntedhouse.model.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>, Constable

public enum Direction
extends Enum<Direction>

Represents the four cardinal directions used for room navigation. Each constant corresponds to a navigable direction within the game world.

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
EAST	East
NORTH	North
SOUTH	South
WEST	West

Method Summary

Modifier and Type	Method	Description
static Direction	fromString(String s)	Converts a raw input string into a Direction.
String	toString()	Returns the enum name in lowercase for display and user-facing output.
static Direction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Direction[]	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

NORTH

public static final Direction NORTH

North

SOUTH

public static final Direction SOUTH

South

EAST

public static final Direction EAST

East

WEST

public static final Direction WEST

West

Method Details

values

public static Direction[] 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 Direction 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 Direction fromString(String s)

Converts a raw input string into a Direction. The comparison is case-insensitive. If the input does not match any direction, this method returns null.

Parameters:

s - the input string to convert

Returns:

the matching Direction, or null if no match exists

toString

public String toString()

Returns the enum name in lowercase for display and user-facing output.

Overrides:

toString in class Enum<Direction>