Class MazeRoom

java.lang.Object

MazeRoom

public class MazeRoom
extends java.lang.Object

This class encapsulates a room in a maze with doors to the north, east, south, and west. A static method is provided to generate a maze.

Method Summary

Methods

Modifier and Type	Method and Description
static MazeRoom	buildCyclicMaze() Returns a MazeRoom that serves as the entrance to a pre-built maze with a cycle (i.e., loop).
static MazeRoom	buildMaze() Returns a MazeRoom that serves as the entrance to a pre-built maze.
boolean	equals(java.lang.Object obj)
java.lang.String	getName() Returns the name associated with this room.
MazeRoom	goEast() Returns the MazeRoom that is east of this one.
MazeRoom	goNorth() Returns the MazeRoom that is north of this one.
MazeRoom	goSouth() Returns the MazeRoom that is south of this one.
MazeRoom	goWest() Returns the MazeRoom that is west of this one.
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getName

public java.lang.String getName()

Returns the name associated with this room.

Returns:

this room's name.

goNorth

public MazeRoom goNorth()

Returns the MazeRoom that is north of this one.

Returns:

the room that is to the north, null if none.

goEast

public MazeRoom goEast()

Returns the MazeRoom that is east of this one.

Returns:

the room that is to the east, null if none.

goSouth

public MazeRoom goSouth()

Returns the MazeRoom that is south of this one.

Returns:

the room that is to the south, null if none.

goWest

public MazeRoom goWest()

Returns the MazeRoom that is west of this one.

Returns:

the room that is to the west, null if none.

buildMaze

public static MazeRoom buildMaze()

Returns a MazeRoom that serves as the entrance to a pre-built maze.

Returns:

an entrance to a maze.

buildCyclicMaze

public static MazeRoom buildCyclicMaze()

Returns a MazeRoom that serves as the entrance to a pre-built maze with a cycle (i.e., loop).

Returns:

an entrance to a cyclic maze.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object