/*
* Licensed 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.skife.jdbi.v2.tweak;
import org.skife.jdbi.v2.StatementContext;
import java.sql.ResultSet;
import java.sql.SQLException;
Used with a Query.map(ResultSetMapper)
call to specify what to do with each row of a result set /**
* Used with a {@link org.skife.jdbi.v2.Query#map(ResultSetMapper)} call to specify
* what to do with each row of a result set
*/
public interface ResultSetMapper<T>
{
Map the row the result set is at when passed in. This method should not cause the result
set to advance, allow jDBI to do that, please.
Params: - index – which row of the result set we are at, starts at 0
- r – the result set being iterated
- ctx –
Throws: - SQLException – if anything goes wrong go ahead and let this percolate, jDBI will handle it
Returns: the value to return for this row
/**
* Map the row the result set is at when passed in. This method should not cause the result
* set to advance, allow jDBI to do that, please.
*
* @param index which row of the result set we are at, starts at 0
* @param r the result set being iterated
* @param ctx
* @return the value to return for this row
* @throws SQLException if anything goes wrong go ahead and let this percolate, jDBI will handle it
*/
T map(int index, ResultSet r, StatementContext ctx) throws SQLException;
}