001/*
002 * Copyright 2015-2018 Transmogrify LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.pyranid;
018
019import java.sql.ResultSet;
020
021/**
022 * Contract for mapping a {@link ResultSet} row to a different type.
023 * 
024 * @author <a href="http://revetkn.com">Mark Allen</a>
025 * @since 1.0.0
026 */
027public interface ResultSetMapper {
028  /**
029   * Maps the current row of {@code resultSet} into an instance of {@code resultClass}.
030   * 
031   * @param <T>
032   *          result instance type token
033   * @param resultSet
034   *          provides raw row data to pull from
035   * @param resultClass
036   *          the type of instance to map to
037   * @return an instance of the given {@code resultClass}
038   * @throws DatabaseException
039   *           if an error occurs during mapping
040   */
041  <T> T map(ResultSet resultSet, Class<T> resultClass);
042}