Repository: commons-dbutils Updated Branches: refs/heads/master 007dbf733 -> 062a9ed46
Javadoc: Add missing @throws and fix typo. Project: http://git-wip-us.apache.org/repos/asf/commons-dbutils/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-dbutils/commit/062a9ed4 Tree: http://git-wip-us.apache.org/repos/asf/commons-dbutils/tree/062a9ed4 Diff: http://git-wip-us.apache.org/repos/asf/commons-dbutils/diff/062a9ed4 Branch: refs/heads/master Commit: 062a9ed46749de1bb3f3e3842daa992ccda43449 Parents: 007dbf7 Author: ggregory <ggreg...@us-l-gg05.rocketsoftware.com> Authored: Sun Oct 15 20:04:23 2017 -0600 Committer: ggregory <ggreg...@us-l-gg05.rocketsoftware.com> Committed: Sun Oct 15 20:04:23 2017 -0600 ---------------------------------------------------------------------- .../apache/commons/dbutils/ColumnHandler.java | 94 ++++++++++---------- 1 file changed, 48 insertions(+), 46 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-dbutils/blob/062a9ed4/src/main/java/org/apache/commons/dbutils/ColumnHandler.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/dbutils/ColumnHandler.java b/src/main/java/org/apache/commons/dbutils/ColumnHandler.java index c520e60..0187c03 100644 --- a/src/main/java/org/apache/commons/dbutils/ColumnHandler.java +++ b/src/main/java/org/apache/commons/dbutils/ColumnHandler.java @@ -1,46 +1,48 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.dbutils; - -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</code>. - */ -public interface ColumnHandler { - /** - * Test whether this <code>ColumnHandler</code> wants to handle a column targetted for a value type matching - * <code>propType</code>. - * - * @param propType The type of the target parameter. - * @return true is this property handler can/wants to handle this value; false otherwise. - */ - boolean match(Class<?> propType); - - /** - * Do the work required to retrieve and store a column from <code>ResultSet</code> into something of type - * <code>propType</code>. This method is called only if this handler responded <code>true</code> after a - * call to {@link #match(Class)}. - * - * @param rs 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. - * @return The converted value or the original value if something doesn't work out. - */ - Object apply(ResultSet rs, int columnIndex) throws SQLException; -} +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.commons.dbutils; + +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</code>. + */ +public interface ColumnHandler { + /** + * Test whether this <code>ColumnHandler</code> wants to handle a column targeted for a value type matching + * <code>propType</code>. + * + * @param propType The type of the target parameter. + * @return true is this property handler can/wants to handle this value; false otherwise. + */ + boolean match(Class<?> propType); + + /** + * Do the work required to retrieve and store a column from <code>ResultSet</code> into something of type + * <code>propType</code>. This method is called only if this handler responded <code>true</code> after a call to + * {@link #match(Class)}. + * + * @param rs 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. + * @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 + */ + Object apply(ResultSet rs, int columnIndex) throws SQLException; +}