The missing java docs have been added

Author: MBenincasa

src/main/java/annotations/ExcelBodyStyle.java

@@ -9,13 +9,27 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/**
+ * This annotation defines the style of the Excel file body when converting a list of objects to an Excel file
+ * @author Mirko Benincasa
+ * @since 0.1.0
+ */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 public @interface ExcelBodyStyle {
 
+    /**
+     * @return the background color of the cell. The default is {@code IndexedColors.GREY_25_PERCENT}
+     */
     IndexedColors cellColor() default IndexedColors.GREY_25_PERCENT;
 
+    /**
+     * @return the horizontal orientation of the text in the cell. The default is {@code HorizontalAlignment.LEFT}
+     */
     HorizontalAlignment horizontal() default HorizontalAlignment.LEFT;
 
+    /**
+     * @return the vertical orientation of the text in the cell. The default is {@code VerticalAlignment.TOP}
+     */
     VerticalAlignment vertical() default VerticalAlignment.TOP;
 }

src/main/java/annotations/ExcelField.java

@@ -5,9 +5,17 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/**
+ * This annotation defines the header field of the Excel file
+ * @author Mirko Benincasa
+ * @since 0.1.0
+ */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.FIELD)
 public @interface ExcelField {
 
+    /**
+     * @return the name of the field written in the header.
+     */
     String name();
 }

src/main/java/annotations/ExcelHeaderStyle.java

@@ -9,15 +9,32 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/**
+ * This annotation defines the header style of the Excel file when converting a list of objects to an Excel file
+ * @author Mirko Benincasa
+ * @since 0.1.0
+ */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 public @interface ExcelHeaderStyle {
 
+    /**
+     * @return the background color of the cell. The default is {@code IndexedColors.GREY_50_PERCENT}
+     */
     IndexedColors cellColor() default IndexedColors.GREY_50_PERCENT;
 
+    /**
+     * @return the horizontal orientation of the text in the cell. The default is {@code HorizontalAlignment.LEFT}
+     */
     HorizontalAlignment horizontal() default HorizontalAlignment.LEFT;
 
+    /**
+     * @return the vertical orientation of the text in the cell. The default is {@code VerticalAlignment.TOP}
+     */
     VerticalAlignment vertical() default VerticalAlignment.TOP;
 
+    /**
+     * @return {@code true} if the autosize rules should be applied, otherwise {@code false}. The default is {@code false}
+     */
     boolean autoSize() default false;
 }

src/main/java/enums/Extension.java

@@ -7,17 +7,46 @@
 import java.util.Arrays;
 import java.util.Optional;
 
+/**
+ * This Enum defines the file extensions supported by the library.
+ * @author Mirko Benincasa
+ * @since 0.1.0
+ */
 @Getter
 @AllArgsConstructor
 public enum Extension {
 
+    /**
+     * This extension is used for a Microsoft Office spreadsheet up to version 2003
+     */
     XLS("xls", "EXCEL"),
+
+    /**
+     * This extension is used for a Microsoft Office spreadsheet from version 2007 onwards
+     */
     XLSX("xlsx", "EXCEL"),
+
+    /**
+     * This extension is used for CSV (Comma-separated values) files
+     */
     CSV("csv", "CSV");
 
+    /**
+     * The extension's name
+     */
     private final String ext;
+
+    /**
+     * The extension's type
+     */
     private final String type;
 
+    /**
+     * This method retrieves the Enum value based on the extension name provided as input
+     * @param ext the name of an Excel file extension to search for
+     * @return The Enum value that matches the name provided as input and is of type Excel
+     * @throws ExtensionNotValidException if no Enum value is found
+     */
     public static Extension getExcelExtension(String ext) throws ExtensionNotValidException {
         Optional<Extension> extensionOptional = Arrays.stream(Extension.values()).filter(e -> ext.equalsIgnoreCase(e.getExt()) && e.getType().equals("EXCEL")).findFirst();
         if (extensionOptional.isEmpty()) {

src/main/java/exceptions/ExtensionNotValidException.java

@@ -1,15 +1,48 @@
 package exceptions;
 
+/**
+ * This exception signals that the extension is invalid
+ * @author Mirko Benincasa
+ * @since 0.1.0
+ */
 public class ExtensionNotValidException extends Exception {
 
+    /**
+     * Constructs an {@code ExtensionNotValidException} with {@code null}
+     * as its error detail message.
+     */
     public ExtensionNotValidException() {
         super();
     }
 
+    /**
+     * Constructs an {@code ExtensionNotValidException} with the specified detail message.
+     *
+     * @param message
+     *        The detail message (which is saved for later retrieval
+     *        by the {@link #getMessage()} method)
+     */
     public ExtensionNotValidException(String message) {
         super(message);
     }
 
+    /**
+     * Constructs an {@code ExtensionNotValidException} 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 ExtensionNotValidException(String message, Throwable cause) {
         super(message, cause);
     }

src/main/java/exceptions/FileAlreadyExistsException.java

@@ -1,7 +1,19 @@
 package exceptions;
 
+/**
+ * This exception signals that the file already exists
+ * @author Mirko Benincasa
+ * @since 0.1.0
+ */
 public class FileAlreadyExistsException extends Exception {
 
+    /**
+     * Constructs an {@code FileAlreadyExistsException} with the specified detail message.
+     *
+     * @param message
+     *        The detail message (which is saved for later retrieval
+     *        by the {@link #getMessage()} method)
+     */
     public FileAlreadyExistsException(String message) {
         super(message);
     }

src/main/java/exceptions/HeaderNotPresentException.java

@@ -1,15 +1,48 @@
 package exceptions;
 
+/**
+ * This exception signals that the file header is missing
+ * @author Mirko Benincasa
+ * @since 0.1.0
+ */
 public class HeaderNotPresentException extends Exception {
 
+    /**
+     * Constructs an {@code HeaderNotPresentException} with {@code null}
+     * as its error detail message.
+     */
     public HeaderNotPresentException() {
         super();
     }
 
+    /**
+     * Constructs an {@code HeaderNotPresentException} with the specified detail message.
+     *
+     * @param message
+     *        The detail message (which is saved for later retrieval
+     *        by the {@link #getMessage()} method)
+     */
     public HeaderNotPresentException(String message) {
         super(message);
     }
 
+    /**
+     * Constructs an {@code HeaderNotPresentException} 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 HeaderNotPresentException(String message, Throwable cause) {
         super(message, cause);
     }

src/main/java/exceptions/OpenWorkbookException.java

@@ -1,15 +1,48 @@
 package exceptions;
 
+/**
+ * This exception signals that an error occurred while opening an Excel file workbook
+ * @author Mirko Benincasa
+ * @since 0.1.0
+ */
 public class OpenWorkbookException extends Exception {
 
+    /**
+     * Constructs an {@code OpenWorkbookException} with {@code null}
+     * as its error detail message.
+     */
     public OpenWorkbookException() {
         super();
     }
 
+    /**
+     * Constructs an {@code OpenWorkbookException} with the specified detail message.
+     *
+     * @param message
+     *        The detail message (which is saved for later retrieval
+     *        by the {@link #getMessage()} method)
+     */
     public OpenWorkbookException(String message) {
         super(message);
     }
 
+    /**
+     * Constructs an {@code OpenWorkbookException} 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 OpenWorkbookException(String message, Throwable cause) {
         super(message, cause);
     }

src/main/java/exceptions/SheetNotFoundException.java

@@ -1,11 +1,27 @@
 package exceptions;
 
+/**
+ * This exception signals that the Excel sheet was not found
+ * @author Mirko Benincasa
+ * @since 0.1.0
+ */
 public class SheetNotFoundException extends Exception {
 
+    /**
+     * Constructs an {@code SheetNotFoundException} with {@code null}
+     * as its error detail message.
+     */
     public SheetNotFoundException() {
         super();
     }
 
+    /**
+     * Constructs an {@code SheetNotFoundException} with the specified detail message.
+     *
+     * @param message
+     *        The detail message (which is saved for later retrieval
+     *        by the {@link #getMessage()} method)
+     */
     public SheetNotFoundException(String message) {
         super(message);
     }