Added missing javadoc

Author: jameskleeh

src/main/groovy/com/jameskleeh/excel/CellStyleBuilder.groovy

@@ -39,7 +39,7 @@ import java.awt.Color
  * A class to build an {@link org.apache.poi.xssf.usermodel.XSSFCellStyle} from a map
  *
  * @author James Kleeh
- * @since 1.0.0
+ * @since 0.1.0
  */
 @CompileStatic
 class CellStyleBuilder {
@@ -440,6 +440,12 @@ class CellStyleBuilder {
         }
     }
 
+    /**
+     * Merges multiple maps
+     *
+     * @param sources The maps to merge
+     * @return The merged map
+     */
     @CompileStatic(TypeCheckingMode.SKIP)
     Map merge(Map[] sources) {
         if (sources.length == 0) {

src/main/groovy/com/jameskleeh/excel/Column.groovy

@@ -27,6 +27,12 @@ import org.apache.poi.xssf.usermodel.XSSFSheet
 import org.apache.poi.xssf.usermodel.XSSFWorkbook
 import org.apache.poi.ss.usermodel.Row.MissingCellPolicy
 
+/**
+ * A class designed to be a delegate when a column is created
+ *
+ * @author James Kleeh
+ * @since 0.2.0
+ */
 @CompileStatic
 class Column extends CreatesCells {
 
@@ -50,10 +56,16 @@ class Column extends CreatesCells {
         cell
     }
 
+    /**
+     * @see CreatesCells#skipCells
+     */
     void skipCells(int num) {
         rowIdx += num
     }
 
+    /**
+     * @see CreatesCells#merge(Map style, Closure callable)
+     */
     @Override
     void merge(Map style, @DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = Column) Closure callable) {
         Map existingDefaultOptions = defaultOptions
@@ -78,6 +90,9 @@ class Column extends CreatesCells {
         defaultOptions = existingDefaultOptions
     }
 
+    /**
+     * @see CreatesCells#merge(Closure callable)
+     */
     @Override
     void merge(@DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = Column) Closure callable) {
         merge(null, callable)

src/main/groovy/com/jameskleeh/excel/Excel.groovy

@@ -26,6 +26,9 @@ import java.util.concurrent.atomic.AtomicInteger
 /**
  * A class to store cell renderers and formatters used to set cell
  * data and format
+ *
+ * @author James Kleeh
+ * @since 0.1.0
  */
 @CompileStatic
 class Excel {
@@ -47,14 +50,34 @@ class Excel {
         registerCellFormat(Date, 'm/d/yyyy')
     }
 
+    /**
+     * Registers a cell renderer. What is returned from the closure will be set to the cell value
+     *
+     * @param clazz The class to render
+     * @param priority The priority
+     * @param callable The closure to call
+     */
     static void registerCellRenderer(Class clazz, Integer priority, Closure callable) {
         rendererEntries.add(new Entry(clazz, callable, priority))
     }
 
+    /**
+     * Registers a cell renderer. What is returned from the closure will be set to the cell value
+     *
+     * @param clazz The class to render
+     * @param callable The closure to call
+     */
     static void registerCellRenderer(Class clazz, Closure callable) {
         registerCellRenderer(clazz, -1, callable)
     }
 
+    /**
+     * Registers a cell format
+     *
+     * @param clazz The class to render
+     * @param priority The priority
+     * @param format The format to apply
+     */
     static void registerCellFormat(Class clazz, Integer priority, String format) {
         int builtInFormat = BuiltinFormats.getBuiltinFormat(format)
         if (builtInFormat > -1) {
@@ -64,18 +87,43 @@ class Excel {
         }
     }
 
+    /**
+     * Registers a cell format
+     *
+     * @param clazz The class to render
+     * @param format The format to apply
+     */
     static void registerCellFormat(Class clazz, String format) {
         registerCellFormat(clazz, -1, format)
     }
 
+    /**
+     * Registers a cell format
+     *
+     * @param clazz The class to render
+     * @param priority The priority
+     * @param format The format to apply
+     */
     static void registerCellFormat(Class clazz, Integer priority, int format) {
         formatEntries.add(new FormatEntry(clazz, format, priority))
     }
 
+    /**
+     * Registers a cell format
+     *
+     * @param clazz The class to render
+     * @param format The format to apply
+     */
     static void registerCellFormat(Class clazz, int format) {
         registerCellFormat(clazz, -1, format)
     }
 
+    /**
+     * Queries the renderers registered
+     *
+     * @param clazz The class to search for
+     * @return The renderer. Null if not found
+     */
     static Closure getRenderer(Class clazz) {
         for (Entry entry : rendererEntries) {
             if (entry.clazz == clazz || entry.clazz.isAssignableFrom(clazz)) {
@@ -85,6 +133,12 @@ class Excel {
         null
     }
 
+    /**
+     * Queries the formats registered
+     *
+     * @param clazz The class to search for
+     * @return The format. Null if not found
+     */
     static Object getFormat(Class clazz) {
         for (FormatEntry entry : formatEntries) {
             if (entry.clazz == clazz || entry.clazz.isAssignableFrom(clazz)) {

src/main/groovy/com/jameskleeh/excel/ExcelBuilder.groovy

@@ -23,15 +23,30 @@ import org.apache.poi.xssf.usermodel.XSSFWorkbook
 
 /**
  * The main class used to start building an excel document
+ *
+ * @author James Kleeh
+ * @since 0.1.0
  */
 @CompileStatic
 class ExcelBuilder {
 
+    /**
+     * Builds an excel document and sends the data to an output stream. The output stream is NOT closed.
+     *
+     * @param outputStream An output stream to push data onto
+     * @param callable The closure to build the document
+     */
     static void output(OutputStream outputStream, @DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = Workbook) Closure callable) {
         XSSFWorkbook wb = build(callable)
         wb.write(outputStream)
     }
 
+    /**
+     * Builds an excel document
+     *
+     * @param callable The closure to build the document
+     * @return The native workbook
+     */
     static XSSFWorkbook build(@DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = Workbook) Closure callable) {
         XSSFWorkbook wb = new XSSFWorkbook()
         callable.resolveStrategy = Closure.DELEGATE_FIRST

src/main/groovy/com/jameskleeh/excel/Font.groovy

@@ -22,7 +22,7 @@ package com.jameskleeh.excel
  * Text decoration to apply to cell styles
  *
  * @author James Kleeh
- * @since 1.0.0
+ * @since 0.1.0
  */
 enum Font {
     ITALIC, STRIKEOUT, BOLD, UNDERLINE

src/main/groovy/com/jameskleeh/excel/Formula.groovy

@@ -26,7 +26,7 @@ import org.apache.poi.xssf.usermodel.XSSFCell
  * A class to get references to cells for use in formulas
  *
  * @author James Kleeh
- * @since 1.0.0
+ * @since 0.1.0
  */
 @CompileStatic
 class Formula {
@@ -39,10 +39,16 @@ class Formula {
         this.columnIndexes = columnIndexes
     }
 
+    /**
+     * @return The current row number (1 based)
+     */
     int getRow() {
         cell.rowIndex + 1
     }
 
+    /**
+     * @return The current column (A..Z)
+     */
     String getColumn() {
         relativeColumn(0)
     }
@@ -67,21 +73,48 @@ class Formula {
         }
     }
 
+    /**
+     * Retrieves a cell relative to the current cell. Use negative values to reference rows and columns before the current cell and positive values to reference rows and columns after the current cell.
+     *
+     * @param columnIndex The column index
+     * @param rowIndex The row index
+     * @return A cell relative to the current cell
+     */
     String relativeCell(int columnIndex, int rowIndex) {
         relativeColumn(columnIndex) + relativeRow(rowIndex)
     }
 
+    /**
+     * Retrieves a cell relative to the current cell. Use negative values to reference previous columns and positive values to reference columns after the current cell.
+     *
+     * @param columnIndex The column index
+     * @return A cell relative to the current cell
+     */
     String relativeCell(int columnIndex) {
         relativeCell(columnIndex, 0)
     }
 
+    /**
+     * Retrieves an exact cell reference
+     *
+     * @param columnIndex The column index
+     * @param rowIndex The row index
+     * @return The desired cell
+     */
     String exactCell(int columnIndex, int rowIndex) {
         if (rowIndex < 0) {
             throw new IllegalArgumentException("An invalid row index of $rowIndex was specified")
         }
         exactColumn(columnIndex) + (rowIndex + 1)
     }
 
+    /**
+     * Retrieves an exact cell reference based on a previously defined column definition (created by {@link com.jameskleeh.excel.internal.CreatesCells#column} and row index
+     *
+     * @param columnName The column identifier
+     * @param rowIndex The row index
+     * @return The desired cell
+     */
     String exactCell(String columnName, int rowIndex) {
         if (columnIndexes && columnIndexes.containsKey(columnName)) {
             exactCell(columnIndexes[columnName], rowIndex)
@@ -90,6 +123,12 @@ class Formula {
         }
     }
 
+    /**
+     * Retrieves an exact cell reference based on a previously defined column definition (created by {@link com.jameskleeh.excel.internal.CreatesCells#column}
+     *
+     * @param columnName The column identifier
+     * @return The actual header column
+     */
     String exactCell(String columnName) {
         exactCell(columnName, 0)
     }

src/main/groovy/com/jameskleeh/excel/Row.groovy

@@ -28,6 +28,9 @@ import org.apache.poi.xssf.usermodel.XSSFWorkbook
 
 /**
  * A class used to create a row in an excel document
+ *
+ * @author James Kleeh
+ * @since 0.1.0
  */
 @CompileStatic
 class Row extends CreatesCells {
@@ -49,11 +52,19 @@ class Row extends CreatesCells {
         cell
     }
 
+    /**
+     * @see CreatesCells#skipCells
+     */
     @Override
     void skipCells(int num) {
         cellIdx += num
     }
 
+    /**
+     * Skip to a previously defined column created by {@link CreatesCells#column}
+     *
+     * @param id The column identifier
+     */
     void skipTo(Object id) {
         if (columnIndexes && columnIndexes.containsKey(id)) {
             cellIdx = columnIndexes[id]
@@ -62,6 +73,9 @@ class Row extends CreatesCells {
         }
     }
 
+    /**
+     * @see CreatesCells#merge(Map style, Closure callable)
+     */
     @Override
     void merge(final Map style, @DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = Row) Closure callable) {
         Map existingDefaultOptions = defaultOptions
@@ -86,17 +100,12 @@ class Row extends CreatesCells {
         defaultOptions = existingDefaultOptions
     }
 
+    /**
+     * @see CreatesCells#merge(Closure callable)
+     */
     @Override
     void merge(@DelegatesTo(strategy = Closure.DELEGATE_FIRST, value = Row) Closure callable) {
         merge(null, callable)
     }
 
-    @Override
-    void merge(Object value, Integer count, final Map style = null) {
-        merge(style) {
-            cell(value)
-            skipCells(count)
-        }
-    }
-
 }