refactor: add contains checks for indexes and add javadocs

Author: ugur-vaadin

vaadin-spreadsheet-flow-parent/vaadin-spreadsheet-flow/src/main/java/com/vaadin/flow/component/spreadsheet/CellSet.java

@@ -1,36 +1,118 @@
+/*
+ * Copyright 2023 Vaadin Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
 package com.vaadin.flow.component.spreadsheet;
 
 import org.apache.poi.ss.util.CellReference;
 
 import java.util.Collections;
+import java.util.Objects;
 import java.util.Set;
 
+/**
+ * CellSet is a set of cells that also provides utilities regarding the contents
+ * of the set.
+ */
 public class CellSet {
 
     private final Set<CellReference> cells;
 
+    /**
+     * Creates a set with the specified cells
+     *
+     * @param cells
+     *            cells to construct the set with, not {@code null}
+     */
     public CellSet(Set<CellReference> cells) {
+        Objects.requireNonNull(cells, "Cells cannot be null");
         this.cells = cells;
     }
 
+    /**
+     * Gets an unmodifiable set of the cells
+     *
+     * @return an unmodifiable set of the cells
+     */
     public Set<CellReference> getCells() {
         return Collections.unmodifiableSet(cells);
     }
 
+    /**
+     * Gets the number of the cells
+     *
+     * @return number of cells
+     */
     public int getCellCount() {
         return cells.size();
     }
 
-    public boolean containsCell(CellReference cell) {
+    /**
+     * Whether the set contains the specified cell. Does not take the sheet
+     * names of the cells in set into account if the sheet name of the cell
+     * reference is {@code null}.
+     *
+     * @param cellReference
+     *            cell to be checked whether it exists in the set
+     * @return {@code true} if set contains the specified cell, {@code false}
+     *         otherwise
+     */
+    public boolean containsCell(CellReference cellReference) {
         if (cells.isEmpty()) {
             return false;
         }
-        if (cell.getSheetName() == null) {
+        if (cellReference.getSheetName() == null) {
             CellReference cellWithSheetName = new CellReference(
-                    cells.iterator().next().getSheetName(), cell.getRow(),
-                    cell.getCol(), cell.isRowAbsolute(), cell.isColAbsolute());
+                    cells.iterator().next().getSheetName(),
+                    cellReference.getRow(), cellReference.getCol(),
+                    cellReference.isRowAbsolute(),
+                    cellReference.isColAbsolute());
             return cells.contains(cellWithSheetName);
         }
-        return cells.contains(cell);
+        return cells.contains(cellReference);
+    }
+
+    /**
+     * Whether the set contains the specified cell. Does not take the sheet
+     * names of the cells in set into account.
+     *
+     * @param row
+     *            row index of the cell, 0-based
+     * @param col
+     *            col index of the cell, 0-based
+     * @return {@code true} if set contains the specified cell, {@code false}
+     *         otherwise
+     */
+    public boolean containsCell(int row, int col) {
+        return containsCell(new CellReference(row, col));
+    }
+
+    /**
+     * Whether the set contains the specified cell
+     *
+     * @param row
+     *            row index of the cell, 0-based
+     * @param col
+     *            col index of the cell, 0-based
+     * @param sheetName
+     *            sheet name of the cell, not {@code null}
+     * @return {@code true} if set contains the specified cell, {@code false}
+     *         otherwise
+     */
+    public boolean containsCell(int row, int col, String sheetName) {
+        Objects.requireNonNull(sheetName, "The sheet name cannot be null");
+        return containsCell(
+                new CellReference(sheetName, row, col, false, false));
     }
 }

vaadin-spreadsheet-flow-parent/vaadin-spreadsheet-flow/src/test/java/com/vaadin/flow/component/spreadsheet/tests/CellValueChangeEventOnFormulaChangeTest.java

@@ -9,6 +9,7 @@
 package com.vaadin.flow.component.spreadsheet.tests;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
 
 import java.util.concurrent.atomic.AtomicReference;
@@ -65,8 +66,22 @@ public void formulaChangeResultingInSameValue() {
         assertTrue("The changed cells should include C1 with sheet name",
                 changedCells.get()
                         .containsCell(new CellReference("Sheet0!C1")));
+        assertFalse(
+                "The changed cells should not include C1 with a wrong sheet name",
+                changedCells.get()
+                        .containsCell(new CellReference("Sheet1!C1")));
         assertTrue("The changed cells should include C1 without sheet name",
                 changedCells.get().containsCell(new CellReference("C1")));
+        assertTrue(
+                "The changed cells should include a cell with correct indexes without a sheet name",
+                changedCells.get().containsCell(0, 2));
+        assertTrue(
+                "The changed cells should include a cell with correct indexes and sheet name",
+                changedCells.get().containsCell(0, 2, "Sheet0"));
+        assertFalse(
+                "The changed cells should not include a cell with correct indexes and a wrong sheet name",
+                changedCells.get().containsCell(0, 2, "Sheet1"));
+
     }
 
 }