Merge pull request #6 from MBenincasa/develop

Develop

Author: MBenincasa

README.md

@@ -5,57 +5,58 @@
 # Java Excel Utils
 
 ## Introduction
-Java Excel Utils is still an embryonic project. This open source library will collect different tools to speed up the work with Excel files.
+Java Excel Utils is a Java library with the aim of making working with Microsoft Excel sheets easier. The library uses Apache POI components extending their potential.<br>
+
+## Quickstart
+There are wrapper classes for the main components of an Excel sheet: **ExcelWorkbook**, **ExcelSheet**, **ExcelRow** and **ExcelCell**.
+```
+public void modelTest() {
+    ExcelWorkbook excelWorkbook = ExcelWorkbook.create(Extension.XLSX);
+    ExcelSheet excelSheet = excelWorkbook.createSheet("TEST");
+    ExcelRow excelRow = excelSheet.createRow(0);
+    ExcelCell excelCell = excelRow.createCell(0);
+    excelCell.writeValue("Rossi");
+    String lastName = excelCell.readValue(String.class);
+}
+```
+
+This code snippet shows how wrappat components can be instantiated. The last lines show how it is possible to write and read inside a cell.<br>
+The classes have many other features, such as the ability to count the number of rows and columns present excluding, if you want, the empty ones.<p>
+At any time you can retrieve the associated Apache POI components.
+
+```
+public void toPOI() {
+    Workbook workbook = excelWorkbook.getWorkbook();
+    Sheet sheet = excelSheet.getSheet();
+    Row row = excelRow.getRow();
+    Cell cell = excelCell.getCell();
+}
+```
+
+One of the main features of the library is to be able to perform conversions. The **Converter** class has methods that convert **Excel <-> POJOs** and **Excel <-> CSV**.<br>
+This is an example of Excel to POJOs:
+```
+public void ExcelToObjects() {
+    File file = new File("./src/main/resources/car.xlsx");
+    List<Car> cars = (List<Car>) Converter.excelToObjects(file, Car.class);
+}
+```
 
 ## Documentation
-The javadocs of all public methods are available. Some examples are also available in the `samples` package.
+At the moment a real documentation is not yet available, but the javadocs and some examples are available in the `samples` package.<br>
+Click [here](https://repo1.maven.org/maven2/io/github/mbenincasa/java-excel-utils/0.3.0/java-excel-utils-0.3.0-javadoc.jar) to download the javadocs.
 
 ## Minimum Requirements
 Java 17 or above.
 
 ## Dependencies
-```xml
-<dependencies>
-    <dependency>
-        <groupId>org.apache.poi</groupId>
-        <artifactId>poi</artifactId>
-        <version>5.2.3</version>
-    </dependency>
-    <dependency>
-        <groupId>org.apache.poi</groupId>
-        <artifactId>poi-ooxml</artifactId>
-        <version>5.2.3</version>
-    </dependency>
-    <dependency>
-        <groupId>org.projectlombok</groupId>
-        <artifactId>lombok</artifactId>
-        <version>1.18.24</version>
-        <scope>provided</scope>
-    </dependency>
-    <dependency>
-        <groupId>commons-beanutils</groupId>
-        <artifactId>commons-beanutils</artifactId>
-        <version>1.9.4</version>
-    </dependency>
-    <dependency>
-        <groupId>com.opencsv</groupId>
-        <artifactId>opencsv</artifactId>
-        <version>5.7.1</version>
-    </dependency>
-    <dependency>
-        <groupId>org.junit.jupiter</groupId>
-        <artifactId>junit-jupiter</artifactId>
-        <version>5.9.2</version>
-        <scope>test</scope>
-    </dependency>
-    <dependency>
-        <groupId>org.junit.platform</groupId>
-        <artifactId>junit-platform-suite-engine</artifactId>
-        <version>1.9.2</version>
-        <scope>test</scope>
-    </dependency>
-</dependencies>
-```
+- org.apache.poi:poi:jar:5.2.3
+- org.apache.poi:poi-ooxml:jar:5.2.3
+- org.projectlombok:lombok:jar:1.18.24
+- commons-beanutils:commons-beanutils:jar:1.9.4
+- com.opencsv:opencsv:jar:5.7.1
+- org.junit.jupiter:junit-jupiter:jar:5.9.2
+- org.junit.platform:junit-platform-suite-engine:jar:1.9.2
 
 ## Maven
 ```xml
@@ -67,7 +68,8 @@ Java 17 or above.
 ```
 
 ## Roadmap
-There is still no well-defined roadmap, but there is the idea of bringing various features
+**Version 0.4.0** will bring new features to the Converter class. Current conversions will be reviewed. Conversions will be available that will also work with Stream I/O and byte[] in addition to the already present File.<p>
+In the future, new features will come that have not yet been well defined.
 
 ## Contributing
 Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

src/main/java/annotations/ExcelBodyStyle.java renamed to src/main/java/io/github/mbenincasa/javaexcelutils/annotations/ExcelBodyStyle.java

@@ -1,4 +1,4 @@
-package annotations;
+package io.github.mbenincasa.javaexcelutils.annotations;
 
 import org.apache.poi.ss.usermodel.HorizontalAlignment;
 import org.apache.poi.ss.usermodel.IndexedColors;

src/main/java/annotations/ExcelField.java renamed to src/main/java/io/github/mbenincasa/javaexcelutils/annotations/ExcelField.java

@@ -1,4 +1,4 @@
-package annotations;
+package io.github.mbenincasa.javaexcelutils.annotations;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;

src/main/java/annotations/ExcelHeaderStyle.java renamed to src/main/java/io/github/mbenincasa/javaexcelutils/annotations/ExcelHeaderStyle.java

@@ -1,4 +1,4 @@
-package annotations;
+package io.github.mbenincasa.javaexcelutils.annotations;
 
 import org.apache.poi.ss.usermodel.HorizontalAlignment;
 import org.apache.poi.ss.usermodel.IndexedColors;

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

@@ -1,6 +1,6 @@
-package enums;
+package io.github.mbenincasa.javaexcelutils.enums;
 
-import exceptions.ExtensionNotValidException;
+import io.github.mbenincasa.javaexcelutils.exceptions.ExtensionNotValidException;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 

src/main/java/exceptions/ExtensionNotValidException.java renamed to src/main/java/io/github/mbenincasa/javaexcelutils/exceptions/ExtensionNotValidException.java

@@ -1,4 +1,4 @@
-package exceptions;
+package io.github.mbenincasa.javaexcelutils.exceptions;
 
 /**
  * This exception signals that the extension is invalid

src/main/java/exceptions/FileAlreadyExistsException.java renamed to src/main/java/io/github/mbenincasa/javaexcelutils/exceptions/FileAlreadyExistsException.java

@@ -1,4 +1,4 @@
-package exceptions;
+package io.github.mbenincasa.javaexcelutils.exceptions;
 
 /**
  * This exception signals that the file already exists

src/main/java/exceptions/HeaderNotPresentException.java renamed to src/main/java/io/github/mbenincasa/javaexcelutils/exceptions/HeaderNotPresentException.java

@@ -1,4 +1,4 @@
-package exceptions;
+package io.github.mbenincasa.javaexcelutils.exceptions;
 
 /**
  * This exception signals that the file header is missing

src/main/java/exceptions/OpenWorkbookException.java renamed to src/main/java/io/github/mbenincasa/javaexcelutils/exceptions/OpenWorkbookException.java

@@ -1,4 +1,4 @@
-package exceptions;
+package io.github.mbenincasa.javaexcelutils.exceptions;
 
 /**
  * This exception signals that an error occurred while opening an Excel file workbook

src/main/java/exceptions/ReadValueException.java renamed to src/main/java/io/github/mbenincasa/javaexcelutils/exceptions/ReadValueException.java

@@ -1,4 +1,4 @@
-package exceptions;
+package io.github.mbenincasa.javaexcelutils.exceptions;
 
 /**
  * This exception signals that there was an error reading a cell value