[#4847] Improve Javadoc's of Loader API's various fields() methods
This commit is contained in:
parent
01c370715b
commit
511f9e465c
@ -54,18 +54,21 @@ public interface LoaderCSVStep<R extends Record> {
|
||||
|
||||
/**
|
||||
* Specify the the fields to be loaded into the table in the correct order.
|
||||
* <p>
|
||||
* The CSV column at index <code>i</code> is inserted into the table field
|
||||
* at index <code>i</code>. If <code>fields[i] == null</code>, then the CSV
|
||||
* column is skipped.
|
||||
* at index <code>i</code>. If <code>fields[i] == null</code> or
|
||||
* <code>fields.length <= i</code>, then the CSV column is skipped.
|
||||
*/
|
||||
@Support
|
||||
LoaderCSVOptionsStep<R> fields(Field<?>... fields);
|
||||
|
||||
/**
|
||||
* Specify the the fields to be loaded into the table in the correct order.
|
||||
* <p>
|
||||
* The CSV column at index <code>i</code> is inserted into the table field
|
||||
* at index <code>i</code>. If
|
||||
* <code>new ArrayList(fields).get(i) == null</code>, then the CSV column is
|
||||
* <code>new ArrayList(fields).get(i) == null</code> or
|
||||
* <code>new ArrayList(fields).size() <= i</code>, then the CSV column is
|
||||
* skipped.
|
||||
*/
|
||||
@Support
|
||||
|
||||
@ -55,8 +55,10 @@ public interface LoaderJSONStep<R extends Record> {
|
||||
|
||||
/**
|
||||
* Specify the the fields to be loaded into the table in the correct order.
|
||||
* <p>
|
||||
* The JSON column at index <code>i</code> is inserted into the table field
|
||||
* at index <code>i</code>. If <code>fields[i] == null</code>, then the JSON
|
||||
* at index <code>i</code>. If <code>fields[i] == null</code> or
|
||||
* <code>fields.length <= i</code>, then the JSON
|
||||
* column is skipped.
|
||||
*/
|
||||
@Support
|
||||
@ -64,10 +66,12 @@ public interface LoaderJSONStep<R extends Record> {
|
||||
|
||||
/**
|
||||
* Specify the the fields to be loaded into the table in the correct order.
|
||||
* <p>
|
||||
* The JSON column at index <code>i</code> is inserted into the table field
|
||||
* at index <code>i</code>. If
|
||||
* <code>new ArrayList(fields).get(i) == null</code>, then the JSON column is
|
||||
* skipped.
|
||||
* <code>new ArrayList(fields).get(i) == null</code> or
|
||||
* <code>new ArrayList(fields).size() <= i</code>, then the JSON column
|
||||
* is skipped.
|
||||
*/
|
||||
@Support
|
||||
LoaderJSONOptionsStep<R> fields(Collection<? extends Field<?>> fields);
|
||||
|
||||
@ -54,12 +54,22 @@ public interface LoaderRowsStep<R extends Record> {
|
||||
|
||||
/**
|
||||
* Specify the the fields to be loaded into the table in the correct order.
|
||||
* <p>
|
||||
* The record column at index <code>i</code> is inserted into the table
|
||||
* field at index <code>i</code>. If <code>fields[i] == null</code> or
|
||||
* <code>fields.length <= i</code>, then the record column is skipped.
|
||||
*/
|
||||
@Support
|
||||
LoaderListenerStep<R> fields(Field<?>... fields);
|
||||
|
||||
/**
|
||||
* Specify the the fields to be loaded into the table in the correct order.
|
||||
* <p>
|
||||
* The record column at index <code>i</code> is inserted into the table
|
||||
* field at index <code>i</code>. If
|
||||
* <code>new ArrayList(fields).get(i) == null</code> or
|
||||
* <code>new ArrayList(fields).size() <= i</code>, then the record column
|
||||
* is skipped.
|
||||
*/
|
||||
@Support
|
||||
LoaderListenerStep<R> fields(Collection<? extends Field<?>> fields);
|
||||
|
||||
Loading…
Reference in New Issue
Block a user