1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.dbutils;
18
19 import java.sql.ResultSet;
20 import java.sql.SQLException;
21
22 /**
23 * Implementations of this interface convert ResultSets into other objects.
24 *
25 * @param <T> the target type the input ResultSet will be converted to.
26 */
27 public interface ResultSetHandler<T> {
28
29 /**
30 * Turn the {@code ResultSet} into an Object.
31 *
32 * @param resultSet The {@code ResultSet} to handle. It has not been touched
33 * before being passed to this method.
34 *
35 * @return An Object initialized with {@code ResultSet} data. It is
36 * legal for implementations to return {@code null} if the
37 * {@code ResultSet} contained 0 rows.
38 *
39 * @throws SQLException if a database access error occurs
40 */
41 T handle(ResultSet resultSet) throws SQLException;
42
43 }