001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.commons.dbutils;
018    
019    import java.sql.ResultSet;
020    import java.sql.SQLException;
021    
022    /**
023     * Implementations of this interface convert ResultSets into other objects.
024     *
025     * @param <T> the target type the input ResultSet will be converted to.
026     */
027    public interface ResultSetHandler<T> {
028    
029        /**
030         * Turn the <code>ResultSet</code> into an Object.
031         *
032         * @param rs The <code>ResultSet</code> to handle.  It has not been touched
033         * before being passed to this method.
034         *
035         * @return An Object initialized with <code>ResultSet</code> data. It is
036         * legal for implementations to return <code>null</code> if the
037         * <code>ResultSet</code> contained 0 rows.
038         *
039         * @throws SQLException if a database access error occurs
040         */
041        T handle(ResultSet rs) throws SQLException;
042    
043    }