Merge branch 'puzzle_editor-short_truth_table' into puzzle_editor-sho…

…rt_truth_table
Bram-Hub · Sep 26, 2023 · 0cb069b · 0cb069b
2 parents 2daca5c + f994a07
commit 0cb069b
Show file tree

Hide file tree

Showing 58 changed files with 429 additions and 196 deletions.
diff --git a/.github/workflows/publish-javadoc.yml b/.github/workflows/publish-javadoc.yml
@@ -6,6 +6,8 @@ on:
   push:
     branches:
       - dev
+permissions:
+  contents: write
 
 jobs:
   publish:

diff --git a/bin/main/edu/rpi/legup/puzzle/skyscrapers/rules/TODO.md b/bin/main/edu/rpi/legup/puzzle/skyscrapers/rules/TODO.md
@@ -11,7 +11,7 @@ spreadsheet : https://docs.google.com/spreadsheets/d/1l7aUZtavtysM8dtGnaEIXhBKMR
  4. Refactoring:
     - document utility functions in the reference sheet, COMMENTS!
     - review and identify dead code
-    - remove all these damn print statments (commented ones too if they aren't useful)
+    - remove all these damn print statements (commented ones too if they aren't useful)
     - Edit to allow blank clues
     - Display flags somewhere
  5. Flags

diff --git a/src/main/java/edu/rpi/legup/app/Config.java b/src/main/java/edu/rpi/legup/app/Config.java
@@ -25,7 +25,7 @@ public class Config {
     /**
      * Config Constructor for logic puzzles
      *
-     * @throws InvalidConfigException
+     * @throws InvalidConfigException if configuration is invalid
      */
     public Config() throws InvalidConfigException {
         this.puzzles = new Hashtable<>();

diff --git a/src/main/java/edu/rpi/legup/app/GameBoardFacade.java b/src/main/java/edu/rpi/legup/app/GameBoardFacade.java
@@ -255,6 +255,7 @@ public void loadPuzzle(String game, String[] statements) {
      * Loads a puzzle file
      *
      * @param fileName file name of the board file
+     * @throws InvalidFileFormatException if input is invalid
      */
     public void loadPuzzle(String fileName) throws InvalidFileFormatException {
         try {
@@ -344,7 +345,7 @@ public void loadPuzzleEditor(InputStream inputStream) throws InvalidFileFormatEx
 
     /**
      * Loads a puzzle file from the input stream
-     *
+     * @throws InvalidFileFormatException if input is invalid
      * @param inputStream input stream for the puzzle file
      */
     public void loadPuzzle(InputStream inputStream) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/app/LegupPreferences.java b/src/main/java/edu/rpi/legup/app/LegupPreferences.java
@@ -8,6 +8,8 @@ public class LegupPreferences {
 
     private static LegupPreferences instance;
 
+    private static String SAVED_PATH = "";
+
     private static final Preferences preferences = Preferences.userNodeForPackage(LegupPreferences.class);
 
     private static final Map<String, String> preferencesMap = new HashMap<>();
@@ -104,4 +106,13 @@ public boolean getUserPrefAsBool(String key) {
             }
         }
     }
+
+
+    public String getSavedPath() {
+        return SAVED_PATH;
+    }
+
+    public void setSavedPath(String path) {
+        SAVED_PATH = path;
+    }
 }
diff --git a/src/main/java/edu/rpi/legup/history/AutoCaseRuleCommand.java b/src/main/java/edu/rpi/legup/history/AutoCaseRuleCommand.java
@@ -29,6 +29,9 @@ public class AutoCaseRuleCommand extends PuzzleCommand {
      *
      * @param elementView currently selected puzzle puzzleElement view that is being edited
      * @param selection   currently selected tree puzzleElement views that is being edited
+     * @param caseRule currently selected caseRule puzzleElement view that is being edited
+     * @param caseBoard currently selected caseBoard puzzleElement view that is being edited
+     * @param mouseEvent currently selected mouseEvent puzzleElement view that is being edited
      */
     public AutoCaseRuleCommand(ElementView elementView, TreeViewSelection selection, CaseRule caseRule, CaseBoard caseBoard, MouseEvent mouseEvent) {
         this.elementView = elementView;

diff --git a/src/main/java/edu/rpi/legup/history/ICommand.java b/src/main/java/edu/rpi/legup/history/ICommand.java
@@ -2,12 +2,13 @@
 
 public interface ICommand {
     /**
-     * Executes an command
+     * Executes a command
      */
     void execute();
 
     /**
      * Determines whether this command can be executed
+     * @return true if can execute, false otherwise
      */
     boolean canExecute();
 
@@ -20,12 +21,12 @@ public interface ICommand {
     String getError();
 
     /**
-     * Undoes an command
+     * Undoes a command
      */
     void undo();
 
     /**
-     * Redoes an command
+     * Redoes a command
      */
     void redo();
 }
diff --git a/src/main/java/edu/rpi/legup/history/ValidateCaseRuleCommand.java b/src/main/java/edu/rpi/legup/history/ValidateCaseRuleCommand.java
@@ -25,6 +25,7 @@ public class ValidateCaseRuleCommand extends PuzzleCommand {
      * AutoCaseRuleCommand Constructor creates a command for verifying a case rule
      *
      * @param selection currently selected tree puzzleElement views that is being edited
+     * @param caseRule currently selected caseRule puzzleElement view that is being edited
      */
     public ValidateCaseRuleCommand(TreeViewSelection selection, CaseRule caseRule) {
         this.selection = selection.copy();

diff --git a/src/main/java/edu/rpi/legup/history/ValidateContradictionRuleCommand.java b/src/main/java/edu/rpi/legup/history/ValidateContradictionRuleCommand.java
@@ -22,7 +22,7 @@ public class ValidateContradictionRuleCommand extends PuzzleCommand {
      * ValidateContradictionRuleCommand Constructor creates a puzzle command for verifying a contradiction rule
      *
      * @param selection currently selected tree puzzleElement views
-     * @param rule      contradiction rule to set to all of the tree elements
+     * @param rule      contradiction rule to be set to all the tree elements
      */
     public ValidateContradictionRuleCommand(TreeViewSelection selection, ContradictionRule rule) {
         this.selection = selection.copy();
@@ -32,7 +32,7 @@ public ValidateContradictionRuleCommand(TreeViewSelection selection, Contradicti
     }
 
     /**
-     * Executes an command
+     * Executes a command
      */
     @Override
     public void executeCommand() {
@@ -117,7 +117,7 @@ public String getErrorString() {
     }
 
     /**
-     * Undoes an command
+     * Undoes a command
      */
     @Override
     public void undoCommand() {

diff --git a/src/main/java/edu/rpi/legup/model/Puzzle.java b/src/main/java/edu/rpi/legup/model/Puzzle.java
@@ -258,8 +258,8 @@ public boolean isPuzzleComplete() {
     /**
      * Imports the board using the file stream
      *
-     * @param fileName
-     * @throws InvalidFileFormatException
+     * @param fileName the file that is imported
+     * @throws InvalidFileFormatException if file is invalid
      */
     public void importPuzzle(String fileName) throws InvalidFileFormatException {
         try {
@@ -274,8 +274,8 @@ public void importPuzzle(String fileName) throws InvalidFileFormatException {
     /**
      * Imports the board using the file stream
      *
-     * @param inputStream
-     * @throws InvalidFileFormatException
+     * @param inputStream the file stream that is imported
+     * @throws InvalidFileFormatException if file stream is invalid
      */
     public void importPuzzle(InputStream inputStream) throws InvalidFileFormatException {
         Document document;

diff --git a/src/main/java/edu/rpi/legup/model/PuzzleExporter.java b/src/main/java/edu/rpi/legup/model/PuzzleExporter.java
@@ -26,6 +26,7 @@ public abstract class PuzzleExporter {
 
     /**
      * PuzzleExporter Constructor exports the puzzle object to a file
+     * @param puzzle puzzle that is to be exported
      */
     public PuzzleExporter(Puzzle puzzle) {
         this.puzzle = puzzle;
@@ -35,7 +36,7 @@ public PuzzleExporter(Puzzle puzzle) {
      * Exports the puzzle to an xml formatted file
      *
      * @param fileName name of file to be exported
-     * @throws ExportFileException
+     * @throws ExportFileException if puzzle can not be exported
      */
     public void exportPuzzle(String fileName) throws ExportFileException {
         try {

diff --git a/src/main/java/edu/rpi/legup/model/PuzzleImporter.java b/src/main/java/edu/rpi/legup/model/PuzzleImporter.java
@@ -21,6 +21,7 @@ public abstract class PuzzleImporter {
 
     /**
      * PuzzleImporter Constructor creates the puzzle object
+     * @param puzzle puzzle that is imported
      */
     public PuzzleImporter(Puzzle puzzle) {
         this.puzzle = puzzle;
@@ -35,7 +36,7 @@ public PuzzleImporter(Puzzle puzzle) {
      *
      * @param rows    number of rows on the puzzle
      * @param columns number of columns on the puzzle
-     * @throws RuntimeException
+     * @throws RuntimeException if puzzle can not be made
      */
     public void initializePuzzle(int rows, int columns) throws RuntimeException {
         if (this.puzzle.isValidDimensions(rows, columns)) {
@@ -57,7 +58,7 @@ public void initializePuzzle(String[] statements) throws InputMismatchException,
      * Initializes the puzzle attributes
      *
      * @param node xml document node
-     * @throws InvalidFileFormatException
+     * @throws InvalidFileFormatException if file is invalid
      */
     public void initializePuzzle(Node node) throws InvalidFileFormatException {
         if (node.getNodeName().equalsIgnoreCase("puzzle")) {
@@ -111,15 +112,15 @@ public void initializePuzzle(Node node) throws InvalidFileFormatException {
      *
      * @param rows    number of rows on the puzzle
      * @param columns number of columns on the puzzle
-     * @throws RuntimeException
+     * @throws RuntimeException if board can not be created
      */
     public abstract void initializeBoard(int rows, int columns);
 
     /**
      * Creates an empty board for building
      *
      * @param node xml document node
-     * @throws InvalidFileFormatException
+     * @throws InvalidFileFormatException if file is invalid
      */
     public abstract void initializeBoard(Node node) throws InvalidFileFormatException;
 
@@ -129,7 +130,7 @@ public void initializePuzzle(Node node) throws InvalidFileFormatException {
      * Creates the proof for building
      *
      * @param node xml document node
-     * @throws InvalidFileFormatException
+     * @throws InvalidFileFormatException if file is invalid
      */
     public void initializeProof(Node node) throws InvalidFileFormatException {
         if (node.getNodeName().equalsIgnoreCase("proof")) {
@@ -163,6 +164,7 @@ public void initializeProof(Node node) throws InvalidFileFormatException {
      * Sets the puzzleElement from the xml document node
      *
      * @param node xml document node
+     * @throws InvalidFileFormatException if file is invalid
      */
     protected void setCells(Node node) throws InvalidFileFormatException {
         NodeList dataList = ((org.w3c.dom.Element) node).getElementsByTagName("cell");
@@ -176,8 +178,8 @@ protected void setCells(Node node) throws InvalidFileFormatException {
     /**
      * Creates the tree for the edu.rpi.legup.puzzle
      *
-     * @param node
-     * @throws InvalidFileFormatException
+     * @param node xml document node
+     * @throws InvalidFileFormatException if file is invalid
      */
     protected void createTree(Node node) throws InvalidFileFormatException {
         Element treeElement = (org.w3c.dom.Element) node;

diff --git a/src/main/java/edu/rpi/legup/model/tree/Tree.java b/src/main/java/edu/rpi/legup/model/tree/Tree.java
@@ -101,7 +101,7 @@ public Set<TreeElement> getLeafTreeElements() {
 
     /**
      * Gets a Set of TreeNodes that are leaf nodes from the sub tree rooted at the specified node
-     *
+     * @param node node that is input
      * @return Set of TreeNodes that are leaf nodes from the sub tree
      */
     public Set<TreeElement> getLeafTreeElements(TreeNode node) {

diff --git a/src/main/java/edu/rpi/legup/model/tree/TreeNode.java b/src/main/java/edu/rpi/legup/model/tree/TreeNode.java
@@ -328,4 +328,9 @@ public boolean isRoot() {
     public void setRoot(boolean isRoot) {
         this.isRoot = isRoot;
     }
+
+    public void clearChildren() {
+        this.children.clear();
+    }
+
 }
diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/BattleshipCellFactory.java b/src/main/java/edu/rpi/legup/puzzle/battleship/BattleshipCellFactory.java
@@ -17,7 +17,7 @@ public class BattleshipCellFactory extends ElementFactory {
      * @param node  node that represents the puzzleElement
      * @param board board to add the newly created cell
      * @return newly created cell from the xml document Node
-     * @throws InvalidFileFormatException
+     * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public PuzzleElement<BattleshipType> importCell(Node node, Board board) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/BattleshipImporter.java b/src/main/java/edu/rpi/legup/puzzle/battleship/BattleshipImporter.java
@@ -28,7 +28,7 @@ public boolean acceptsTextInput() {
      *
      * @param rows    the number of rows on the board
      * @param columns the number of columns on the board
-     * @throws RuntimeException
+     * @throws RuntimeException if board can not be created
      */
     @Override
     public void initializeBoard(int rows, int columns) {
@@ -39,7 +39,7 @@ public void initializeBoard(int rows, int columns) {
      * Creates the board for building
      *
      * @param node xml document node
-     * @throws InvalidFileFormatException
+     * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public void initializeBoard(Node node) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/BattleshipType.java b/src/main/java/edu/rpi/legup/puzzle/battleship/BattleshipType.java
@@ -13,7 +13,7 @@ public enum BattleshipType {
 
     /**
      * Gets the enum of this BattleShipType
-     *
+     * @param value the integer value input
      * @return enum equivalent BattleShipType of integer value
      */
     public static BattleshipType getType(int value) {

diff --git a/src/main/java/edu/rpi/legup/puzzle/fillapix/FillapixCellFactory.java b/src/main/java/edu/rpi/legup/puzzle/fillapix/FillapixCellFactory.java
@@ -17,7 +17,7 @@ public class FillapixCellFactory extends ElementFactory {
      * @param node  node that represents the puzzleElement
      * @param board board to add the newly created cell
      * @return newly created cell from the xml document Node
-     * @throws InvalidFileFormatException
+     * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public FillapixCell importCell(Node node, Board board) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/puzzle/fillapix/FillapixImporter.java b/src/main/java/edu/rpi/legup/puzzle/fillapix/FillapixImporter.java
@@ -28,7 +28,7 @@ public boolean acceptsTextInput() {
      *
      * @param rows    the number of rows on the board
      * @param columns the number of columns on the board
-     * @throws RuntimeException
+     * @throws RuntimeException if board can not be made
      */
     @Override
     public void initializeBoard(int rows, int columns) {
@@ -39,7 +39,7 @@ public void initializeBoard(int rows, int columns) {
      * Creates the board for building
      *
      * @param node xml document node
-     * @throws InvalidFileFormatException
+     * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public void initializeBoard(Node node) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/puzzle/heyawake/HeyawakeFactory.java b/src/main/java/edu/rpi/legup/puzzle/heyawake/HeyawakeFactory.java
@@ -17,7 +17,7 @@ public class HeyawakeFactory extends ElementFactory {
      * @param node  node that represents the puzzleElement
      * @param board board to add the newly created cell
      * @return newly created cell from the xml document Node
-     * @throws InvalidFileFormatException
+     * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public HeyawakeCell importCell(Node node, Board board) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/puzzle/heyawake/HeyawakeImporter.java b/src/main/java/edu/rpi/legup/puzzle/heyawake/HeyawakeImporter.java
@@ -29,7 +29,7 @@ public boolean acceptsTextInput() {
      *
      * @param rows    the number of rows on the board
      * @param columns the number of columns on the board
-     * @throws RuntimeException
+     * @throws RuntimeException if board can not be created
      */
     @Override
     public void initializeBoard(int rows, int columns) {
@@ -40,7 +40,7 @@ public void initializeBoard(int rows, int columns) {
      * Creates the board for building
      *
      * @param node xml document node
-     * @throws InvalidFileFormatException
+     * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public void initializeBoard(Node node) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/puzzle/lightup/LightUpCellFactory.java b/src/main/java/edu/rpi/legup/puzzle/lightup/LightUpCellFactory.java
@@ -17,7 +17,7 @@ public class LightUpCellFactory extends ElementFactory {
      * @param node  node that represents the puzzleElement
      * @param board board to add the newly created cell
      * @return newly created cell from the xml document Node
-     * @throws InvalidFileFormatException
+     * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public LightUpCell importCell(Node node, Board board) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/puzzle/lightup/LightUpImporter.java b/src/main/java/edu/rpi/legup/puzzle/lightup/LightUpImporter.java
@@ -28,7 +28,7 @@ public boolean acceptsTextInput() {
      *
      * @param rows    the number of rows on the board
      * @param columns the number of columns on the board
-     * @throws RuntimeException
+     * @throws RuntimeException if board can not be created
      */
     @Override
     public void initializeBoard(int rows, int columns) {
@@ -51,7 +51,7 @@ public void initializeBoard(int rows, int columns) {
      * Creates the board for building
      *
      * @param node xml document node
-     * @throws InvalidFileFormatException
+     * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public void initializeBoard(Node node) throws InvalidFileFormatException {