You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/08/01 22:57:21 UTC
[commons-dbutils] branch master updated (dd62c48 -> 84a056d)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-dbutils.git
from dd62c48 Test no longer needs to run on old Java versions
new d503d35 Normalize naming
new 84a056d Javadoc: Reduce wordiness
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../org/apache/commons/dbutils/ColumnHandler.java | 22 +++++++++-------------
.../apache/commons/dbutils/PropertyHandler.java | 13 +++++--------
.../handlers/columns/BooleanColumnHandler.java | 4 ++--
.../handlers/columns/ByteColumnHandler.java | 4 ++--
.../handlers/columns/DoubleColumnHandler.java | 4 ++--
.../handlers/columns/FloatColumnHandler.java | 4 ++--
.../handlers/columns/IntegerColumnHandler.java | 4 ++--
.../handlers/columns/LongColumnHandler.java | 4 ++--
.../handlers/columns/SQLXMLColumnHandler.java | 4 ++--
.../handlers/columns/ShortColumnHandler.java | 4 ++--
.../handlers/columns/StringColumnHandler.java | 4 ++--
.../handlers/columns/TimestampColumnHandler.java | 4 ++--
12 files changed, 34 insertions(+), 41 deletions(-)
[commons-dbutils] 01/02: Normalize naming
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-dbutils.git
commit d503d353a4743ade050d3dc0d796e0c077c6ba7e
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Aug 1 18:43:34 2023 -0400
Normalize naming
---
.../apache/commons/dbutils/handlers/columns/BooleanColumnHandler.java | 4 ++--
.../apache/commons/dbutils/handlers/columns/ByteColumnHandler.java | 4 ++--
.../apache/commons/dbutils/handlers/columns/DoubleColumnHandler.java | 4 ++--
.../apache/commons/dbutils/handlers/columns/FloatColumnHandler.java | 4 ++--
.../apache/commons/dbutils/handlers/columns/IntegerColumnHandler.java | 4 ++--
.../apache/commons/dbutils/handlers/columns/LongColumnHandler.java | 4 ++--
.../apache/commons/dbutils/handlers/columns/SQLXMLColumnHandler.java | 4 ++--
.../apache/commons/dbutils/handlers/columns/ShortColumnHandler.java | 4 ++--
.../apache/commons/dbutils/handlers/columns/StringColumnHandler.java | 4 ++--
.../commons/dbutils/handlers/columns/TimestampColumnHandler.java | 4 ++--
10 files changed, 20 insertions(+), 20 deletions(-)
diff --git a/src/main/java/org/apache/commons/dbutils/handlers/columns/BooleanColumnHandler.java b/src/main/java/org/apache/commons/dbutils/handlers/columns/BooleanColumnHandler.java
index 7060ae3..3b25bf4 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/columns/BooleanColumnHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/columns/BooleanColumnHandler.java
@@ -24,8 +24,8 @@ import org.apache.commons.dbutils.ColumnHandler;
public class BooleanColumnHandler implements ColumnHandler<Boolean> {
@Override
- public Boolean apply(final ResultSet rs, final int columnIndex) throws SQLException {
- return Boolean.valueOf(rs.getBoolean(columnIndex));
+ public Boolean apply(final ResultSet resultSet, final int columnIndex) throws SQLException {
+ return Boolean.valueOf(resultSet.getBoolean(columnIndex));
}
@Override
diff --git a/src/main/java/org/apache/commons/dbutils/handlers/columns/ByteColumnHandler.java b/src/main/java/org/apache/commons/dbutils/handlers/columns/ByteColumnHandler.java
index 48ec6cc..3d86066 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/columns/ByteColumnHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/columns/ByteColumnHandler.java
@@ -24,8 +24,8 @@ import org.apache.commons.dbutils.ColumnHandler;
public class ByteColumnHandler implements ColumnHandler<Byte> {
@Override
- public Byte apply(final ResultSet rs, final int columnIndex) throws SQLException {
- return Byte.valueOf(rs.getByte(columnIndex));
+ public Byte apply(final ResultSet resultSet, final int columnIndex) throws SQLException {
+ return Byte.valueOf(resultSet.getByte(columnIndex));
}
@Override
diff --git a/src/main/java/org/apache/commons/dbutils/handlers/columns/DoubleColumnHandler.java b/src/main/java/org/apache/commons/dbutils/handlers/columns/DoubleColumnHandler.java
index bf37bdc..5791af7 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/columns/DoubleColumnHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/columns/DoubleColumnHandler.java
@@ -24,8 +24,8 @@ import org.apache.commons.dbutils.ColumnHandler;
public class DoubleColumnHandler implements ColumnHandler<Double> {
@Override
- public Double apply(final ResultSet rs, final int columnIndex) throws SQLException {
- return Double.valueOf(rs.getDouble(columnIndex));
+ public Double apply(final ResultSet resultSet, final int columnIndex) throws SQLException {
+ return Double.valueOf(resultSet.getDouble(columnIndex));
}
@Override
diff --git a/src/main/java/org/apache/commons/dbutils/handlers/columns/FloatColumnHandler.java b/src/main/java/org/apache/commons/dbutils/handlers/columns/FloatColumnHandler.java
index ec65667..89d5903 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/columns/FloatColumnHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/columns/FloatColumnHandler.java
@@ -24,8 +24,8 @@ import org.apache.commons.dbutils.ColumnHandler;
public class FloatColumnHandler implements ColumnHandler<Float> {
@Override
- public Float apply(final ResultSet rs, final int columnIndex) throws SQLException {
- return Float.valueOf(rs.getFloat(columnIndex));
+ public Float apply(final ResultSet resultSet, final int columnIndex) throws SQLException {
+ return Float.valueOf(resultSet.getFloat(columnIndex));
}
@Override
diff --git a/src/main/java/org/apache/commons/dbutils/handlers/columns/IntegerColumnHandler.java b/src/main/java/org/apache/commons/dbutils/handlers/columns/IntegerColumnHandler.java
index d98690b..64635b6 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/columns/IntegerColumnHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/columns/IntegerColumnHandler.java
@@ -24,8 +24,8 @@ import org.apache.commons.dbutils.ColumnHandler;
public class IntegerColumnHandler implements ColumnHandler<Integer> {
@Override
- public Integer apply(final ResultSet rs, final int columnIndex) throws SQLException {
- return Integer.valueOf(rs.getInt(columnIndex));
+ public Integer apply(final ResultSet resultSet, final int columnIndex) throws SQLException {
+ return Integer.valueOf(resultSet.getInt(columnIndex));
}
@Override
diff --git a/src/main/java/org/apache/commons/dbutils/handlers/columns/LongColumnHandler.java b/src/main/java/org/apache/commons/dbutils/handlers/columns/LongColumnHandler.java
index be4d4b0..627980d 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/columns/LongColumnHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/columns/LongColumnHandler.java
@@ -24,8 +24,8 @@ import org.apache.commons.dbutils.ColumnHandler;
public class LongColumnHandler implements ColumnHandler<Long> {
@Override
- public Long apply(final ResultSet rs, final int columnIndex) throws SQLException {
- return Long.valueOf(rs.getLong(columnIndex));
+ public Long apply(final ResultSet resultSet, final int columnIndex) throws SQLException {
+ return Long.valueOf(resultSet.getLong(columnIndex));
}
@Override
diff --git a/src/main/java/org/apache/commons/dbutils/handlers/columns/SQLXMLColumnHandler.java b/src/main/java/org/apache/commons/dbutils/handlers/columns/SQLXMLColumnHandler.java
index 8e1b561..01577bf 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/columns/SQLXMLColumnHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/columns/SQLXMLColumnHandler.java
@@ -25,8 +25,8 @@ import org.apache.commons.dbutils.ColumnHandler;
public class SQLXMLColumnHandler implements ColumnHandler<SQLXML> {
@Override
- public SQLXML apply(final ResultSet rs, final int columnIndex) throws SQLException {
- return rs.getSQLXML(columnIndex);
+ public SQLXML apply(final ResultSet resultSet, final int columnIndex) throws SQLException {
+ return resultSet.getSQLXML(columnIndex);
}
@Override
diff --git a/src/main/java/org/apache/commons/dbutils/handlers/columns/ShortColumnHandler.java b/src/main/java/org/apache/commons/dbutils/handlers/columns/ShortColumnHandler.java
index 729ed4b..4871d3f 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/columns/ShortColumnHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/columns/ShortColumnHandler.java
@@ -24,8 +24,8 @@ import org.apache.commons.dbutils.ColumnHandler;
public class ShortColumnHandler implements ColumnHandler<Short> {
@Override
- public Short apply(final ResultSet rs, final int columnIndex) throws SQLException {
- return Short.valueOf(rs.getShort(columnIndex));
+ public Short apply(final ResultSet resultSet, final int columnIndex) throws SQLException {
+ return Short.valueOf(resultSet.getShort(columnIndex));
}
@Override
diff --git a/src/main/java/org/apache/commons/dbutils/handlers/columns/StringColumnHandler.java b/src/main/java/org/apache/commons/dbutils/handlers/columns/StringColumnHandler.java
index d471dcf..ec780d8 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/columns/StringColumnHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/columns/StringColumnHandler.java
@@ -24,8 +24,8 @@ import org.apache.commons.dbutils.ColumnHandler;
public class StringColumnHandler implements ColumnHandler<String> {
@Override
- public String apply(final ResultSet rs, final int columnIndex) throws SQLException {
- return rs.getString(columnIndex);
+ public String apply(final ResultSet resultSet, final int columnIndex) throws SQLException {
+ return resultSet.getString(columnIndex);
}
@Override
diff --git a/src/main/java/org/apache/commons/dbutils/handlers/columns/TimestampColumnHandler.java b/src/main/java/org/apache/commons/dbutils/handlers/columns/TimestampColumnHandler.java
index ba4fce7..5fc178c 100644
--- a/src/main/java/org/apache/commons/dbutils/handlers/columns/TimestampColumnHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/handlers/columns/TimestampColumnHandler.java
@@ -25,8 +25,8 @@ import org.apache.commons.dbutils.ColumnHandler;
public class TimestampColumnHandler implements ColumnHandler<Timestamp> {
@Override
- public Timestamp apply(final ResultSet rs, final int columnIndex) throws SQLException {
- return rs.getTimestamp(columnIndex);
+ public Timestamp apply(final ResultSet resultSet, final int columnIndex) throws SQLException {
+ return resultSet.getTimestamp(columnIndex);
}
@Override
[commons-dbutils] 02/02: Javadoc: Reduce wordiness
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-dbutils.git
commit 84a056d0b359c4e4464f547bb58cbcc9473f502e
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Aug 1 18:57:10 2023 -0400
Javadoc: Reduce wordiness
---
.../org/apache/commons/dbutils/ColumnHandler.java | 22 +++++++++-------------
.../apache/commons/dbutils/PropertyHandler.java | 13 +++++--------
2 files changed, 14 insertions(+), 21 deletions(-)
diff --git a/src/main/java/org/apache/commons/dbutils/ColumnHandler.java b/src/main/java/org/apache/commons/dbutils/ColumnHandler.java
index 96ead1d..b5eccec 100644
--- a/src/main/java/org/apache/commons/dbutils/ColumnHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/ColumnHandler.java
@@ -20,32 +20,28 @@ import java.sql.ResultSet;
import java.sql.SQLException;
/**
- * Interface to define how implementations can interact with column handling when constructing a bean from a
- * {@link java.sql.ResultSet}. ColumnHandlers do the work of retrieving data correctly from the {@code ResultSet}.
+ * Defines how to process columns when constructing a bean from a {@link ResultSet}. Instances do the work of retrieving data from a {@code ResultSet}.
*
- * @param <T> The return type.
+ * @param <T> The return type.
*/
public interface ColumnHandler<T> {
/**
- * Do the work required to retrieve and store a column from {@code ResultSet} into something of type
- * {@code propType}. This method is called only if this handler responded {@code true} after a call to
- * {@link #match(Class)}.
+ * Retrieves the current row's column value from a {@link ResultSet} and stores it into an instance of {@code propType}. This method is only called if
+ * {@link #match(Class)} returns true.
*
- * @param resultSet The result set to get data from. This should be moved to the correct row already.
- * @param columnIndex The position of the column to retrieve.
+ * @param resultSet The source result set. This must be on the correct row.
+ * @param columnIndex The position of the column to retrieve, a 1-based index.
* @return The converted value or the original value if something doesn't work out.
- * @throws SQLException if the columnIndex is not valid; if a database access error occurs or this method is
- * called on a closed result set
+ * @throws SQLException if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set
*/
T apply(ResultSet resultSet, int columnIndex) throws SQLException;
/**
- * Test whether this {@code ColumnHandler} wants to handle a column targeted for a value type matching
- * {@code propType}.
+ * Tests whether to handle a column targeted for a value type matching {@code propType}.
*
* @param propType The type of the target parameter.
- * @return true is this property handler can/wants to handle this value; false otherwise.
+ * @return true is this property handler handles this {@code propType}; false otherwise.
*/
boolean match(Class<?> propType);
}
diff --git a/src/main/java/org/apache/commons/dbutils/PropertyHandler.java b/src/main/java/org/apache/commons/dbutils/PropertyHandler.java
index 4afb9d2..56e4f58 100644
--- a/src/main/java/org/apache/commons/dbutils/PropertyHandler.java
+++ b/src/main/java/org/apache/commons/dbutils/PropertyHandler.java
@@ -17,27 +17,24 @@
package org.apache.commons.dbutils;
/**
- * Interface to define how implementations can interact with property handling when constructing a bean from a
- * {@link java.sql.ResultSet}. PropertyHandlers do the work of coercing a value into the target type required.
+ * Defines how to handle properties when constructing a bean from a {@link java.sql.ResultSet}. Instances coerce values into a target types.
*/
public interface PropertyHandler {
/**
- * Do the work required to store {@code value} into something of type {@code parameter}. This method is
- * called only if this handler responded {@code true} after a call to {@link #match(Class, Object)}.
+ * Stores the given {@code value} into an instance of type {@code parameter}. This method is only called if {@link #match(Class, Object)} return true.
*
* @param parameter The type of the target parameter.
- * @param value The value to be set.
+ * @param value The value to set.
* @return The converted value or the original value if something doesn't work out.
*/
Object apply(Class<?> parameter, Object value);
/**
- * Test whether this {@code PropertyHandler} wants to handle setting {@code value} into something of type
- * {@code parameter}.
+ * Tests whether to handle setting {@code value} into an instance of {@code parameter}.
*
* @param parameter The type of the target parameter.
- * @param value The value to be set.
+ * @param value The value to be set.
* @return true is this property handler can/wants to handle this value; false otherwise.
*/
boolean match(Class<?> parameter, Object value);