Class Cave

java.lang.Object

Cave

public class Cave
extends java.lang.Object

Class that models a cave in "Hunt the Wumpus"

Version:

11/4/17

Author:

Dave Reed

Constructor Summary

Constructors

Constructor and Description
Cave(java.lang.String name, int num, java.util.ArrayList<java.lang.Integer> adj) Constructs a cave with the specified characteristics.

Method Summary

Modifier and Type	Method and Description
int	getAdjNumber(int tunnel) Accesses the number of an adjacent cave.
java.lang.String	getCaveName() Accesses the name of the cave, or "unknown" if yet to be visited.
int	getCaveNumber() Accesses the number of the cave.
CaveContents	getContents() Accesses the contents of the contents (CaveContents.EMPTY, CaveContents.WUMPUS, CaveContents.BATS, or CaveContents.PIT).
int	getNumAdjacent() Accesses the number of caves adjacent to this one.
void	markAsVisited() Marks the cave as having been visited.
void	setContents(CaveContents contents) Sets the contents of the cave (CaveContents.EMPTY, CaveContents.WUMPUS, CaveContents.BATS, or CaveContents.PIT).

Methods inherited from class java.lang.Object

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

Constructor Detail

Cave

public Cave(java.lang.String name,
            int num,
            java.util.ArrayList<java.lang.Integer> adj)

Constructs a cave with the specified characteristics. By default, the cave is unvisited and empty.

Parameters:

name - the name of the cave

num - the cave number

adj - a list of cave numbers of the adjacent caves

Method Detail

getAdjNumber

public int getAdjNumber(int tunnel)

Accesses the number of an adjacent cave.

Parameters:

tunnel - the tunnel number

Returns:

the number of the adjacent cave through that tunnel, or -1 if no such tunnel

getCaveName

public java.lang.String getCaveName()

Accesses the name of the cave, or "unknown" if yet to be visited.

Returns:

the cave name or "unknown"

getCaveNumber

public int getCaveNumber()

Accesses the number of the cave.

Returns:

the cave number

getContents

public CaveContents getContents()

Accesses the contents of the contents (CaveContents.EMPTY, CaveContents.WUMPUS, CaveContents.BATS, or CaveContents.PIT).

Returns:

the cave contents

getNumAdjacent

public int getNumAdjacent()

Accesses the number of caves adjacent to this one.

Returns:

the number of adjacent caves

markAsVisited

public void markAsVisited()

Marks the cave as having been visited.

setContents

public void setContents(CaveContents contents)

Sets the contents of the cave (CaveContents.EMPTY, CaveContents.WUMPUS, CaveContents.BATS, or CaveContents.PIT).

Parameters:

contents - the new contents