Class Room

java.lang.Object

Room

public class Room
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
private LinkedList<Creature>	creatures
private java.lang.String	description
private java.lang.String	name
private PC	player
private Room[]	rooms
private java.lang.String	state

Constructor Summary

Constructors

Constructor and Description
Room()
Room(java.lang.String n, java.lang.String d)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	addCreature(Creature c) Adds a creature to the Room
void	addRoom(Room room, int direction) Adds a room to the Room
void	clean() clean the room by one state
private java.lang.String	coerceDirection(int direction) represent the numerical direction as a string
void	dirty() dirty the room by one state
LinkedList<Creature>	getCreatures() Get the array of creatures
java.lang.String	getDescription() Get the description of the room
int	getNumberOfCreatures() return the total number of creatures currently in the room
PC	getPlayer() Gets the player within the room
Room	getRoom(int direction) Gets a room from a direction
java.lang.String	getState() Gets the state of the Room
java.lang.String	name() name
void	notifyCreatures() Notify all animals in the room of a state change
java.lang.Boolean	removeCreature(Creature c) Remove creature from Room
int	searchCreature(java.lang.String name)
private int	searchCreature(java.lang.String name, LinkedList<Creature> creature_array, int l, int h) Deprecated.
void	setDescription(java.lang.String desc) Sets the description of the room
void	setPlayer(PC p) Sets the player in the room or not
void	setState(java.lang.String s) Sets the state of the Room
void	sortRoom() Deprecated.
private void	sortRoom(LinkedList<Creature> c, int l, int h) Deprecated.
java.lang.String	toString() Override method to print out the room name and animals in it

Methods inherited from class java.lang.Object

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

Field Detail

name

private java.lang.String name

description

private java.lang.String description

creatures

private LinkedList<Creature> creatures

player

private PC player

state

private java.lang.String state

rooms

private Room[] rooms

Constructor Detail

Room

Room(java.lang.String n,
    java.lang.String d)

Room

Room()

Method Detail

clean

public void clean()

clean the room by one state

dirty

public void dirty()

dirty the room by one state

addCreature

public java.lang.Boolean addCreature(Creature c)

Adds a creature to the Room

Parameters:

c - A creature

Returns:

True if creature added False if room was full

removeCreature

public java.lang.Boolean removeCreature(Creature c)

Remove creature from Room

Parameters:

c - A creature

Returns:

True if creature was removed, False if it failed

addRoom

public void addRoom(Room room,
           int direction)

Adds a room to the Room

Parameters:

A - room reference

Direction - inside the room

getRoom

public Room getRoom(int direction)

Gets a room from a direction

Parameters:

direction - A NESW int direction

Returns:

a room

setState

public void setState(java.lang.String s)

Sets the state of the Room

Parameters:

s - State of the room

getState

public java.lang.String getState()

Gets the state of the Room

Returns:

the state of the room

setDescription

public void setDescription(java.lang.String desc)

Sets the description of the room

Parameters:

desc - description

getDescription

public java.lang.String getDescription()

Get the description of the room

Returns:

description

getPlayer

public PC getPlayer()

Gets the player within the room

Returns:

null if the player is in the room, otherwise the player

setPlayer

public void setPlayer(PC p)

Sets the player in the room or not

Parameters:

p - null if removing, PC if adding

notifyCreatures

public void notifyCreatures()

Notify all animals in the room of a state change

getNumberOfCreatures

public int getNumberOfCreatures()

return the total number of creatures currently in the room

Returns:

# of creatures

getCreatures

public LinkedList<Creature> getCreatures()

Get the array of creatures

searchCreature

@Deprecated
private int searchCreature(java.lang.String name,
                            LinkedList<Creature> creature_array,
                            int l,
                            int h)

Deprecated.

searchCreature

public int searchCreature(java.lang.String name)

sortRoom

@Deprecated
private void sortRoom(LinkedList<Creature> c,
                       int l,
                       int h)

Deprecated.

Sort the creatures in the room using the Quicksort algorithm

Parameters:

The - list of creatures

The - low value

The - high value

sortRoom

@Deprecated
public void sortRoom()

Deprecated.

Override of the private sortRoom method which fills in the blanks for you

name

public java.lang.String name()

name

Returns:

returns only the name of the room

coerceDirection

private java.lang.String coerceDirection(int direction)

represent the numerical direction as a string

Parameters:

direction - number of direction

Returns:

a string representation of the direction

toString

public java.lang.String toString()

Override method to print out the room name and animals in it

Overrides:

toString in class java.lang.Object

Returns:

A formatted string of the room and animals in it