SheetUtility has been deprecated and has been replaced by ExcelSheet.

Author: MBenincasa

src/main/java/exceptions/SheetAlreadyExistsException.java

@@ -0,0 +1,49 @@
+package exceptions;
+
+/**
+ * This exception signals that you are trying to insert a sheet into a workbook that already contains that name
+ * @author Mirko Benincasa
+ * @since 0.3.0
+ */
+public class SheetAlreadyExistsException extends Exception {
+
+    /**
+     * Constructs an {@code SheetAlreadyExistsException} with {@code null}
+     * as its error detail message.
+     */
+    public SheetAlreadyExistsException() {
+        super();
+    }
+
+    /**
+     * Constructs an {@code SheetAlreadyExistsException} with the specified detail message.
+     *
+     * @param message
+     *        The detail message (which is saved for later retrieval
+     *        by the {@link #getMessage()} method)
+     */
+    public SheetAlreadyExistsException(String message) {
+        super(message);
+    }
+
+    /**
+     * Constructs an {@code SheetAlreadyExistsException} with the specified detail message
+     * and cause.
+     *
+     * <p> Note that the detail message associated with {@code cause} is
+     * <i>not</i> automatically incorporated into this exception's detail
+     * message.
+     *
+     * @param message
+     *        The detail message (which is saved for later retrieval
+     *        by the {@link #getMessage()} method)
+     *
+     * @param cause
+     *        The cause (which is saved for later retrieval by the
+     *        {@link #getCause()} method).  (A null value is permitted,
+     *        and indicates that the cause is nonexistent or unknown.)
+     */
+    public SheetAlreadyExistsException(String message, Throwable cause) {
+        super(message, cause);
+    }
+}

src/main/java/model/ExcelSheet.java

@@ -1,10 +1,37 @@
 package model;
 
+import exceptions.SheetAlreadyExistsException;
 import lombok.AllArgsConstructor;
+import lombok.Getter;
 import org.apache.poi.ss.usermodel.Sheet;
+import org.apache.poi.ss.usermodel.Workbook;
 
 @AllArgsConstructor
+@Getter
 public class ExcelSheet {
 
     private Sheet sheet;
+    private Integer index;
+    private String name;
+
+    public static ExcelSheet create(ExcelWorkbook excelWorkbook) throws SheetAlreadyExistsException {
+        return create(excelWorkbook, null);
+    }
+
+    public static ExcelSheet create(ExcelWorkbook excelWorkbook, String sheetName) throws SheetAlreadyExistsException {
+        Workbook workbook = excelWorkbook.getWorkbook();
+        Sheet sheet;
+        try {
+            sheet = (sheetName == null || sheetName.isEmpty())
+                    ? workbook.createSheet()
+                    : workbook.createSheet(sheetName);
+        } catch (IllegalArgumentException e) {
+            throw new SheetAlreadyExistsException(e.getMessage(), e.getCause());
+        }
+        return new ExcelSheet(sheet, workbook.getSheetIndex(sheet), sheet.getSheetName());
+    }
+
+    public ExcelWorkbook getExcelWorkbook() {
+        return new ExcelWorkbook(this.getSheet().getWorkbook());
+    }
 }

src/main/java/model/ExcelWorkbook.java

@@ -5,16 +5,23 @@
 import enums.Extension;
 import exceptions.ExtensionNotValidException;
 import exceptions.OpenWorkbookException;
+import exceptions.SheetNotFoundException;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
+import lombok.SneakyThrows;
 import org.apache.poi.hssf.usermodel.HSSFWorkbook;
 import org.apache.poi.openxml4j.exceptions.OLE2NotOfficeXmlFileException;
 import org.apache.poi.poifs.filesystem.OfficeXmlFileException;
+import org.apache.poi.ss.usermodel.Sheet;
 import org.apache.poi.ss.usermodel.Workbook;
 import org.apache.poi.xssf.usermodel.XSSFWorkbook;
 import tools.ExcelUtility;
 
 import java.io.*;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Objects;
+import java.util.Optional;
 
 @AllArgsConstructor
 @Getter
@@ -108,4 +115,69 @@ public void close(OutputStream outputStream, CSVReader reader) throws IOExceptio
         outputStream.close();
         reader.close();
     }
+
+    public Integer length() {
+        return this.workbook.getNumberOfSheets();
+    }
+
+    public List<ExcelSheet> getSheets() {
+        List<ExcelSheet> excelSheets = new LinkedList<>();
+        for (Sheet sheet : this.workbook) {
+            excelSheets.add(new ExcelSheet(sheet, this.workbook.getSheetIndex(sheet), sheet.getSheetName()));
+        }
+        return excelSheets;
+    }
+
+    public ExcelSheet getSheet(Integer index) throws SheetNotFoundException {
+        List<ExcelSheet> excelSheets = this.getSheets();
+        for (ExcelSheet excelSheet : excelSheets) {
+            if (Objects.equals(excelSheet.getIndex(), index))
+                return excelSheet;
+        }
+
+        throw new SheetNotFoundException("No sheet was found in the index: " + index);
+    }
+
+    public ExcelSheet getSheet(String sheetName) throws SheetNotFoundException {
+        List<ExcelSheet> excelSheets = this.getSheets();
+        for (ExcelSheet excelSheet : excelSheets) {
+            if (excelSheet.getName().equals(sheetName))
+                return excelSheet;
+        }
+
+        throw new SheetNotFoundException("No sheet was found with the name: " + sheetName);
+    }
+
+    @SneakyThrows
+    public ExcelSheet getSheetOrCreate(String sheetName) {
+        try {
+            return this.getSheet(sheetName);
+        } catch (SheetNotFoundException e) {
+            return ExcelSheet.create(this, sheetName);
+        }
+    }
+
+    public Boolean isSheetPresent(String sheetName) {
+        List<ExcelSheet> excelSheets = this.getSheets();
+        Optional<ExcelSheet> excelSheet = excelSheets.stream().filter(s -> s.getName().equals(sheetName)).findAny();
+        return excelSheet.isPresent();
+    }
+
+    public Boolean isSheetPresent(Integer index) {
+        List<ExcelSheet> excelSheets = this.getSheets();
+        Optional<ExcelSheet> excelSheet = excelSheets.stream().filter(s -> Objects.equals(s.getIndex(), index)).findAny();
+        return excelSheet.isPresent();
+    }
+
+    public Boolean isSheetNull(String sheetName) {
+        List<ExcelSheet> excelSheets = this.getSheets();
+        Optional<ExcelSheet> excelSheet = excelSheets.stream().filter(s -> s.getName().equals(sheetName)).findAny();
+        return excelSheet.isEmpty();
+    }
+
+    public Boolean isSheetNull(Integer index) {
+        List<ExcelSheet> excelSheets = this.getSheets();
+        Optional<ExcelSheet> excelSheet = excelSheets.stream().filter(s -> Objects.equals(s.getIndex(), index)).findAny();
+        return excelSheet.isEmpty();
+    }
 }

src/main/java/samples/sheetSample/Main.java

@@ -1,8 +1,7 @@
 package samples.sheetSample;
 
+import model.ExcelSheet;
 import model.ExcelWorkbook;
-import org.apache.poi.ss.usermodel.Workbook;
-import tools.SheetUtility;
 
 import java.io.File;
 import java.util.List;
@@ -13,22 +12,21 @@ public static void main(String[] args) {
         File file = new File("./src/main/resources/employee.xlsx");
 
         try {
-            int totalSheets = SheetUtility.length(file);
+            ExcelWorkbook excelWorkbook = ExcelWorkbook.open(file);
+            int totalSheets = excelWorkbook.length();
             System.out.println("Total: " + totalSheets);
-            List<String> sheetnames = SheetUtility.getNames(file);
+            List<String> sheetnames = excelWorkbook.getSheets().stream().map(ExcelSheet::getName).toList();
             System.out.println("Sheet names: " + sheetnames);
-            int sheetIndex = SheetUtility.getIndex(file, "Employee");
+            int sheetIndex = excelWorkbook.getSheet("Employee").getIndex();
             System.out.println("Sheet index: " + sheetIndex);
-            String sheetName = SheetUtility.getName(file, 0);
+            String sheetName = excelWorkbook.getSheet(0).getName();
             System.out.println("Sheet name: " + sheetName);
 
-            ExcelWorkbook excelWorkbook = ExcelWorkbook.open(file);
-            Workbook workbook = excelWorkbook.getWorkbook();
             String sheetNameTest = "test";
             int sheetIndexTest = 0;
-            Boolean isPresentByName = SheetUtility.isPresent(workbook, sheetNameTest);
+            Boolean isPresentByName = excelWorkbook.isSheetPresent(sheetNameTest);
             System.out.println("Sheet is: " + sheetNameTest + ". It is present: " + isPresentByName);
-            Boolean isPresentByPosition = SheetUtility.isPresent(workbook, 0);
+            Boolean isPresentByPosition = excelWorkbook.isSheetPresent(0);
             System.out.println("Sheet index: " + sheetIndexTest + ". It is present: " + isPresentByPosition);
             excelWorkbook.close();
         } catch (Exception e) {