Class SeaCowPuzzle

java.lang.Object

SeaCowPuzzle

public class SeaCowPuzzle
extends java.lang.Object

An abstraction of a puzzle - used for handling the parsing of input files, and to easen the creation of expected strings. I recommend using TestingUtil.convertToPrintableArray() when calling the various getGrid() methods. Note that this grid can be mutated - it isn't just the starting grid. You can set squares in one of two ways - either by specifying the upper-left-based integer coordinates, or the in-game string "a,g" style coordinates. Name chosen so as to avoid name conflicts with student files.

Author:

Stephen

Constructor Summary

Constructors

Constructor and Description
SeaCowPuzzle(java.util.Scanner fileScnr) Creates a puzzle out of a puzzle input file

Method Summary

Methods

Modifier and Type	Method and Description
char[][]	getCurrentlyRevealedGrid() Returns a char array returning the current grid that should be displayed, given the calls to setSquare() by this point.
char[][]	getFinalGridWithErrors() Returns a char array returning the grid that would be displayed to a player who filled up the entire grid, given the calls to setSquare() by this point.
char[][]	getFullyRevealedGrid() Returns a char array of the fully revealed grid (akin to the answer key)
void	resetToStartingState() Resets the grid to how it would look when originally loaded in from a file
void	setSquare(int row, int col, java.lang.String markerToPlace) Sets a square to either 's' for ship or 'w' for water.
void	setSquare(java.lang.String letterCoords, java.lang.String markerToPlace) Sets a square to either 's' for ship or 'w' for water.
java.lang.String	toString() Returns the correct printout of a grid at this point in time, with hints and legend.

Methods inherited from class java.lang.Object

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

Constructor Detail

SeaCowPuzzle

public SeaCowPuzzle(java.util.Scanner fileScnr)

Creates a puzzle out of a puzzle input file

Method Detail

resetToStartingState

public void resetToStartingState()

Resets the grid to how it would look when originally loaded in from a file

setSquare

public void setSquare(int row,
             int col,
             java.lang.String markerToPlace)

Sets a square to either 's' for ship or 'w' for water.

Parameters:

row - 0th row is at the top, 5th row is the bottom

col - 0th column is the left, 5th column is on the right

markerToPlace - must be 's' or 'w'

setSquare

public void setSquare(java.lang.String letterCoords,
             java.lang.String markerToPlace)

Sets a square to either 's' for ship or 'w' for water.

Parameters:

letterCoords - character string such as "a,g" or "a,l"

markerToPlace - must be 's' or 'w'

getFullyRevealedGrid

public char[][] getFullyRevealedGrid()

Returns a char array of the fully revealed grid (akin to the answer key)

getCurrentlyRevealedGrid

public char[][] getCurrentlyRevealedGrid()

Returns a char array returning the current grid that should be displayed, given the calls to setSquare() by this point.

getFinalGridWithErrors

public char[][] getFinalGridWithErrors()

Returns a char array returning the grid that would be displayed to a player who filled up the entire grid, given the calls to setSquare() by this point. It will show errors in their guesses Should NOT be called with a grid with ANY periods remaining. If testing quitter, instead use getFullyRevealedGrid()

toString

public java.lang.String toString()

Returns the correct printout of a grid at this point in time, with hints and legend.

Overrides:

toString in class java.lang.Object