From a5be41c6a72c17f8a4ddf86ee4dace92d1a294da Mon Sep 17 00:00:00 2001 From: Looly Date: Wed, 16 Dec 2020 00:15:52 +0800 Subject: [PATCH] fix doc --- .../main/java/cn/hutool/db/DialectRunner.java | 22 +++++++++++++------ .../main/java/cn/hutool/db/SqlConnRunner.java | 17 +++++++------- .../src/main/java/cn/hutool/dfa/WordTree.java | 1 + .../java/cn/hutool/extra/ssh/GanymedUtil.java | 2 ++ .../java/cn/hutool/poi/ofd/OfdWriter.java | 5 +++-- 5 files changed, 30 insertions(+), 17 deletions(-) diff --git a/hutool-db/src/main/java/cn/hutool/db/DialectRunner.java b/hutool-db/src/main/java/cn/hutool/db/DialectRunner.java index 4bbe15a51..39839667e 100644 --- a/hutool-db/src/main/java/cn/hutool/db/DialectRunner.java +++ b/hutool-db/src/main/java/cn/hutool/db/DialectRunner.java @@ -19,6 +19,12 @@ import java.sql.Connection; import java.sql.PreparedStatement; import java.sql.SQLException; +/** + * 提供基于方言的原始增删改查执行封装 + * + * @author looly + * @since 5.5.3 + */ public class DialectRunner implements Serializable { private static final long serialVersionUID = 1L; @@ -47,6 +53,7 @@ public class DialectRunner implements Serializable { } //---------------------------------------------------------------------------- CRUD start + /** * 批量插入数据
* 批量插入必须严格保持Entity的结构一致，不一致会导致插入数据出现不可预知的结果
@@ -65,7 +72,7 @@ public class DialectRunner implements Serializable { PreparedStatement ps = null; try { - if(1 == records.length){ + if (1 == records.length) { //单条单独处理 ps = dialect.psForInsert(conn, records[0]); return new int[]{ps.executeUpdate()}; @@ -83,8 +90,9 @@ public class DialectRunner implements Serializable { * 插入数据
* 此方法不会关闭Connection * - * @param conn 数据库连接 - * @param record 记录 + * @param 主键类型，可能为数字或对象列表 + * @param conn 数据库连接 + * @param record 记录 * @param generatedKeysHandler 自增主键处理器，用于定义返回自增主键的范围和类型 * @return 主键列表 * @throws SQLException SQL执行异常 @@ -99,7 +107,7 @@ public class DialectRunner implements Serializable { try { ps = dialect.psForInsert(conn, record); ps.executeUpdate(); - if(null == generatedKeysHandler){ + if (null == generatedKeysHandler) { return null; } return StatementUtil.getGeneratedKeys(ps, generatedKeysHandler); @@ -204,10 +212,10 @@ public class DialectRunner implements Serializable { * 分页查询
* 此方法不会关闭Connection * - * @param 结果对象类型 - * @param conn 数据库连接对象 + * @param 结果对象类型 + * @param conn 数据库连接对象 * @param query 查询条件（包含表名） - * @param rsh 结果集处理对象 + * @param rsh 结果集处理对象 * @return 结果对象 * @throws SQLException SQL执行异常 */ diff --git a/hutool-db/src/main/java/cn/hutool/db/SqlConnRunner.java b/hutool-db/src/main/java/cn/hutool/db/SqlConnRunner.java index 067b36665..3449e024d 100644 --- a/hutool-db/src/main/java/cn/hutool/db/SqlConnRunner.java +++ b/hutool-db/src/main/java/cn/hutool/db/SqlConnRunner.java @@ -153,7 +153,7 @@ public class SqlConnRunner extends DialectRunner { * @throws SQLException SQL执行异常 */ public Long insertForGeneratedKey(Connection conn, Entity record) throws SQLException { - return insert(conn, record, (rs)->{ + return insert(conn, record, (rs) -> { Long generatedKey = null; if (rs != null && rs.next()) { try { @@ -281,7 +281,7 @@ public class SqlConnRunner extends DialectRunner { /** * 获取查询结果总数，生成类似于 SELECT count(1) from (sql) * - * @param conn 数据库连接对象 + * @param conn 数据库连接对象 * @param selectSql 查询语句 * @return 结果数 * @throws SQLException SQL异常 @@ -322,7 +322,7 @@ public class SqlConnRunner extends DialectRunner { */ public PageResult page(Connection conn, SqlBuilder sqlBuilder, Page page) throws SQLException { final PageResultHandler pageResultHandler = new PageResultHandler( - new PageResult<>(page.getPageNumber(), page.getPageSize(), (int)count(conn, sqlBuilder.build())), + new PageResult<>(page.getPageNumber(), page.getPageSize(), (int) count(conn, sqlBuilder.build())), this.caseInsensitive); return page(conn, sqlBuilder, page, pageResultHandler); } @@ -370,7 +370,7 @@ public class SqlConnRunner extends DialectRunner { */ public PageResult page(Connection conn, Collection fields, Entity where, Page page) throws SQLException { final PageResultHandler pageResultHandler = new PageResultHandler( - new PageResult<>(page.getPageNumber(), page.getPageSize(), (int)count(conn, where)), + new PageResult<>(page.getPageNumber(), page.getPageSize(), (int) count(conn, where)), this.caseInsensitive); return page(conn, fields, where, page, pageResultHandler); } @@ -379,10 +379,11 @@ public class SqlConnRunner extends DialectRunner { * 分页查询
* 此方法不会关闭Connection * - * @param conn 数据库连接对象 - * @param fields 返回的字段列表，null则返回所有字段 - * @param where 条件实体类（包含表名） - * @param page 分页对象 + * @param 结果类型，取决于 {@link RsHandler} 的处理逻辑 + * @param conn 数据库连接对象 + * @param fields 返回的字段列表，null则返回所有字段 + * @param where 条件实体类（包含表名） + * @param page 分页对象 * @param handler 结果集处理器 * @return 结果对象 * @throws SQLException SQL执行异常 diff --git a/hutool-dfa/src/main/java/cn/hutool/dfa/WordTree.java b/hutool-dfa/src/main/java/cn/hutool/dfa/WordTree.java index 13e84f589..1f3d75e36 100644 --- a/hutool-dfa/src/main/java/cn/hutool/dfa/WordTree.java +++ b/hutool-dfa/src/main/java/cn/hutool/dfa/WordTree.java @@ -98,6 +98,7 @@ public class WordTree extends HashMap { * 添加单词，使用默认类型 * * @param word 单词 + * @return this */ public WordTree addWord(String word) { final Filter charFilter = this.charFilter; diff --git a/hutool-extra/src/main/java/cn/hutool/extra/ssh/GanymedUtil.java b/hutool-extra/src/main/java/cn/hutool/extra/ssh/GanymedUtil.java index 33ea88ed1..a56d9ce4e 100644 --- a/hutool-extra/src/main/java/cn/hutool/extra/ssh/GanymedUtil.java +++ b/hutool-extra/src/main/java/cn/hutool/extra/ssh/GanymedUtil.java @@ -70,6 +70,7 @@ public class GanymedUtil { * @param cmd 命令 * @param charset 发送和读取内容的编码 * @param errStream 错误信息输出到的位置 + * @return 执行返回结果 */ public static String exec(Session session, String cmd, Charset charset, OutputStream errStream) { final String result; @@ -97,6 +98,7 @@ public class GanymedUtil { * @param cmd 命令 * @param charset 发送和读取内容的编码 * @param errStream 错误信息输出到的位置 + * @return 执行返回结果 */ public static String execByShell(Session session, String cmd, Charset charset, OutputStream errStream) { final String result; diff --git a/hutool-poi/src/main/java/cn/hutool/poi/ofd/OfdWriter.java b/hutool-poi/src/main/java/cn/hutool/poi/ofd/OfdWriter.java index 763a2ab11..eb021572d 100644 --- a/hutool-poi/src/main/java/cn/hutool/poi/ofd/OfdWriter.java +++ b/hutool-poi/src/main/java/cn/hutool/poi/ofd/OfdWriter.java @@ -113,7 +113,7 @@ public class OfdWriter implements Serializable, Closeable { } /** - * 增加节点， + * 增加节点 * * @param div 节点，可以是段落、Canvas、Img或者填充 * @return this @@ -124,8 +124,9 @@ public class OfdWriter implements Serializable, Closeable { } /** - * 增加节点， + * 增加注释，比如水印等 * + * @param page 页码 * @param annotation 节点，可以是段落、Canvas、Img或者填充 * @return this */