Documentation

Author: jeffgbutler

src/main/java/org/mybatis/dynamic/sql/util/mybatis3/CommonCountMapper.java

@@ -19,7 +19,22 @@
 import org.mybatis.dynamic.sql.select.render.SelectStatementProvider;
 import org.mybatis.dynamic.sql.util.SqlProviderAdapter;
 
+/**
+ * This is a general purpose MyBatis mapper for count statements. Count statements are select statements that always
+ * return a long.
+ *
+ * <p>This mapper can be injected as-is into a MyBatis configuration, or it can be extended with existing mappers.
+ *
+ * @author Jeff Butler
+ */
 public interface CommonCountMapper {
+    /**
+     * Execute a select statement that returns a long (typically a select(count(*)) statement). This mapper
+     * assumes the statement returns a single row with a single column that cen be retrieved as a long.
+     *
+     * @param selectStatement the select statement
+     * @return the long value
+     */
     @SelectProvider(type = SqlProviderAdapter.class, method = "select")
     long count(SelectStatementProvider selectStatement);
 }

src/main/java/org/mybatis/dynamic/sql/util/mybatis3/CommonDeleteMapper.java

@@ -19,7 +19,20 @@
 import org.mybatis.dynamic.sql.delete.render.DeleteStatementProvider;
 import org.mybatis.dynamic.sql.util.SqlProviderAdapter;
 
+/**
+ * This is a general purpose MyBatis mapper for delete statements.
+ *
+ * <p>This mapper can be injected as-is into a MyBatis configuration, or it can be extended with existing mappers.
+ *
+ * @author Jeff Butler
+ */
 public interface CommonDeleteMapper {
+    /**
+     * Execute a delete statement.
+     *
+     * @param deleteStatement the delete statement
+     * @return the number of rows affected
+     */
     @DeleteProvider(type = SqlProviderAdapter.class, method = "delete")
     int delete(DeleteStatementProvider deleteStatement);
 }

src/main/java/org/mybatis/dynamic/sql/util/mybatis3/CommonInsertMapper.java

@@ -22,16 +22,46 @@
 import org.mybatis.dynamic.sql.insert.render.MultiRowInsertStatementProvider;
 import org.mybatis.dynamic.sql.util.SqlProviderAdapter;
 
+/**
+ * This is a general purpose mapper for executing various types of insert statement.
+ *
+ * @param <T> the type of record associated with this mapper
+ */
 public interface CommonInsertMapper<T> {
+    /**
+     * Execute an insert statement with input fields mapped to values in a POJO.
+     *
+     * @param insertStatement the insert statement
+     * @return the number of rows affected
+     */
     @InsertProvider(type = SqlProviderAdapter.class, method = "insert")
     int insert(InsertStatementProvider<T> insertStatement);
 
+    /**
+     * Execute an insert statement with input fields supplied directly.
+     *
+     * @param insertStatement the insert statement
+     * @return the number of rows affected
+     */
     @InsertProvider(type = SqlProviderAdapter.class, method = "generalInsert")
     int generalInsert(GeneralInsertStatementProvider insertStatement);
 
+    /**
+     * Execute an insert statement with input fields supplied by a select statement.
+     *
+     * @param insertSelectStatement the insert statement
+     * @return the number of rows affected
+     */
     @InsertProvider(type = SqlProviderAdapter.class, method = "insertSelect")
     int insertSelect(InsertSelectStatementProvider insertSelectStatement);
 
+    /**
+     * Execute an insert statement that inserts multiple rows. The row values are supplied by mapping
+     * to values in a List of POJOs.
+     *
+     * @param insertStatement the insert statement
+     * @return the number of rows affected
+     */
     @InsertProvider(type = SqlProviderAdapter.class, method = "insertMultiple")
     int insertMultiple(MultiRowInsertStatementProvider<T> insertStatement);
 }

src/main/java/org/mybatis/dynamic/sql/util/mybatis3/CommonSelectMapper.java

@@ -27,8 +27,8 @@
 import org.mybatis.dynamic.sql.util.SqlProviderAdapter;
 
 /**
- * This is a general purpose MyBatis mapper. It allows you to execute select statements without having to
- * write a custom {@link org.apache.ibatis.annotations.ResultMap} for each statement.
+ * This is a general purpose MyBatis mapper for select statements. It allows you to execute select statements without
+ * having to write a custom {@link org.apache.ibatis.annotations.ResultMap} for each statement.
  *
  * <p>This mapper contains three types of methods:
  * <ul>

src/main/java/org/mybatis/dynamic/sql/util/mybatis3/CommonUpdateMapper.java

@@ -19,7 +19,20 @@
 import org.mybatis.dynamic.sql.update.render.UpdateStatementProvider;
 import org.mybatis.dynamic.sql.util.SqlProviderAdapter;
 
+/**
+ * This is a general purpose MyBatis mapper for update statements.
+ *
+ * <p>This mapper can be injected as-is into a MyBatis configuration, or it can be extended with existing mappers.
+ *
+ * @author Jeff Butler
+ */
 public interface CommonUpdateMapper {
+    /**
+     * Execute an update statement.
+     *
+     * @param updateStatement the update statement
+     * @return the number of rows affected
+     */
     @UpdateProvider(type = SqlProviderAdapter.class, method = "update")
     int update(UpdateStatementProvider updateStatement);
 }