A C D F G H I M N O P R S T U W 

A

addSelfToGrid(SeaCowSquare[][]) - Method in class SeaCowShip
 

C

callGetters(StudentGridPrintout) - Static method in class GridPrintoutTester
 
charactersToNormalizeAway - Variable in class P4AssertionSet
 
common.testing - package common.testing
 
containsShipCharacter(String) - Static method in class TestingUtil
 
convertArrayToPrintableString(char[][]) - Static method in class TestingUtil
Converts char array into student-readable string

D

DEFAULT_TIMEOUT - Static variable in class common.testing.Util
 
didIncludeBottomLegend() - Method in class StudentGridPrintout
Returns true iff we detected the presence of a bottom legend
didIncludeSideHint() - Method in class StudentGridPrintout
Returns true iff we found a side hint
didIncludeSideLegend() - Method in class StudentGridPrintout
Returns true iff we detected the presence of a side legend
didIncludeTopHint() - Method in class StudentGridPrintout
Returns true iff we found a top hint

F

fileFetcher - Variable in class P4AssertionSet
 

G

getActualValue() - Method in class SeaCowSquare
 
getBottomLegend() - Method in class StudentGridPrintout
Returns the string we detected as the bottom legend
getClassList(Object[]) - Static method in class common.testing.Util
Uses Java Reflection to ascertain the classes of each of the elements of args.
getCol(String) - Static method in class TestingUtil
 
getCurrentlyRevealedGrid() - Method in class SeaCowPuzzle
Returns a char array returning the current grid that should be displayed, given the calls to setSquare() by this point.
getFinalGridWithErrors() - Method in class SeaCowPuzzle
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.
getFullyRevealedGrid() - Method in class SeaCowPuzzle
Returns a char array of the fully revealed grid (akin to the answer key)
getGrid() - Method in class StudentGridPrintout
 
getPointsFromAnnotation(StackTraceElement[]) - Static method in class common.testing.Util
Gets the number of points allocated to a test method, based on a stack trace from within the call to that method.
getPointsFromAnnotation() - Static method in class common.testing.Util
Gets the number of points allocated to the currently executing test method.
getPrintableGrid() - Method in class StudentGridPrintout
 
getRow(String) - Static method in class TestingUtil
 
getSideHint() - Method in class StudentGridPrintout
 
getSideLegend() - Method in class StudentGridPrintout
If the side legend is present, this will return that legend as an array of Strings - one for each row
getTopHint() - Method in class StudentGridPrintout
Returns the array of numbers which comprise the top hint
getVisibleValue() - Method in class SeaCowSquare
 
GridPrintoutTester - Class in <Unnamed>
A class for testing the StudentGridPrintout, not for outside use
GridPrintoutTester() - Constructor for class GridPrintoutTester
 

H

HEADER_LIST_INFO - Static variable in class TestingUtil
 
HEADER_LOAD_PUZZLE - Static variable in class TestingUtil
 
HEADER_PLAY_PUZZLE - Static variable in class TestingUtil
 
HEADER_QUIT - Static variable in class TestingUtil
 
HEIGHT - Static variable in class TestingUtil
 

I

isActualShip() - Method in class SeaCowSquare
 
isShipSquare(char) - Static method in class TestingUtil
 

M

MAIN_CLASS - Static variable in class TestingUtil
 
MAIN_MENU - Static variable in class TestingUtil
 
markAsShip() - Method in class SeaCowSquare
 
markAsWater() - Method in class SeaCowSquare
 
MENU_CHOICE_LIST_INFO - Static variable in class TestingUtil
 
MENU_CHOICE_LOAD_PUZZLE - Static variable in class TestingUtil
 
MENU_CHOICE_PLAY_PUZZLE - Static variable in class TestingUtil
 
MENU_CHOICE_QUIT - Static variable in class TestingUtil
 
MSG_EARLY_QUIT - Static variable in class TestingUtil
 
MSG_FAILURE - Static variable in class TestingUtil
 
MSG_LOCATION_FIXED - Static variable in class TestingUtil
 

N

NUM_SHIPS - Static variable in class TestingUtil
 

O

ORIGINAL_STRING - Variable in class StudentGridPrintout
 

P

P4AssertionSet - Class in <Unnamed>
Custom AssertionSet extensions for P1.
P4AssertionSet() - Constructor for class P4AssertionSet
 
PreQATest - Class in <Unnamed>
This test checks that the tests written by test writers follows convention and has the appropriate annotations.
PreQATest() - Constructor for class PreQATest
 
PreTest01_RequiredClassesPresent - Class in <Unnamed>
Fails if the submission has any required classes either missing or not declared public.
PreTest01_RequiredClassesPresent() - Constructor for class PreTest01_RequiredClassesPresent
 
PreTest02_RequiredMethodsPresent - Class in <Unnamed>
Fails if the submission has any required public methods that are either missing or not declared public.
PreTest02_RequiredMethodsPresent() - Constructor for class PreTest02_RequiredMethodsPresent
 
PreTest03_RequiredConstructorsPresent - Class in <Unnamed>
Fails if the submission has any required public constructors either missing or not declared public.
PreTest03_RequiredConstructorsPresent() - Constructor for class PreTest03_RequiredConstructorsPresent
 
PROMPT - Static variable in class TestingUtil
 
PROMPT_ENTER_INITIALS - Static variable in class TestingUtil
 
PROMPT_GAMEPLAY - Static variable in class TestingUtil
 
PROMPT_LOAD_PUZZLE - Static variable in class TestingUtil
 
PROMPT_PLAYER_HISTORY - Static variable in class TestingUtil
 
PROMPT_SHIP_OR_WATER - Static variable in class TestingUtil
 
PublicServiceTest01_OnlyOneSystemInScanner - Class in <Unnamed>
This test looks through a student's source files and counts the number of times it sees Scanner(System.in) (allowing for optional whitespace), and if there is more than one occurrence, fails.
PublicServiceTest01_OnlyOneSystemInScanner() - Constructor for class PublicServiceTest01_OnlyOneSystemInScanner
 

R

reset() - Method in class SeaCowSquare
 
resetToStartingState() - Method in class SeaCowPuzzle
Resets the grid to how it would look when originally loaded in from a file
reveal() - Method in class SeaCowSquare
 
revealForGameEnd() - Method in class SeaCowSquare
 
revealForStart() - Method in class SeaCowSquare
 
roundPoints(double) - Static method in class common.testing.Util
Rounds a double point value to a BigDecimal suitable for printing.

S

SeaCowPuzzle - Class in <Unnamed>
An abstraction of a puzzle - used for handling the parsing of input files, and to easen the creation of expected strings.
SeaCowPuzzle(Scanner) - Constructor for class SeaCowPuzzle
Creates a puzzle out of a puzzle input file
SeaCowPuzzleTester - Class in <Unnamed>
A class for testing the SeaCowPuzzle, not for outside use
SeaCowPuzzleTester() - Constructor for class SeaCowPuzzleTester
 
SeaCowShip - Class in <Unnamed>
A ship class used by the SeaCowPuzzle.
SeaCowShip(String) - Constructor for class SeaCowShip
 
SeaCowSquare - Class in <Unnamed>
Square class used by the SeaCowPuzzle, which has an array of Squares Name chosen so as to avoid name conflicts with student files.
SeaCowSquare(char) - Constructor for class SeaCowSquare
 
SeaCowSquare(SeaCowSquare) - Constructor for class SeaCowSquare
 
setSquare(int, int, String) - Method in class SeaCowPuzzle
Sets a square to either 's' for ship or 'w' for water.
setSquare(String, String) - Method in class SeaCowPuzzle
Sets a square to either 's' for ship or 'w' for water.
SQUARE_ERROR - Static variable in class TestingUtil
 
SQUARE_MINI_SHIP - Static variable in class TestingUtil
 
SQUARE_SHIP_BOTTOM - Static variable in class TestingUtil
 
SQUARE_SHIP_GUESS - Static variable in class TestingUtil
 
SQUARE_SHIP_INTERNAL - Static variable in class TestingUtil
 
SQUARE_SHIP_LEFT - Static variable in class TestingUtil
 
SQUARE_SHIP_RIGHT - Static variable in class TestingUtil
 
SQUARE_SHIP_TOP - Static variable in class TestingUtil
 
SQUARE_UNKNOWN - Static variable in class TestingUtil
 
SQUARE_WATER - Static variable in class TestingUtil
 
StudentGridPrintout - Class in <Unnamed>
A class for encapsulating the printout a student gives us when they print their puzzle grid.
StudentGridPrintout(String) - Constructor for class StudentGridPrintout
 

T

test() - Method in class GridPrintoutTester
 
test() - Method in class PreQATest
 
test() - Method in class PreTest01_RequiredClassesPresent
 
test() - Method in class PreTest02_RequiredMethodsPresent
 
test() - Method in class PreTest03_RequiredConstructorsPresent
 
test() - Method in class PublicServiceTest01_OnlyOneSystemInScanner
 
test() - Method in class SeaCowPuzzleTester
 
test() - Method in class Test00_MainMenu_CorrectPrintout
 
test() - Method in class Test01_MainMenu_InvalidInput
 
test() - Method in class Test10_LoadPuzzle_BasicFunctionality
 
test() - Method in class Test11_LoadPuzzle_InvalidFile
 
test() - Method in class Test12_LoadPuzzle_MultiplePuzzlesAppearInList
 
test() - Method in class Test20_PlayPuzzle_MenuWhenNoPuzzleLoaded
 
test() - Method in class Test21_PlayPuzzle_StartingGrid
 
test() - Method in class Test22_PlayPuzzle_StartingHints
 
test() - Method in class Test30_PlayPuzzle_Prompts
 
test() - Method in class Test31_PlayPuzzle_MarkSquare
 
test() - Method in class Test32_PlayPuzzle_MarkInitiallyRevealedSpot
 
test() - Method in class Test33_PlayPuzzle_Quitter
 
test() - Method in class Test40_PlayPuzzle_Win
 
test() - Method in class Test41_PlayPuzzle_Lose
 
test() - Method in class Test50_Quit_BasicFunctionality
 
test() - Method in class Test52_Quit_OnePlayer
 
test() - Method in class Test53_Quit_InvalidFileName
 
test() - Method in class Test60_ListPlayers_NoPlayers
 
test() - Method in class Test61_ListPlayers_OnePlayerOnePuzzle
 
test() - Method in class Test62_ListPlayers_NoCreditForQuitters
 
test() - Method in class Test63_ListPlayers_HandlingOfInitials
 
test() - Method in class Test64_MultiplePuzzlesAndPlayers
 
test() - Method in class TestX0_Style_EightyCharacters
 
test() - Method in class TestX1_Style_Naming
 
test() - Method in class TestX2_Requirements_NoPublicFields
 
test() - Method in class TestX3_Requirements_NoStaticFields
 
test() - Method in class TestX4a_Requirements_NoAdditionalPublicMethods
 
test() - Method in class TestX4b_Requirements_NoAdditionalMethods
 
test() - Method in class TestX5_Requirements_NoArrays
 
test() - Method in class TestXX_DummyTest
Don't place javadoc here - do it only at the class level.
Test00_MainMenu_CorrectPrintout - Class in <Unnamed>
Tests whether the main menu and the prompt are displayed correctly when the program is started for the first time.
Test00_MainMenu_CorrectPrintout() - Constructor for class Test00_MainMenu_CorrectPrintout
 
Test01_MainMenu_InvalidInput - Class in <Unnamed>
The main menu prompt is tested with the following 2 types of invalid input:- Keying in the character 'x' at the prompt. Keying in the number 38 at the prompt. On receiving invalid input, the student program is expected to just display the main menu again.
Test01_MainMenu_InvalidInput() - Constructor for class Test01_MainMenu_InvalidInput
 
Test10_LoadPuzzle_BasicFunctionality - Class in <Unnamed>
The load puzzle option is being tested by loading a single puzzle.
Test10_LoadPuzzle_BasicFunctionality() - Constructor for class Test10_LoadPuzzle_BasicFunctionality
 
Test11_LoadPuzzle_InvalidFile - Class in <Unnamed>
The 'Load a puzzle' option is selected at the main menu.
Test11_LoadPuzzle_InvalidFile() - Constructor for class Test11_LoadPuzzle_InvalidFile
 
Test12_LoadPuzzle_MultiplePuzzlesAppearInList - Class in <Unnamed>
The load puzzle option is being tested by loading 4 puzzles.
Test12_LoadPuzzle_MultiplePuzzlesAppearInList() - Constructor for class Test12_LoadPuzzle_MultiplePuzzlesAppearInList
 
Test20_PlayPuzzle_MenuWhenNoPuzzleLoaded - Class in <Unnamed>
Without loading any puzzles, the 'Play a puzzle' option is selected at the main menu.
Test20_PlayPuzzle_MenuWhenNoPuzzleLoaded() - Constructor for class Test20_PlayPuzzle_MenuWhenNoPuzzleLoaded
 
Test21_PlayPuzzle_StartingGrid - Class in <Unnamed>
This test loads puzzle1.txt and tests if the initial displayed grid has the following: 1.
Test21_PlayPuzzle_StartingGrid() - Constructor for class Test21_PlayPuzzle_StartingGrid
 
Test22_PlayPuzzle_StartingHints - Class in <Unnamed>
This test loads puzzle4.txt and tests if the initial displayed grid has the hints correctly specified across the rows and cols.
Test22_PlayPuzzle_StartingHints() - Constructor for class Test22_PlayPuzzle_StartingHints
 
Test30_PlayPuzzle_Prompts - Class in <Unnamed>
This test loads puzzle5.txt and tests if the displayed prompt is correct.
Test30_PlayPuzzle_Prompts() - Constructor for class Test30_PlayPuzzle_Prompts
 
Test31_PlayPuzzle_MarkSquare - Class in <Unnamed>
This test loads puzzle3.txt, plays a four moves (two ships and two water) and tests if the resulting puzzle is correct after each move.
Test31_PlayPuzzle_MarkSquare() - Constructor for class Test31_PlayPuzzle_MarkSquare
 
Test32_PlayPuzzle_MarkInitiallyRevealedSpot - Class in <Unnamed>
This test loads puzzle6.txt, tries to change a location that is revealed and verifies if the displayed message is correct. (-1) points if the displayed message is incorrect
Test32_PlayPuzzle_MarkInitiallyRevealedSpot() - Constructor for class Test32_PlayPuzzle_MarkInitiallyRevealedSpot
 
Test33_PlayPuzzle_Quitter - Class in <Unnamed>
This test loads puzzle3.txt, places a ship, and then quits.
Test33_PlayPuzzle_Quitter() - Constructor for class Test33_PlayPuzzle_Quitter
 
Test40_PlayPuzzle_Win - Class in <Unnamed>
Play a game with a puzzle with one unrevealed square.
Test40_PlayPuzzle_Win() - Constructor for class Test40_PlayPuzzle_Win
 
Test41_PlayPuzzle_Lose - Class in <Unnamed>
Play a game with a puzzle with two unrevealed squares.
Test41_PlayPuzzle_Lose() - Constructor for class Test41_PlayPuzzle_Lose
 
Test50_Quit_BasicFunctionality - Class in <Unnamed>
This test starts up a student submission and goes straight to the quit menu.
Test50_Quit_BasicFunctionality() - Constructor for class Test50_Quit_BasicFunctionality
 
Test52_Quit_OnePlayer - Class in <Unnamed>
Play a game with a puzzle with one unrevealed square.
Test52_Quit_OnePlayer() - Constructor for class Test52_Quit_OnePlayer
 
Test53_Quit_InvalidFileName - Class in <Unnamed>
Give it an invalid file name such as drGorunes/secretLab/evilPlan.txt (directories won't exist)
Test53_Quit_InvalidFileName() - Constructor for class Test53_Quit_InvalidFileName
 
Test60_ListPlayers_NoPlayers - Class in <Unnamed>
Selects option 1 (list players) then ensures that the program redisplays the main menu.
Test60_ListPlayers_NoPlayers() - Constructor for class Test60_ListPlayers_NoPlayers
 
Test61_ListPlayers_OnePlayerOnePuzzle - Class in <Unnamed>
Wins a puzzle, enters initials of 3 capital letters, and then goes to list players to check if the player completed the puzzle.
Test61_ListPlayers_OnePlayerOnePuzzle() - Constructor for class Test61_ListPlayers_OnePlayerOnePuzzle
 
Test62_ListPlayers_NoCreditForQuitters - Class in <Unnamed>
Plays a puzzle, completes it, enter normal initials, plays a different puzzle, and quits immediately.
Test62_ListPlayers_NoCreditForQuitters() - Constructor for class Test62_ListPlayers_NoCreditForQuitters
 
Test63_ListPlayers_HandlingOfInitials - Class in <Unnamed>
Plays a puzzle then enters initials that are lower case and longer than 3 characters.
Test63_ListPlayers_HandlingOfInitials() - Constructor for class Test63_ListPlayers_HandlingOfInitials
 
Test64_MultiplePuzzlesAndPlayers - Class in <Unnamed>
One player plays two puzzles and another plays one puzzle.
Test64_MultiplePuzzlesAndPlayers() - Constructor for class Test64_MultiplePuzzlesAndPlayers
 
TestingUtil - Class in <Unnamed>
ToolBox-specific Utility method, containing constants and convenience methods for the current test suite.
TestingUtil() - Constructor for class TestingUtil
 
TestX0_Style_EightyCharacters - Class in <Unnamed>
This test looks through a student's source files and counts the number of characters in excess of 80 characters.
TestX0_Style_EightyCharacters() - Constructor for class TestX0_Style_EightyCharacters
 
TestX1_Style_Naming - Class in <Unnamed>
Checks that students followed proper Java naming conventions for classes, methods, and fields.
TestX1_Style_Naming() - Constructor for class TestX1_Style_Naming
 
TestX2_Requirements_NoPublicFields - Class in <Unnamed>
Checks that no student code contains non-private fields.
TestX2_Requirements_NoPublicFields() - Constructor for class TestX2_Requirements_NoPublicFields
 
TestX3_Requirements_NoStaticFields - Class in <Unnamed>
Fails if the submission contains any static non-final fields.
TestX3_Requirements_NoStaticFields() - Constructor for class TestX3_Requirements_NoStaticFields
 
TestX4a_Requirements_NoAdditionalPublicMethods - Class in <Unnamed>
Fails if the submission contains any public methods that were not specified - this is the more lenient version which only inspects public methods.
TestX4a_Requirements_NoAdditionalPublicMethods() - Constructor for class TestX4a_Requirements_NoAdditionalPublicMethods
 
TestX4b_Requirements_NoAdditionalMethods - Class in <Unnamed>
Fails if the submission contains any methods that were not specified - this is the more strict version which inspects all methods - regardless of access specifier
TestX4b_Requirements_NoAdditionalMethods() - Constructor for class TestX4b_Requirements_NoAdditionalMethods
 
TestX5_Requirements_NoArrays - Class in <Unnamed>
Checks that no student code contains array variables other than the main parameter.
TestX5_Requirements_NoArrays() - Constructor for class TestX5_Requirements_NoArrays
 
TestXX_DummyTest - Class in <Unnamed>
A dummy test for Stephen and Shree to look at
TestXX_DummyTest() - Constructor for class TestXX_DummyTest
 
TIMEOUT - Static variable in class TestingUtil
 
toString() - Method in class SeaCowPuzzle
Returns the correct printout of a grid at this point in time, with hints and legend.

U

Util - Class in common.testing
Testing utilities that don't need to be in the default package.
Util.NoPointsException - Exception in common.testing
Thrown when no Points annotations are found on the stack.
Util.NoPointsException() - Constructor for exception common.testing.Util.NoPointsException
 

W

warn(String) - Static method in class common.testing.Util
Prints a warning message.
WIDTH - Static variable in class TestingUtil
 
A C D F G H I M N O P R S T U W