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 public interface ResultSetHandler {
26
27 /***
28 * Turn the <code>ResultSet</code> into an Object.
29 *
30 * @param rs The <code>ResultSet</code> to handle. It has not been touched
31 * before being passed to this method.
32 *
33 * @return An Object initialized with <code>ResultSet</code> data. It is
34 * legal for implementations to return <code>null</code> if the
35 * <code>ResultSet</code> contained 0 rows.
36 *
37 * @throws SQLException if a database access error occurs
38 */
39 public Object handle(ResultSet rs) throws SQLException;
40
41 }