Added jetbrains notations to Skyscrapers

src/main/java/edu/rpi/legup/puzzle/shorttruthtable/ShortTruthTable.java

@@ -4,6 +4,7 @@
 import edu.rpi.legup.model.gameboard.Board;
 import edu.rpi.legup.model.gameboard.PuzzleElement;
 import edu.rpi.legup.model.rules.ContradictionRule;
+import org.jetbrains.annotations.Contract;
 
 public class ShortTruthTable extends Puzzle {
 
@@ -39,6 +40,7 @@ public Board generatePuzzle(int difficulty) {
     }
 
     @Override
+    @Contract(pure = true)
     /**
      * Determines if the given dimensions are valid for Short Truth Table
      *

src/main/java/edu/rpi/legup/puzzle/skyscrapers/Skyscrapers.java

@@ -4,6 +4,7 @@
 import edu.rpi.legup.model.gameboard.Board;
 import edu.rpi.legup.model.gameboard.PuzzleElement;
 import edu.rpi.legup.model.rules.ContradictionRule;
+import org.jetbrains.annotations.Contract;
 
 public class Skyscrapers extends Puzzle {
 
@@ -38,6 +39,7 @@ public Board generatePuzzle(int difficulty) {
     }
 
     @Override
+    @Contract(pure = true)
     /**
      * Determines if the given dimensions are valid for Skyscrapers
      *

src/main/java/edu/rpi/legup/puzzle/skyscrapers/SkyscrapersCell.java

@@ -4,6 +4,8 @@
 
 import edu.rpi.legup.model.elements.Element;
 import edu.rpi.legup.model.gameboard.GridCell;
+import org.jetbrains.annotations.Contract;
+
 import java.awt.*;
 import java.awt.event.MouseEvent;
 
@@ -56,6 +58,7 @@ public int getMax() {
     }
 
     @Override
+    @Contract(pure = true)
     public SkyscrapersCell copy() {
         SkyscrapersCell copy = new SkyscrapersCell(data, (Point) location.clone(), max);
         copy.setIndex(index);

src/main/java/edu/rpi/legup/puzzle/skyscrapers/SkyscrapersCellFactory.java

@@ -5,6 +5,8 @@
 import edu.rpi.legup.model.gameboard.PuzzleElement;
 import edu.rpi.legup.save.InvalidFileFormatException;
 import java.awt.*;
+
+import org.jetbrains.annotations.Contract;
 import org.w3c.dom.Document;
 import org.w3c.dom.NamedNodeMap;
 import org.w3c.dom.Node;
@@ -19,6 +21,7 @@ public class SkyscrapersCellFactory extends ElementFactory {
      * @throws InvalidFileFormatException if input is invalid
      */
     @Override
+    @Contract(pure = false)
     public PuzzleElement importCell(Node node, Board board) throws InvalidFileFormatException {
         try {
             if (!node.getNodeName().equalsIgnoreCase("cell")) {
@@ -61,6 +64,7 @@ public PuzzleElement importCell(Node node, Board board) throws InvalidFileFormat
      * @param puzzleElement PuzzleElement cell
      * @return xml PuzzleElement
      */
+    @Contract(pure = false)
     public org.w3c.dom.Element exportCell(Document document, PuzzleElement puzzleElement) {
         org.w3c.dom.Element cellElement = document.createElement("cell");
 

src/main/java/edu/rpi/legup/puzzle/skyscrapers/SkyscrapersController.java

@@ -2,6 +2,8 @@
 
 import edu.rpi.legup.controller.ElementController;
 import edu.rpi.legup.model.gameboard.PuzzleElement;
+import org.jetbrains.annotations.Contract;
+
 import java.awt.event.MouseEvent;
 
 public class SkyscrapersController extends ElementController {
@@ -11,6 +13,7 @@ public SkyscrapersController() {
     }
 
     @Override
+    @Contract(pure = false)
     public void changeCell(MouseEvent e, PuzzleElement element) {
         SkyscrapersCell cell = (SkyscrapersCell) element;
         if (e.getButton() == MouseEvent.BUTTON1) {

src/main/java/edu/rpi/legup/puzzle/skyscrapers/SkyscrapersElementView.java

@@ -2,18 +2,21 @@
 
 import edu.rpi.legup.ui.boardview.GridElementView;
 import java.awt.*;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull;
 
 public class SkyscrapersElementView extends GridElementView {
     private static final Font FONT = new Font("TimesRoman", Font.BOLD, 16);
     private static final Color FONT_COLOR = new Color(0x212121);
     private static final Color BORDER_COLOR = new Color(0x424242);
     private static final Color BACKGROUND_COLOR = new Color(0xEEEEEE);
 
-    public SkyscrapersElementView(SkyscrapersCell cell) {
+    public SkyscrapersElementView(@NotNull SkyscrapersCell cell) {
         super(cell);
     }
 
     @Override
+    @Contract (pure = true)
     public void drawElement(Graphics2D graphics2D) {
         graphics2D.setStroke(new BasicStroke(1));
         graphics2D.setColor(BACKGROUND_COLOR);

src/main/java/edu/rpi/legup/puzzle/skyscrapers/SkyscrapersExporter.java

@@ -3,15 +3,18 @@
 import edu.rpi.legup.model.PuzzleExporter;
 import edu.rpi.legup.model.gameboard.PuzzleElement;
 import org.w3c.dom.Document;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull;
 
 public class SkyscrapersExporter extends PuzzleExporter {
 
-    public SkyscrapersExporter(Skyscrapers skyscrapers) {
+    public SkyscrapersExporter(@NotNull Skyscrapers skyscrapers) {
         super(skyscrapers);
     }
 
     @Override
-    protected org.w3c.dom.Element createBoardElement(Document newDocument) {
+    @Contract (pure = true)
+    protected @NotNull org.w3c.dom.Element createBoardElement(@NotNull Document newDocument) {
         SkyscrapersBoard board;
         if (puzzle.getTree() != null) {
             board = (SkyscrapersBoard) puzzle.getTree().getRootNode().getBoard();

src/main/java/edu/rpi/legup/puzzle/skyscrapers/SkyscrapersImporter.java

@@ -6,18 +6,22 @@
 import org.w3c.dom.Element;
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull;
 
 public class SkyscrapersImporter extends PuzzleImporter {
-    public SkyscrapersImporter(Skyscrapers skyscrapers) {
+    public SkyscrapersImporter(@NotNull Skyscrapers skyscrapers) {
         super(skyscrapers);
     }
 
     @Override
+    @Contract(pure = true, value = "-> true")
     public boolean acceptsRowsAndColumnsInput() {
         return true;
     }
 
     @Override
+    @Contract(pure = true, value = "-> false")
     public boolean acceptsTextInput() {
         return false;
     }
@@ -30,6 +34,7 @@ public boolean acceptsTextInput() {
      * @throws RuntimeException if board can not be created
      */
     @Override
+    @Contract(pure = false)
     public void initializeBoard(int rows, int columns) {
         // assert(rows == columns);
         int size = rows;
@@ -74,7 +79,8 @@ public void initializeBoard(int rows, int columns) {
      * @throws InvalidFileFormatException if file is invalid
      */
     @Override
-    public void initializeBoard(Node node) throws InvalidFileFormatException {
+    @Contract(pure = false)
+    public void initializeBoard(@NotNull Node node) throws InvalidFileFormatException {
         try {
             if (!node.getNodeName().equalsIgnoreCase("board")) {
                 throw new InvalidFileFormatException(
@@ -218,6 +224,7 @@ public void initializeBoard(Node node) throws InvalidFileFormatException {
     }
 
     @Override
+    @Contract(value = "_ -> fail", pure = false)
     public void initializeBoard(String[] statements) throws UnsupportedOperationException {
         throw new UnsupportedOperationException("Skyscrapers cannot accept text input");
     }

src/main/java/edu/rpi/legup/puzzle/skyscrapers/SkyscrapersView.java

@@ -10,6 +10,7 @@
 import java.util.ArrayList;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.jetbrains.annotations.NotNull;
 
 public class SkyscrapersView extends GridBoardView {
     private static final Logger LOGGER = LogManager.getLogger(SkyscrapersView.class.getName());
@@ -19,7 +20,7 @@ public class SkyscrapersView extends GridBoardView {
     private ArrayList<SkyscrapersClueView> southClues;
     private ArrayList<SkyscrapersClueView> westClues;
 
-    public SkyscrapersView(SkyscrapersBoard board) {
+    public SkyscrapersView(@NotNull SkyscrapersBoard board) {
         super(new BoardController(), new SkyscrapersController(), board.getDimension());
 
         this.northClues = new ArrayList<>();