[#5122] Improve Javadoc for Loader.loadArrays()

jOOQ · Feb 29, 2016 · ef631e5 · ef631e5
1 parent 2282e09
commit ef631e5
Showing 1 changed file with 31 additions and 0 deletions.
diff --git a/jOOQ/src/main/java/org/jooq/LoaderSourceStep.java b/jOOQ/src/main/java/org/jooq/LoaderSourceStep.java
@@ -65,23 +65,48 @@ public interface LoaderSourceStep<R extends Record> {
 
     /**
      * Load in-memory data.
+     * <p>
+     * Feed a set of array representations of records to the loader API. Each
+     * array's elements are matched with the subsequent
+     * {@link LoaderRowsStep#fields(Field...)} specification, by index. The
+     * values in each array are converted to the matching field's
+     * {@link DataType} via {@link DataType#convert(Object)}. The matching is
+     * similar to that of {@link Record#fromArray(Object[], Field...)}.
      */
     LoaderRowsStep<R> loadArrays(Object[]... arrays);
 
     /**
      * Load in-memory data.
+     * <p>
+     * Like {@link #loadArrays(Object[][])}, providing the possibility of lazy
+     * materialisation of the input arrays.
+     *
+     * @see #loadArrays(Object[][])
+     * @see Record#fromArray(Object[], Field...)
      */
     LoaderRowsStep<R> loadArrays(Iterable<? extends Object[]> arrays);
 
     /**
      * Load in-memory data.
+     * <p>
+     * Like {@link #loadArrays(Object[][])}, providing the possibility of lazy
+     * materialisation of the input arrays.
+     *
+     * @see #loadArrays(Object[][])
+     * @see Record#fromArray(Object[], Field...)
      */
     LoaderRowsStep<R> loadArrays(Iterator<? extends Object[]> arrays);
 
 
 
     /**
      * Load in-memory data.
+     * <p>
+     * Like {@link #loadArrays(Object[][])}, providing the possibility of lazy
+     * materialisation of the input arrays.
+     *
+     * @see #loadArrays(Object[][])
+     * @see Record#fromArray(Object[], Field...)
      */
     LoaderRowsStep<R> loadArrays(Stream<? extends Object[]> arrays);
 
@@ -94,18 +119,24 @@ public interface LoaderSourceStep<R extends Record> {
 
     /**
      * Load in-memory data.
+     *
+     * @see #loadRecords(Record...)
      */
     LoaderRowsStep<R> loadRecords(Iterable<? extends Record> records);
 
     /**
      * Load in-memory data.
+     *
+     * @see #loadRecords(Record...)
      */
     LoaderRowsStep<R> loadRecords(Iterator<? extends Record> records);
 
 
 
     /**
      * Load in-memory data.
+     *
+     * @see #loadRecords(Record...)
      */
     LoaderRowsStep<R> loadRecords(Stream<? extends Record> records);