Class MazeSolver

java.lang.Object

MazeSolver

public class MazeSolver
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MazeSolver.MazeSolvedException Exception thrown when path is complete

Constructor Summary

Constructors

Constructor and Description
MazeSolver()

Method Summary

Modifier and Type	Method and Description
static boolean	findPath(int row, int col) This method calls itself recursively to find a path from the leprechaun to the pot of gold.
(package private) static void	loadMaze(String filename) Reads a maze file into the 2-dimensional array declared as a class variable.
static void	main(String[] args) This is the starting point for your program.

Methods inherited from class java.lang.Object

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

Constructor Detail

MazeSolver

public MazeSolver()

Method Detail

main

public static void main(String[] args)
                 throws FileNotFoundException

This is the starting point for your program. This method calls the loadMaze method to read the maze file.

1. Implement the loadMaze(String) method first, if correctly implemented the user interface should display it correctly.
2. After the //YOUR CODE HERE! comment write code to find the row and column of the leprechaun, which is then used for the initial call to findPath(int, int).
3. Since code has been provided to CALL the method findPath(int, int), no other code in the main method is needed.

Parameters:

args - set run configurations to either choose or change the maze you are using

Throws:

FileNotFoundException - exception thrown when program unable to recognize file name

loadMaze

static void loadMaze(String filename)
              throws FileNotFoundException

Reads a maze file into the 2-dimensional array declared as a class variable.

Parameters:

filename - the name of the maze file.

Throws:

FileNotFoundException - exception thrown when program unable to recognize file name

findPath

public static boolean findPath(int row,
                               int col)
                        throws MazeSolver.MazeSolvedException

This method calls itself recursively to find a path from the leprechaun to the pot of gold.

It also notifies the user interface about the path it is searching.

Here is a list of the actions taken in findPath, based on the square it is searching:

• If the row or column is not on the board, notify the user interface calling sendStatus with PATH_ILLEGAL, and return false.
• If maze[row][col] == 'G', then you have found a path to the pot of gold, notify the user interface by calling UserInterface.sendStatus(CallbackInterface.SearchStatus, int, int) with CallbackInterface.SearchStatus.PATH_COMPLETE and throw the MazeSolver.MazeSolvedException to terminate execution.
• If maze[row][col] == 'S', then the current square is already part of a valid path, do not notify the user interface, just return false.
• If maze[row][col] == 'W', then the current square is already part of an invalid path, not notify the user interface, just return false.
• If maze[row][col] == '#', then the current square contains a blocking tree, do not notify the user interface, just return false.
• If current square contains a space or 'L', notify the user interface by calling UserInterface.sendStatus(CallbackInterface.SearchStatus, int, int) with CallbackInterface.SearchStatus.PATH_VALID then recursively call findPath with the row and column of the surrounding squares, in order: UP, RIGHT, DOWN, and LEFT.
• If any of the recursive calls return true, return true from the current invocation of findPath, otherwise notify the user interface by calling UserInterface.sendStatus(CallbackInterface.SearchStatus, int, int) with CallbackInterface.SearchStatus.PATH_INVALID, and return false.

Parameters:

row - the current row of the leprechaun

col - the current column of the leprechaun

Returns:

true for a valid path, false otherwise

Throws:

MazeSolver.MazeSolvedException - exception thrown when maze is complete