some javadoc

Author: Nikolai Malygin

src/main/java/com/nmalygin/superb/jdbc/api/Query.java

@@ -32,5 +32,12 @@
  * @author Nikolai Malygin
  */
 public interface Query extends Appendable<Query> {
+    /**
+     *
+     * @param resultSetHandler handler of result set of the query
+     * @return Result of the resultSetHandler work
+     * @param <R> Type of the resultSetHandler result
+     * @throws SQLException SQLException
+     */
     <R> R executeWith(ResultSetHandler<R> resultSetHandler) throws SQLException;
 }

src/main/java/com/nmalygin/superb/jdbc/api/ResultSetHandler.java

@@ -40,7 +40,7 @@ public interface ResultSetHandler<R> {
      *
      * @param resultSet ResultSet
      * @return Some object after processing resultSet
-     * @throws SQLException
+     * @throws SQLException SQLException
      */
     R handle(ResultSet resultSet) throws SQLException;
 }

src/main/java/com/nmalygin/superb/jdbc/api/Transaction.java

@@ -32,10 +32,36 @@
  * @author Nikolai Malygin
  */
 public interface Transaction extends Queries, Changes, Batches, AutoCloseable {
+    /**
+     *
+     * @throws SQLException SQLException
+     */
     void commit() throws SQLException;
+
+    /**
+     *
+     * @param name savepoint name
+     * @throws SQLException SQLException
+     */
     void setSavepoint(String name) throws SQLException;
+
+    /**
+     *
+     * @throws SQLException SQLException
+     */
     void rollback() throws SQLException;
+
+    /**
+     *
+     * @param savepoint savepoint name
+     * @throws SQLException SQLException
+     */
     void rollbackTo(String savepoint) throws SQLException;
+
+    /**
+     *
+     * @throws SQLException SQLException
+     */
     @Override
     void close() throws SQLException;
 }

src/main/java/com/nmalygin/superb/jdbc/api/Transactions.java

@@ -34,15 +34,20 @@
 public interface Transactions {
     /**
      * @return New transaction with default isolation level
-     * @throws SQLException
+     * @throws SQLException SQLException
      */
     Transaction transaction() throws SQLException;
 
     /**
      *
-     * @param isolationLevel
+     * @param isolationLevel the transaction isolation level.
+     * Level one of the following {@code Connection} constants:
+     * {@code Connection.TRANSACTION_READ_UNCOMMITTED},
+     * {@code Connection.TRANSACTION_READ_COMMITTED},
+     * {@code Connection.TRANSACTION_REPEATABLE_READ}, or
+     * {@code Connection.TRANSACTION_SERIALIZABLE}.
      * @return New transaction with the isolationLevel
-     * @throws SQLException
+     * @throws SQLException SQLException
      */
     Transaction transaction(int isolationLevel) throws SQLException;
 }

src/main/java/com/nmalygin/superb/jdbc/api/handlers/ColumnToListRsh.java

@@ -32,14 +32,29 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * ColumnToListRsh
+ *
+ * @author Nikolai Malygin
+ */
 public class ColumnToListRsh<T> implements ResultSetHandler<List<T>> {
 
     private final Column<T> column;
 
+    /**
+     *
+     * @param column typed column
+     */
     public ColumnToListRsh(Column<T> column) {
         this.column = column;
     }
 
+    /**
+     *
+     * @param resultSet ResultSet
+     * @return list values of the column
+     * @throws SQLException SQLException
+     */
     @Override
     public List<T> handle(final ResultSet resultSet) throws SQLException {
         final List<T> list = new ArrayList<>();

src/main/java/com/nmalygin/superb/jdbc/api/handlers/columns/Column.java

@@ -37,7 +37,7 @@ public interface Column<T> {
      *
      * @param resultSet Result set on the specific row
      * @return The value
-     * @throws SQLException
+     * @throws SQLException If cell value do not get from the resultSet
      */
     T cellValue(ResultSet resultSet) throws SQLException;
 }

src/main/java/com/nmalygin/superb/jdbc/api/handlers/columns/StringColumn.java

@@ -27,14 +27,29 @@
 import java.sql.ResultSet;
 import java.sql.SQLException;
 
+/**
+ * StringColumn
+ *
+ * @author Nikolai Malygin
+ */
 public class StringColumn implements Column<String> {
 
     private final String name;
 
+    /**
+     *
+     * @param name column name
+     */
     public StringColumn(String name) {
         this.name = name;
     }
 
+    /**
+     *
+     * @param resultSet Result set on the specific row
+     * @return value of a cell in the row for the column
+     * @throws SQLException SQLException
+     */
     @Override
     public String cellValue(ResultSet resultSet) throws SQLException {
         return resultSet.getString(name);

src/main/java/com/nmalygin/superb/jdbc/real/RealRdbms.java

@@ -30,10 +30,19 @@
 import java.sql.Connection;
 import java.sql.SQLException;
 
+/**
+ * RealRdbms
+ *
+ * @author Nikolai Malygin
+ */
 public final class RealRdbms implements Rdbms {
 
     private final DataSource dataSource;
 
+    /**
+     *
+     * @param dataSource DataSource
+     */
     public RealRdbms(final DataSource dataSource) {
         this.dataSource = dataSource;
     }