This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-dbutils.git
The following commit(s) were added to refs/heads/master by this push:
new f133d20 Javadoc
f133d20 is described below
commit f133d20d35a1253991d92bb1fa1f41224fe13994
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:38:46 2026 -0400
Javadoc
---
.../commons/dbutils/AbstractQueryRunner.java | 4 +--
.../commons/dbutils/BaseResultSetHandler.java | 2 +-
.../apache/commons/dbutils/BasicRowProcessor.java | 6 ++--
.../org/apache/commons/dbutils/BeanProcessor.java | 4 +--
.../org/apache/commons/dbutils/OutParameter.java | 6 ++--
.../org/apache/commons/dbutils/RowProcessor.java | 6 ++--
.../dbutils/wrappers/SqlNullCheckedResultSet.java | 42 +++++++++++-----------
.../commons/dbutils/MockResultSetMetaData.java | 2 +-
8 files changed, 36 insertions(+), 36 deletions(-)
diff --git a/src/main/java/org/apache/commons/dbutils/AbstractQueryRunner.java
b/src/main/java/org/apache/commons/dbutils/AbstractQueryRunner.java
index 7628f93..6473fb0 100644
--- a/src/main/java/org/apache/commons/dbutils/AbstractQueryRunner.java
+++ b/src/main/java/org/apache/commons/dbutils/AbstractQueryRunner.java
@@ -451,7 +451,7 @@ public abstract class AbstractQueryRunner {
*
* @param stmt
* PreparedStatement of which to query the metadata of
parameters
- * @return the metadata of parameters
+ * @return The metadata of parameters
* @throws SQLException
* if a database access error occurs
*/
@@ -474,7 +474,7 @@ public abstract class AbstractQueryRunner {
* false, we'll try it, and if it breaks, we'll remember not to use it
* again.
*
- * @return the flag to skip (or not)
+ * @return The flag to skip (or not)
* {@link ParameterMetaData#getParameterType(int)}
* @since 1.4
*/
diff --git a/src/main/java/org/apache/commons/dbutils/BaseResultSetHandler.java
b/src/main/java/org/apache/commons/dbutils/BaseResultSetHandler.java
index dc15bb6..9615540 100644
--- a/src/main/java/org/apache/commons/dbutils/BaseResultSetHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/BaseResultSetHandler.java
@@ -115,7 +115,7 @@ public abstract class BaseResultSetHandler<T> implements
ResultSetHandler<T>, Re
/**
* Gets the underlying result set.
*
- * @return the underlying result set.
+ * @return The underlying result set.
*/
protected final ResultSet getAdaptedResultSet() {
return resultSet;
diff --git a/src/main/java/org/apache/commons/dbutils/BasicRowProcessor.java
b/src/main/java/org/apache/commons/dbutils/BasicRowProcessor.java
index 8dbf29c..147581b 100644
--- a/src/main/java/org/apache/commons/dbutils/BasicRowProcessor.java
+++ b/src/main/java/org/apache/commons/dbutils/BasicRowProcessor.java
@@ -194,7 +194,7 @@ public class BasicRowProcessor implements RowProcessor {
* @see org.apache.commons.dbutils.RowProcessor#toArray(java.sql.ResultSet)
* @param resultSet ResultSet that supplies the array data
* @throws SQLException if a database access error occurs
- * @return the newly created array
+ * @return The newly created array
*/
@Override
public Object[] toArray(final ResultSet resultSet) throws SQLException {
@@ -219,7 +219,7 @@ public class BasicRowProcessor implements RowProcessor {
* @param resultSet ResultSet that supplies the bean data
* @param type Class from which to create the bean instance
* @throws SQLException if a database access error occurs
- * @return the newly created bean
+ * @return The newly created bean
*/
@Override
public <T> T toBean(final ResultSet resultSet, final Class<? extends T>
type) throws SQLException {
@@ -255,7 +255,7 @@ public class BasicRowProcessor implements RowProcessor {
* </p>
*
* @param resultSet ResultSet that supplies the map data
- * @return the newly created Map
+ * @return The newly created Map
* @throws SQLException if a database access error occurs
* @see org.apache.commons.dbutils.RowProcessor#toMap(java.sql.ResultSet)
*/
diff --git a/src/main/java/org/apache/commons/dbutils/BeanProcessor.java
b/src/main/java/org/apache/commons/dbutils/BeanProcessor.java
index a7de7b4..66f42f2 100644
--- a/src/main/java/org/apache/commons/dbutils/BeanProcessor.java
+++ b/src/main/java/org/apache/commons/dbutils/BeanProcessor.java
@@ -461,7 +461,7 @@ public class BeanProcessor {
* @param rs ResultSet that supplies the bean data
* @param type Class from which to create the bean instance
* @throws SQLException if a database access error occurs
- * @return the newly created bean
+ * @return The newly created bean
*/
public <T> T toBean(final ResultSet rs, final Class<? extends T> type)
throws SQLException {
final T bean = this.newInstance(type);
@@ -500,7 +500,7 @@ public class BeanProcessor {
* @param resultSet ResultSet that supplies the bean data
* @param type Class from which to create the bean instance
* @throws SQLException if a database access error occurs
- * @return the newly created List of beans
+ * @return The newly created List of beans
*/
public <T> List<T> toBeanList(final ResultSet resultSet, final Class<?
extends T> type) throws SQLException {
final List<T> results = new ArrayList<>();
diff --git a/src/main/java/org/apache/commons/dbutils/OutParameter.java
b/src/main/java/org/apache/commons/dbutils/OutParameter.java
index 5fa3646..793f16d 100644
--- a/src/main/java/org/apache/commons/dbutils/OutParameter.java
+++ b/src/main/java/org/apache/commons/dbutils/OutParameter.java
@@ -74,7 +74,7 @@ public class OutParameter<T> {
/**
* Gets the Java class for this OUT parameter.
*
- * @return the Java class for this OUT parameter.
+ * @return The Java class for this OUT parameter.
*/
public Class<T> getJavaType() {
return javaType;
@@ -83,7 +83,7 @@ public class OutParameter<T> {
/**
* Gets the JDBC SQL type for this OUT parameter.
*
- * @return the JDBC SQL type for this OUT parameter.
+ * @return The JDBC SQL type for this OUT parameter.
*/
public int getSqlType() {
return sqlType;
@@ -93,7 +93,7 @@ public class OutParameter<T> {
* Gets the value of the OUT parameter. After the stored procedure has
* been executed, the value is the value returned via this parameter.
*
- * @return the value of the OUT parameter.
+ * @return The value of the OUT parameter.
*/
public T getValue() {
return value;
diff --git a/src/main/java/org/apache/commons/dbutils/RowProcessor.java
b/src/main/java/org/apache/commons/dbutils/RowProcessor.java
index c8b65bc..d4426e5 100644
--- a/src/main/java/org/apache/commons/dbutils/RowProcessor.java
+++ b/src/main/java/org/apache/commons/dbutils/RowProcessor.java
@@ -40,7 +40,7 @@ public interface RowProcessor {
*
* @param resultSet ResultSet that supplies the array data
* @throws SQLException if a database access error occurs
- * @return the newly created array
+ * @return The newly created array
*/
Object[] toArray(ResultSet resultSet) throws SQLException;
@@ -54,7 +54,7 @@ public interface RowProcessor {
* @param resultSet ResultSet that supplies the bean data
* @param type Class from which to create the bean instance
* @throws SQLException if a database access error occurs
- * @return the newly created bean
+ * @return The newly created bean
*/
<T> T toBean(ResultSet resultSet, Class<? extends T> type) throws
SQLException;
@@ -81,7 +81,7 @@ public interface RowProcessor {
*
* @param resultSet ResultSet that supplies the map data
* @throws SQLException if a database access error occurs
- * @return the newly created Map
+ * @return The newly created Map
*/
Map<String, Object> toMap(ResultSet resultSet) throws SQLException;
diff --git
a/src/main/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java
b/src/main/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java
index ca943d9..f527249 100644
---
a/src/main/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java
+++
b/src/main/java/org/apache/commons/dbutils/wrappers/SqlNullCheckedResultSet.java
@@ -156,7 +156,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getAsciiStream} method.
*
- * @return the value
+ * @return The value
*/
public InputStream getNullAsciiStream() {
return this.nullAsciiStream;
@@ -166,7 +166,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getBigDecimal} method.
*
- * @return the value
+ * @return The value
*/
public BigDecimal getNullBigDecimal() {
return this.nullBigDecimal;
@@ -176,7 +176,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getBinaryStream} method.
*
- * @return the value
+ * @return The value
*/
public InputStream getNullBinaryStream() {
return this.nullBinaryStream;
@@ -186,7 +186,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getBlob} method.
*
- * @return the value
+ * @return The value
*/
public Blob getNullBlob() {
return this.nullBlob;
@@ -196,7 +196,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getBoolean} method.
*
- * @return the value
+ * @return The value
*/
public boolean getNullBoolean() {
return this.nullBoolean;
@@ -206,7 +206,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getByte} method.
*
- * @return the value
+ * @return The value
*/
public byte getNullByte() {
return this.nullByte;
@@ -216,7 +216,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getBytes} method.
*
- * @return the value
+ * @return The value
*/
public byte[] getNullBytes() {
if (this.nullBytes == null) {
@@ -229,7 +229,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getCharacterStream} method.
*
- * @return the value
+ * @return The value
*/
public Reader getNullCharacterStream() {
return this.nullCharacterStream;
@@ -239,7 +239,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getClob} method.
*
- * @return the value
+ * @return The value
*/
public Clob getNullClob() {
return this.nullClob;
@@ -249,7 +249,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getDate} method.
*
- * @return the value
+ * @return The value
*/
public Date getNullDate() {
return this.nullDate != null ? new Date(this.nullDate.getTime()) :
null;
@@ -259,7 +259,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getDouble} method.
*
- * @return the value
+ * @return The value
*/
public double getNullDouble() {
return this.nullDouble;
@@ -269,7 +269,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getFloat} method.
*
- * @return the value
+ * @return The value
*/
public float getNullFloat() {
return this.nullFloat;
@@ -279,7 +279,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getInt} method.
*
- * @return the value
+ * @return The value
*/
public int getNullInt() {
return this.nullInt;
@@ -289,7 +289,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getLong} method.
*
- * @return the value
+ * @return The value
*/
public long getNullLong() {
return this.nullLong;
@@ -299,7 +299,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getObject} method.
*
- * @return the value
+ * @return The value
*/
public Object getNullObject() {
return this.nullObject;
@@ -309,7 +309,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getRef} method.
*
- * @return the value
+ * @return The value
*/
public Ref getNullRef() {
return this.nullRef;
@@ -319,7 +319,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getShort} method.
*
- * @return the value
+ * @return The value
*/
public short getNullShort() {
return this.nullShort;
@@ -329,7 +329,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getString} method.
*
- * @return the value
+ * @return The value
*/
public String getNullString() {
return this.nullString;
@@ -339,7 +339,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getTime} method.
*
- * @return the value
+ * @return The value
*/
public Time getNullTime() {
return this.nullTime != null ? new Time(this.nullTime.getTime()) :
null;
@@ -349,7 +349,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getTimestamp} method.
*
- * @return the value
+ * @return The value
*/
public Timestamp getNullTimestamp() {
if (this.nullTimestamp == null) {
@@ -365,7 +365,7 @@ public class SqlNullCheckedResultSet implements
InvocationHandler {
* Returns the value when a SQL null is encountered as the result of
* invoking a {@code getURL} method.
*
- * @return the value
+ * @return The value
*/
public URL getNullURL() {
return this.nullURL;
diff --git
a/src/test/java/org/apache/commons/dbutils/MockResultSetMetaData.java
b/src/test/java/org/apache/commons/dbutils/MockResultSetMetaData.java
index e84f036..6c1d389 100644
--- a/src/test/java/org/apache/commons/dbutils/MockResultSetMetaData.java
+++ b/src/test/java/org/apache/commons/dbutils/MockResultSetMetaData.java
@@ -33,7 +33,7 @@ public class MockResultSetMetaData implements
InvocationHandler {
* </pre>
*
* @param columnNames
- * @return the proxy object
+ * @return The proxy object
*/
public static ResultSetMetaData create(final String[] columnNames) {
return ProxyFactory.instance().createResultSetMetaData(new
MockResultSetMetaData(columnNames));
