mazeGUI

Class World

java.lang.Object

mazeGUI.World

public class World
extends java.lang.Object

A class for a rectangular world (Maze) of equally sized rooms in a grid.

Since:

2014-02-22

Version:

1.0

Author:

Jack Myers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	World.Direction

Field Summary

Fields

Modifier and Type	Field and Description
private int	columns
static int	MAX_ITERATIONS
static java.lang.String	PLAYER_ICON
static double	ROOM_REWARD
private java.util.ArrayList<Room>	rooms
private int	rows

Constructor Summary

Constructors

Constructor and Description
World(int columns, int rows)

Method Summary

Methods

Modifier and Type	Method and Description
void	addRoom(Room room) addRoom adds a room to the world.
void	displayRooms() A non-graphical room display
static java.lang.String	getArrow(World.Direction direction) getArrow will return the ASCII character for an arrow corresponding to a Direction
int	getColumns() Standard accessor method
static World.Direction	getRandomDirection() Gets a random direction
Room	getRoom(int x, int y) Returns the room at the designated X and Y coordinates
java.util.ArrayList<Room>	getRooms() Standard accessor method
int	getRows() Standard accessor method
static boolean	isValidDirection(java.lang.String s) A validation function that checks whether a string corresponds to a value of the Direction enum
void	setColumns(int columns) Standard mutator method
void	setRooms(java.util.ArrayList<Room> rooms) Standard mutator method
void	setRows(int rows) Standard mutator method

Methods inherited from class java.lang.Object

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

Field Detail

rows

private int rows

columns

private int columns

rooms

private java.util.ArrayList<Room> rooms

MAX_ITERATIONS

public static final int MAX_ITERATIONS

See Also:

Constant Field Values

PLAYER_ICON

public static final java.lang.String PLAYER_ICON

See Also:

Constant Field Values

ROOM_REWARD

public static final double ROOM_REWARD

See Also:

Constant Field Values

Constructor Detail

World

public World(int columns,
     int rows)

Method Detail

addRoom

public void addRoom(Room room)

addRoom adds a room to the world. Used in world construction

Parameters:

room -

getRoom

public Room getRoom(int x,
           int y)

Returns the room at the designated X and Y coordinates

Parameters:

x - The X coordinate

y - The Y coordinate

Returns:

The room at (X, Y)

displayRooms

public void displayRooms()

A non-graphical room display

isValidDirection

public static boolean isValidDirection(java.lang.String s)

A validation function that checks whether a string corresponds to a value of the Direction enum

Parameters:

s - The string to be converted into a Direction (enum)

Returns:

TRUE if the string corresponds to a valid Direction

getRandomDirection

public static World.Direction getRandomDirection()

Gets a random direction

Returns:

A random Direction

getArrow

public static java.lang.String getArrow(World.Direction direction)

getArrow will return the ASCII character for an arrow corresponding to a Direction

Parameters:

direction - Any valid value of enum Direction (i.e., UP, DOWN, RIGHT, LEFT)

Returns:

An arrow character (as String) that corresponds to the direction

getRows

public int getRows()

Standard accessor method

Returns:

rows

setRows

public void setRows(int rows)

Standard mutator method

getColumns

public int getColumns()

Standard accessor method

Returns:

columns

setColumns

public void setColumns(int columns)

Standard mutator method

getRooms

public java.util.ArrayList<Room> getRooms()

Standard accessor method

Returns:

rooms

setRooms

public void setRooms(java.util.ArrayList<Room> rooms)

Standard mutator method