javadoc fixes

davidmoten · Sep 26, 2017 · ebeb516 · ebeb516
1 parent 4dc8fe6
commit ebeb516
Show file tree

Hide file tree

Showing 12 changed files with 98 additions and 71 deletions.
diff --git a/src/main/java/org/davidmoten/rx/jdbc/Getter.java b/src/main/java/org/davidmoten/rx/jdbc/Getter.java
@@ -133,7 +133,7 @@ default <T1, T2> Flowable<Tuple2<T1, T2>> getAs(@Nonnull Class<T1> cls1, @Nonnul
      * @param cls1
      * @param cls2
      * @param cls3
-     * @return
+     * @return tuple
      */
     default <T1, T2, T3> Flowable<Tuple3<T1, T2, T3>> getAs(@Nonnull Class<T1> cls1, @Nonnull Class<T2> cls2,
             @Nonnull Class<T3> cls3) {
@@ -151,7 +151,7 @@ default <T1, T2, T3> Flowable<Tuple3<T1, T2, T3>> getAs(@Nonnull Class<T1> cls1,
      * @param cls2
      * @param cls3
      * @param cls4
-     * @return
+     * @return tuple
      */
     default <T1, T2, T3, T4> Flowable<Tuple4<T1, T2, T3, T4>> getAs(@Nonnull Class<T1> cls1, @Nonnull Class<T2> cls2,
             @Nonnull Class<T3> cls3, @Nonnull Class<T4> cls4) {
@@ -171,7 +171,7 @@ default <T1, T2, T3, T4> Flowable<Tuple4<T1, T2, T3, T4>> getAs(@Nonnull Class<T
      * @param cls3
      * @param cls4
      * @param cls5
-     * @return
+     * @return tuple
      */
     default <T1, T2, T3, T4, T5> Flowable<Tuple5<T1, T2, T3, T4, T5>> getAs(@Nonnull Class<T1> cls1,
             @Nonnull Class<T2> cls2, @Nonnull Class<T3> cls3, @Nonnull Class<T4> cls4, @Nonnull Class<T5> cls5) {
@@ -193,7 +193,7 @@ default <T1, T2, T3, T4, T5> Flowable<Tuple5<T1, T2, T3, T4, T5>> getAs(@Nonnull
      * @param cls4
      * @param cls5
      * @param cls6
-     * @return
+     * @return tuple
      */
     default <T1, T2, T3, T4, T5, T6> Flowable<Tuple6<T1, T2, T3, T4, T5, T6>> getAs(@Nonnull Class<T1> cls1,
             @Nonnull Class<T2> cls2, @Nonnull Class<T3> cls3, @Nonnull Class<T4> cls4, @Nonnull Class<T5> cls5,
@@ -218,7 +218,7 @@ default <T1, T2, T3, T4, T5, T6> Flowable<Tuple6<T1, T2, T3, T4, T5, T6>> getAs(
      * @param cls5
      * @param cls6
      * @param cls7
-     * @return
+     * @return tuple
      */
     default <T1, T2, T3, T4, T5, T6, T7> Flowable<Tuple7<T1, T2, T3, T4, T5, T6, T7>> getAs(@Nonnull Class<T1> cls1,
             @Nonnull Class<T2> cls2, @Nonnull Class<T3> cls3, @Nonnull Class<T4> cls4, @Nonnull Class<T5> cls5,

diff --git a/src/main/java/org/davidmoten/rx/jdbc/GetterTx.java b/src/main/java/org/davidmoten/rx/jdbc/GetterTx.java
@@ -89,7 +89,7 @@ default <T> Flowable<Tx<T>> autoMap(@Nonnull Class<T> cls) {
      *            class of the TupleN elements
      * @param <T>
      *            generic type of returned stream emissions
-     * @return a stream of TupleN
+     * @return stream of transaction items
      */
     default <T> Flowable<Tx<TupleN<T>>> getTupleN(@Nonnull Class<T> cls) {
         Preconditions.checkNotNull(cls, "cls cannot be null");
@@ -100,7 +100,7 @@ default <T> Flowable<Tx<TupleN<T>>> getTupleN(@Nonnull Class<T> cls) {
      * Automaps all the columns of the {@link ResultSet} into {@link Object} . See
      * {@link #autoMap(Class) autoMap()}.
      *
-     * @return stream of TupleN
+     * @return stream of transaction items
      */
     default Flowable<Tx<TupleN<Object>>> getTupleN() {
         return get(Tuples.tupleN(Object.class));
@@ -118,7 +118,7 @@ default Flowable<Tx<TupleN<Object>>> getTupleN() {
      *            type of first class
      * @param <T2>
      *            type of second class
-     * @return flowable
+     * @return stream of transaction items
      */
     default <T1, T2> Flowable<Tx<Tuple2<T1, T2>>> getAs(@Nonnull Class<T1> cls1, @Nonnull Class<T2> cls2) {
         Preconditions.checkNotNull(cls1, "cls1 cannot be null");
@@ -133,7 +133,7 @@ default <T1, T2> Flowable<Tx<Tuple2<T1, T2>>> getAs(@Nonnull Class<T1> cls1, @No
      * @param cls1
      * @param cls2
      * @param cls3
-     * @return
+     * @return stream of tuples
      */
     default <T1, T2, T3> Flowable<Tx<Tuple3<T1, T2, T3>>> getAs(@Nonnull Class<T1> cls1, @Nonnull Class<T2> cls2,
             @Nonnull Class<T3> cls3) {
@@ -151,7 +151,7 @@ default <T1, T2, T3> Flowable<Tx<Tuple3<T1, T2, T3>>> getAs(@Nonnull Class<T1> c
      * @param cls2
      * @param cls3
      * @param cls4
-     * @return
+     * @return stream of tuples
      */
     default <T1, T2, T3, T4> Flowable<Tx<Tuple4<T1, T2, T3, T4>>> getAs(@Nonnull Class<T1> cls1, @Nonnull Class<T2> cls2,
             @Nonnull Class<T3> cls3, @Nonnull Class<T4> cls4) {
@@ -171,7 +171,7 @@ default <T1, T2, T3, T4> Flowable<Tx<Tuple4<T1, T2, T3, T4>>> getAs(@Nonnull Cla
      * @param cls3
      * @param cls4
      * @param cls5
-     * @return
+     * @return stream of transaction items
      */
     default <T1, T2, T3, T4, T5> Flowable<Tx<Tuple5<T1, T2, T3, T4, T5>>> getAs(@Nonnull Class<T1> cls1,
             @Nonnull Class<T2> cls2, @Nonnull Class<T3> cls3, @Nonnull Class<T4> cls4, @Nonnull Class<T5> cls5) {
@@ -193,7 +193,7 @@ default <T1, T2, T3, T4, T5> Flowable<Tx<Tuple5<T1, T2, T3, T4, T5>>> getAs(@Non
      * @param cls4
      * @param cls5
      * @param cls6
-     * @return
+     * @return stream of transaction items
      */
     default <T1, T2, T3, T4, T5, T6> Flowable<Tx<Tuple6<T1, T2, T3, T4, T5, T6>>> getAs(@Nonnull Class<T1> cls1,
             @Nonnull Class<T2> cls2, @Nonnull Class<T3> cls3, @Nonnull Class<T4> cls4, @Nonnull Class<T5> cls5,
@@ -218,7 +218,7 @@ default <T1, T2, T3, T4, T5, T6> Flowable<Tx<Tuple6<T1, T2, T3, T4, T5, T6>>> ge
      * @param cls5
      * @param cls6
      * @param cls7
-     * @return
+     * @return stream of transaction items
      */
     default <T1, T2, T3, T4, T5, T6, T7> Flowable<Tx<Tuple7<T1, T2, T3, T4, T5, T6, T7>>> getAs(@Nonnull Class<T1> cls1,
             @Nonnull Class<T2> cls2, @Nonnull Class<T3> cls3, @Nonnull Class<T4> cls4, @Nonnull Class<T5> cls5,

diff --git a/src/main/java/org/davidmoten/rx/jdbc/ReturnGeneratedKeysBuilder.java b/src/main/java/org/davidmoten/rx/jdbc/ReturnGeneratedKeysBuilder.java
@@ -15,14 +15,14 @@ public final class ReturnGeneratedKeysBuilder implements Getter {
     /**
      * Transforms the results using the given function.
      *
-     * @param function
+     * @param mapper maps the query result to an object 
      * @return the results of the query as an Observable
      */
     @Override
-    public <T> Flowable<T> get(@Nonnull ResultSetMapper<? extends T> function) {
+    public <T> Flowable<T> get(@Nonnull ResultSetMapper<? extends T> mapper) {
         return update.startWithDependency(
                 Update.<T> createReturnGeneratedKeys(update.connections,
-                        update.parameterGroupsToFlowable(), update.sql, function, true));
+                        update.parameterGroupsToFlowable(), update.sql, mapper, true));
 
     }
 

diff --git a/src/main/java/org/davidmoten/rx/jdbc/TransactedReturnGeneratedKeysBuilder.java b/src/main/java/org/davidmoten/rx/jdbc/TransactedReturnGeneratedKeysBuilder.java
@@ -18,16 +18,16 @@ public final class TransactedReturnGeneratedKeysBuilder {
     /**
      * Transforms the results using the given function.
      *
-     * @param function
+     * @param mapper maps the query results to an object
      * @return the results of the query as an Observable
      */
-    public <T> Flowable<Tx<T>> get(ResultSetMapper<? extends T> function) {
+    public <T> Flowable<Tx<T>> get(ResultSetMapper<? extends T> mapper) {
         return Flowable.defer(() -> {
             AtomicReference<Connection> connection = new AtomicReference<Connection>();
             Flowable<T> o = Update.<T>createReturnGeneratedKeys( //
                     update.updateBuilder.connections //
                             .map(c -> Util.toTransactedConnection(connection, c)),
-                    update.parameterGroupsToFlowable(), update.updateBuilder.sql, function, false);
+                    update.parameterGroupsToFlowable(), update.updateBuilder.sql, mapper, false);
             return o.materialize() //
                     .flatMap(n -> Tx.toTx(n, connection.get(), db)) //
                     .doOnNext(tx -> {

diff --git a/src/main/java/org/davidmoten/rx/jdbc/Util.java b/src/main/java/org/davidmoten/rx/jdbc/Util.java
@@ -360,9 +360,9 @@ public void accept(PreparedStatement ps) throws Exception {
      * Converts from java.sql Types to common java types like java.util.Date and
      * numeric types.
      * 
-     * @param o
-     * @param cls
-     * @return
+     * @param o object to map to new object of type {@code cls}
+     * @param cls object return type
+     * @return object of type {@code cls}
      */
     public static Object autoMap(Object o, Class<?> cls) {
         if (o == null)

diff --git a/src/main/java/org/davidmoten/rx/jdbc/tuple/Tuple2.java b/src/main/java/org/davidmoten/rx/jdbc/tuple/Tuple2.java
@@ -3,8 +3,8 @@
 /**
  * An explicitly typed tuple.
  * 
- * @param <T1>
- * @param <T2>
+ * @param <T1> type of first element
+ * @param <T2> type of second element
  */
 public class Tuple2<T1, T2> {
 
@@ -14,8 +14,8 @@ public class Tuple2<T1, T2> {
     /**
      * Constructor.
      * 
-     * @param value1
-     * @param value2
+     * @param value1 first element
+     * @param value2 second element
      */
     public Tuple2(T1 value1, T2 value2) {
         this.value1 = value1;
@@ -25,45 +25,45 @@ public Tuple2(T1 value1, T2 value2) {
     /**
      * Returns a new instance.
      * 
-     * @param r
-     * @param s
-     * @return
+     * @param r first element
+     * @param s second element
+     * @return tuple
      */
     public static <R, S> Tuple2<R, S> create(R r, S s) {
         return new Tuple2<R, S>(r, s);
     }
 
     /**
-     * Returns the first member of the tuple.
+     * Returns the first element of the tuple.
      * 
-     * @return
+     * @return first element
      */
     public T1 value1() {
         return value1;
     }
 
     /**
-     * Returns the first member of the tuple.
+     * Returns the first element of the tuple.
      * 
-     * @return
+     * @return first element
      */
     public T1 _1() {
         return value1;
     }
 
     /**
-     * Returns the 2nd member of the tuple.
+     * Returns the 2nd element of the tuple.
      * 
-     * @return
+     * @return second element
      */
     public T2 value2() {
         return value2;
     }
 
     /**
-     * Returns the 2nd member of the tuple.
+     * Returns the 2nd element of the tuple.
      * 
-     * @return
+     * @return second element
      */
     public T2 _2() {
         return value2;

diff --git a/src/main/java/org/davidmoten/rx/jdbc/tuple/Tuple3.java b/src/main/java/org/davidmoten/rx/jdbc/tuple/Tuple3.java
@@ -3,9 +3,9 @@
 /**
  * An explicitly typed tuple.
  * 
- * @param <T1>
- * @param <T2>
- * @param <T3>
+ * @param <T1> type of first element
+ * @param <T2> type of second element
+ * @param <T3> type of third element
  */
 public class Tuple3<T1, T2, T3> {
 
@@ -16,9 +16,9 @@ public class Tuple3<T1, T2, T3> {
     /**
      * Constructor.
      * 
-     * @param value1
-     * @param value2
-     * @param value3
+     * @param value1 first element 
+     * @param value2 second element
+     * @param value3 third element
      */
     public Tuple3(T1 value1, T2 value2, T3 value3) {
         this.value1 = value1;

diff --git a/src/main/java/org/davidmoten/rx/jdbc/tuple/Tuple4.java b/src/main/java/org/davidmoten/rx/jdbc/tuple/Tuple4.java
@@ -3,10 +3,10 @@
 /**
  * An explicitly typed tuple.
  * 
- * @param <T1>
- * @param <T2>
- * @param <T3>
- * @param <T4>
+ * @param <T1> type of first element
+ * @param <T2> type of second element
+ * @param <T3> type of third element
+ * @param <T4> type of fourth element
  */
 public class Tuple4<T1, T2, T3, T4> {
 
@@ -18,10 +18,10 @@ public class Tuple4<T1, T2, T3, T4> {
     /**
      * Constructor.
      * 
-     * @param value1
-     * @param value2
-     * @param value3
-     * @param value4
+     * @param value1 first element
+     * @param value2 second element
+     * @param value3 third element
+     * @param value4 fourth element
      */
     public Tuple4(T1 value1, T2 value2, T3 value3, T4 value4) {
         this.value1 = value1;

diff --git a/src/main/java/org/davidmoten/rx/jdbc/tuple/Tuple5.java b/src/main/java/org/davidmoten/rx/jdbc/tuple/Tuple5.java
@@ -3,11 +3,11 @@
 /**
  * An explicitly typed tuple.
  * 
- * @param <T1>
- * @param <T2>
- * @param <T3>
- * @param <T4>
- * @param <T5>
+ * @param <T1> type of first element
+ * @param <T2> type of second element
+ * @param <T3> type of third element
+ * @param <T4> type of fourth element
+ * @param <T5> type of fifth element
  */
 public class Tuple5<T1, T2, T3, T4, T5> {
 
@@ -20,11 +20,11 @@ public class Tuple5<T1, T2, T3, T4, T5> {
     /**
      * Constructor.
      * 
-     * @param value1
-     * @param value2
-     * @param value3
-     * @param value4
-     * @param value5
+     * @param value1 first element
+     * @param value2 second element
+     * @param value3 third element
+     * @param value4 fourth element
+     * @param value5 fifth element
      */
     public Tuple5(T1 value1, T2 value2, T3 value3, T4 value4, T5 value5) {
         this.value1 = value1;

diff --git a/src/main/java/org/davidmoten/rx/jdbc/tuple/Tuple6.java b/src/main/java/org/davidmoten/rx/jdbc/tuple/Tuple6.java
@@ -4,11 +4,17 @@
  * An explicitly typed tuple.
  * 
  * @param <T1>
+ *            type of first element
  * @param <T2>
+ *            type of second element
  * @param <T3>
+ *            type of third element
  * @param <T4>
+ *            type of fourth element
  * @param <T5>
+ *            type of fifth element
  * @param <T6>
+ *            type of sixth element
  */
 public class Tuple6<T1, T2, T3, T4, T5, T6> {
 
@@ -23,11 +29,16 @@ public class Tuple6<T1, T2, T3, T4, T5, T6> {
      * Constructor.
      * 
      * @param value1
+     *            first element
      * @param value2
+     *            second element
      * @param value3
+     *            third element
      * @param value4
+     *            fourth element
      * @param value5
-     * @param value6
+     *            fifth element
+     * @param value6 sixth element
      */
     public Tuple6(T1 value1, T2 value2, T3 value3, T4 value4, T5 value5, T6 value6) {
         this.value1 = value1;
@@ -37,9 +48,9 @@ public Tuple6(T1 value1, T2 value2, T3 value3, T4 value4, T5 value5, T6 value6)
         this.value5 = value5;
         this.value6 = value6;
     }
-    
-    public static <T1, T2, T3, T4, T5, T6> Tuple6<T1, T2, T3, T4, T5, T6> create(T1 value1, T2 value2, T3 value3, T4 value4,
-            T5 value5, T6 value6) {
+
+    public static <T1, T2, T3, T4, T5, T6> Tuple6<T1, T2, T3, T4, T5, T6> create(T1 value1,
+            T2 value2, T3 value3, T4 value4, T5 value5, T6 value6) {
         return new Tuple6<T1, T2, T3, T4, T5, T6>(value1, value2, value3, value4, value5, value6);
     }