Added java docs.

Author: MBenincasa

src/main/java/model/ExcelCell.java

@@ -13,19 +13,41 @@
 import java.time.LocalDateTime;
 import java.util.Date;
 
+/**
+ * {@code ExcelCell} is the {@code Cell} wrapper class of the Apache POI library
+ * @author Mirko Benincasa
+ * @since 0.3.0
+ */
 @AllArgsConstructor
 @Getter
 @EqualsAndHashCode
 public class ExcelCell {
 
+    /**
+     * This object refers to the Apache POI Library {@code Cell}
+     */
     private Cell cell;
+
+    /**
+     * The index of the Cell in the Row
+     */
     private Integer index;
 
+    /**
+     * Returns the Row to which it belongs
+     * @return A ExcelRow
+     */
     public ExcelRow getRow() {
         Row row = this.cell.getRow();
         return new ExcelRow(row, row.getRowNum());
     }
 
+    /**
+     * Read the value written inside the Cell
+     * @param type The class type of the object written to the Cell
+     * @return The value written in the Cell
+     * @throws ReadValueException If an error occurs while reading
+     */
     public Object readValue(Class<?> type) throws ReadValueException {
         Object val;
         switch (this.cell.getCellType()) {
@@ -63,6 +85,10 @@ public Object readValue(Class<?> type) throws ReadValueException {
         return val;
     }
 
+    /**
+     * Writes inside the cell
+     * @param val The value to write in the Cell
+     */
     public void writeValue(Object val) {
         if (val instanceof Integer || val instanceof Long) {
             this.formatStyle((short) 1);
@@ -86,6 +112,10 @@ public void writeValue(Object val) {
         }
     }
 
+    /**
+     * Format text according to the pattern provided
+     * @param dataFormat The Apache POI library CellStyle dataFormat
+     */
     public void formatStyle(short dataFormat) {
         ExcelWorkbook excelWorkbook = this.getRow().getSheet().getWorkbook();
         CellStyle newCellStyle = excelWorkbook.getWorkbook().createCellStyle();

src/main/java/model/ExcelRow.java

@@ -11,14 +11,30 @@
 import java.util.LinkedList;
 import java.util.List;
 
+/**
+ * {@code ExcelRow} is the {@code Row} wrapper class of the Apache POI library
+ * @author Mirko Benincasa
+ * @since 0.3.0
+ */
 @AllArgsConstructor
 @Getter
 @EqualsAndHashCode
 public class ExcelRow {
 
+    /**
+     * This object refers to the Apache POI Library {@code Row}
+     */
     private Row row;
+
+    /**
+     * The index of the Row in the Sheet
+     */
     private Integer index;
 
+    /**
+     * The list of Cells related to the Row
+     * @return A list of Cells
+     */
     public List<ExcelCell> getCells() {
         List<ExcelCell> excelCells = new LinkedList<>();
         for (Cell cell : this.row) {
@@ -28,6 +44,10 @@ public List<ExcelCell> getCells() {
         return excelCells;
     }
 
+    /**
+     * Returns the Sheet to which it belongs
+     * @return A ExcelSheet
+     */
     @SneakyThrows
     public ExcelSheet getSheet() {
         Sheet sheet = this.row.getSheet();
@@ -36,14 +56,28 @@ public ExcelSheet getSheet() {
         return new ExcelSheet(sheet, excelWorkbook.getSheet(sheetName).getIndex(), sheetName);
     }
 
+    /**
+     * Create a new Cell in the Row
+     * @param index The index in the Row
+     * @return A Cell
+     */
     public ExcelCell createCell(Integer index) {
         return new ExcelCell(this.row.createCell(index), index);
     }
 
+    /**
+     * Retrieves the index of the last Cell
+     * @return The index of the last Cell
+     */
     public Integer getLastColumnIndex() {
         return this.row.getLastCellNum() - 1;
     }
 
+    /**
+     * Counts how many Cells are compiled
+     * @param alsoEmpty {@code true} if you want to count Cells empty
+     * @return The number of Cells compiled
+     */
     public Integer countAllColumns(Boolean alsoEmpty) {
         Integer count = this.getLastColumnIndex() + 1;
         if (alsoEmpty)

src/main/java/model/ExcelSheet.java

@@ -12,19 +12,48 @@
 import java.util.LinkedList;
 import java.util.List;
 
+/**
+ * {@code ExcelSheet} is the {@code Sheet} wrapper class of the Apache POI library
+ * @author Mirko Benincasa
+ * @since 0.3.0
+ */
 @AllArgsConstructor
 @Getter
 @EqualsAndHashCode
 public class ExcelSheet {
 
+    /**
+     * This object refers to the Apache POI Library {@code Sheet}
+     */
     private Sheet sheet;
+
+    /**
+     * The index of the Sheet in the Workbook
+     */
     private Integer index;
+
+    /**
+     * The name of the Sheet
+     */
     private String name;
 
+    /**
+     * Create a new Sheet
+     * @param excelWorkbook The Workbook where to create the Sheet
+     * @return A ExcelSheet
+     * @throws SheetAlreadyExistsException If a Sheet with that name already exists
+     */
     public static ExcelSheet create(ExcelWorkbook excelWorkbook) throws SheetAlreadyExistsException {
         return create(excelWorkbook, null);
     }
 
+    /**
+     * Create a new Sheet
+     * @param excelWorkbook The Workbook where to create the Sheet
+     * @param sheetName The name of the sheet
+     * @return A ExcelSheet
+     * @throws SheetAlreadyExistsException If a Sheet with that name already exists
+     */
     public static ExcelSheet create(ExcelWorkbook excelWorkbook, String sheetName) throws SheetAlreadyExistsException {
         Workbook workbook = excelWorkbook.getWorkbook();
         Sheet sheet;
@@ -38,10 +67,18 @@ public static ExcelSheet create(ExcelWorkbook excelWorkbook, String sheetName) t
         return new ExcelSheet(sheet, workbook.getSheetIndex(sheet), sheet.getSheetName());
     }
 
+    /**
+     * Returns the Workbook to which it belongs
+     * @return A ExcelWorkbook
+     */
     public ExcelWorkbook getWorkbook() {
         return new ExcelWorkbook(this.getSheet().getWorkbook());
     }
 
+    /**
+     * The list of Rows related to the Sheet
+     * @return A list of Rows
+     */
     public List<ExcelRow> getRows() {
         List<ExcelRow> excelRows = new LinkedList<>();
         for (Row row : this.sheet) {
@@ -51,14 +88,28 @@ public List<ExcelRow> getRows() {
         return excelRows;
     }
 
+    /**
+     * Create a new Row in the Sheet
+     * @param index The index in the Sheet
+     * @return A Row
+     */
     public ExcelRow createRow(Integer index) {
         return new ExcelRow(this.sheet.createRow(index), index);
     }
 
+    /**
+     * Retrieves the index of the last Row
+     * @return The index of the last Row
+     */
     public Integer getLastRowIndex() {
         return this.sheet.getLastRowNum();
     }
 
+    /**
+     * Counts how many Rows are compiled
+     * @param alsoEmpty {@code true} if you want to count Rows that have all empty Cells
+     * @return The number of Rows compiled
+     */
     public Integer countAllRows(Boolean alsoEmpty) {
         Integer count = this.getLastRowIndex() + 1;
         if (alsoEmpty)