Added methods to convert Json files to Excel. Added the remaining javadocs

Author: MBenincasa

src/main/java/io/github/mbenincasa/javaexcelutils/enums/Extension.java

@@ -32,6 +32,7 @@ public enum Extension {
     CSV("csv", "CSV"),
 
     /**
+     * @since 0.4.0
      * This extension is used for JSON (JavaScript Object Notation) files
      */
     JSON("json", "JSON");
@@ -65,6 +66,6 @@ public static Extension getExcelExtension(String ext) throws ExtensionNotValidEx
      * @since 0.1.1
      */
     public Boolean isExcelExtension() {
-        return this.getType().equalsIgnoreCase("EXCEL");
+        return this.type.equalsIgnoreCase("EXCEL");
     }
 }

src/main/java/io/github/mbenincasa/javaexcelutils/model/converter/ExcelToObject.java

@@ -4,11 +4,24 @@
 import lombok.Getter;
 import lombok.Setter;
 
+/**
+ * This is a support class that is used by the {@code Converter} to perform conversions from Excel to Objects
+ * @author Mirko Benincasa
+ * @since 0.4.0
+ * @param <T> The class parameter, for each Sheet, that maps a row into the parameter object
+ */
 @AllArgsConstructor
 @Getter
 @Setter
 public class ExcelToObject<T> {
 
+    /**
+     * The name of the Sheet to read
+     */
     private String sheetName;
+
+    /**
+     * The object class
+     */
     private Class<T> clazz;
 }

src/main/java/io/github/mbenincasa/javaexcelutils/model/converter/JsonToExcel.java

@@ -0,0 +1,27 @@
+package io.github.mbenincasa.javaexcelutils.model.converter;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.Setter;
+
+/**
+ * This is a support class that is used by the {@code Converter} to perform conversions from Json to Excel
+ * @author Mirko Benincasa
+ * @since 0.4.0
+ * @param <T> The class parameter, for each Sheet, that maps a Json object into the parameter object
+ */
+@AllArgsConstructor
+@Getter
+@Setter
+public class JsonToExcel<T> {
+
+    /**
+     * The name to assign to the Sheet
+     */
+    private String sheetName;
+
+    /**
+     * The object class
+     */
+    private Class<T> clazz;
+}

src/main/java/io/github/mbenincasa/javaexcelutils/model/converter/ObjectToExcel.java

@@ -6,12 +6,29 @@
 
 import java.util.stream.Stream;
 
+/**
+ * This is a helper class used by {@code Converter} to convert objects in an Excel Sheet
+ * @author Mirko Benincasa
+ * @since 0.4.0
+ * @param <T> The class parameter, for each sheet, which maps objects to a Sheet
+ */
 @AllArgsConstructor
 @Getter
 @Setter
 public class ObjectToExcel<T> {
 
+    /**
+     * The name to assign to the Sheet
+     */
     private String sheetName;
+
+    /**
+     * The object class
+     */
     private Class<T> clazz;
+
+    /**
+     * A Stream of objects
+     */
     private Stream<T> stream;
 }

src/main/java/io/github/mbenincasa/javaexcelutils/model/excel/ExcelCell.java

@@ -39,6 +39,12 @@ public ExcelRow getRow() {
         return new ExcelRow(row, row.getRowNum());
     }
 
+    /**
+     * Read the value written inside the Cell
+     * @return The value written in the Cell
+     * @throws ReadValueException If an error occurs while reading
+     * @since 0.4.0
+     */
     public Object readValue() throws ReadValueException {
         Object val;
         switch (this.cell.getCellType()) {
@@ -106,6 +112,11 @@ public Object readValue(Class<?> type) throws ReadValueException {
         return val;
     }
 
+    /**
+     * Read the value written inside the Cell as String
+     * @return The value written in the Cell
+     * @since 0.4.0
+     */
     public String readValueAsString() {
         DataFormatter formatter = new DataFormatter(true);
         return formatter.formatCellValue(this.cell);

src/main/java/io/github/mbenincasa/javaexcelutils/model/excel/ExcelWorkbook.java

@@ -190,6 +190,7 @@ public void close(CSVWriter writer) throws IOException {
     }
 
     /**
+     * Close a workbook
      * @param outputStream The {@code OutputStream} to close
      * @param reader The {@code CSVReader} to close
      * @throws IOException If an I/O error has occurred
@@ -351,6 +352,13 @@ public FormulaEvaluator getFormulaEvaluator() {
         return this.workbook.getCreationHelper().createFormulaEvaluator();
     }
 
+
+    /**
+     * Writes the OutputStream to the Workbook and then closes them
+     * @param outputStream The {@code OutputStream} to close
+     * @throws IOException If an I/O error has occurred
+     * @since 0.4.0
+     */
     public void writeAndClose(OutputStream outputStream) throws IOException {
         this.workbook.write(outputStream);
         this.close(outputStream);

src/main/java/io/github/mbenincasa/javaexcelutils/samples/convertJsonFileToExcelFile/Main.java

@@ -0,0 +1,26 @@
+package io.github.mbenincasa.javaexcelutils.samples.convertJsonFileToExcelFile;
+
+import io.github.mbenincasa.javaexcelutils.enums.Extension;
+import io.github.mbenincasa.javaexcelutils.model.converter.JsonToExcel;
+import io.github.mbenincasa.javaexcelutils.tools.Converter;
+
+import java.io.File;
+
+public class Main {
+
+    public static void main(String[] args) {
+
+        File jsonFile = new File("./src/main/resources/office.json");
+
+        try {
+            System.out.println("Start the conversion...");
+            JsonToExcel<Office> officeJsonToExcel = new JsonToExcel<>("office", Office.class);
+            File excelFile = Converter.jsonToExcelFile(jsonFile, officeJsonToExcel, Extension.XLSX, "./src/main/resources/from-json-to-excel", true);
+            System.out.println("... completed");
+            System.out.println("The file is ready. Path: " + excelFile.getAbsolutePath());
+        } catch (Exception e) {
+            System.err.println("There was an error. Check the console");
+            throw new RuntimeException(e);
+        }
+    }
+}

src/main/java/io/github/mbenincasa/javaexcelutils/samples/convertJsonFileToExcelFile/Office.java

@@ -0,0 +1,29 @@
+package io.github.mbenincasa.javaexcelutils.samples.convertJsonFileToExcelFile;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import io.github.mbenincasa.javaexcelutils.annotations.ExcelBodyStyle;
+import io.github.mbenincasa.javaexcelutils.annotations.ExcelField;
+import io.github.mbenincasa.javaexcelutils.annotations.ExcelHeaderStyle;
+import lombok.AllArgsConstructor;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+import lombok.ToString;
+
+@AllArgsConstructor
+@NoArgsConstructor
+@Setter
+@ToString
+@ExcelHeaderStyle(autoSize = true)
+@ExcelBodyStyle
+public class Office {
+
+    @ExcelField(name = "CITY")
+    @JsonProperty("CITY")
+    private String city;
+    @ExcelField(name = "PROVINCE")
+    @JsonProperty("PROVINCE")
+    private String province;
+    @ExcelField(name = "NUMBER OF STATIONS")
+    @JsonProperty("NUMBER OF STATIONS")
+    private Integer numStations;
+}