/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2011, Red Hat Inc. or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Red Hat Inc.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.hibernate.engine.jdbc.spi;

import java.sql.ResultSet;

import org.hibernate.engine.jdbc.ColumnNameCache;

Contract for wrapping a ResultSet in a "column name cache" wrapper. 
Author:
Gail Badner/**
 * Contract for wrapping a {@link ResultSet} in a "column name cache" wrapper.
 *
 * @author Gail Badner
 */
public interface ResultSetWrapper {
	
Wrap a result set in a "column name cache" wrapper.
Params:
resultSet – The result set to wrap
columnNameCache – The column name cache.
Returns:
The wrapped result set./**
	 * Wrap a result set in a "column name cache" wrapper.
	 *
	 * @param resultSet The result set to wrap
	 * @param columnNameCache The column name cache.
	 *
	 * @return The wrapped result set.
	 */
	public ResultSet wrap(ResultSet resultSet, ColumnNameCache columnNameCache);
}