org.hibernate.type.descriptor.WrapperOptions Maven / Gradle / Ivy
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2010, 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.type.descriptor;
import org.hibernate.engine.jdbc.LobCreator;
import org.hibernate.type.descriptor.sql.SqlTypeDescriptor;
/**
* Gives binding (nullSafeSet) and extracting (nullSafeGet) code access to options.
*
* @todo Definitely could use a better name
*
* @author Steve Ebersole
*/
public interface WrapperOptions {
/**
* Should streams be used for binding LOB values.
*
* @return {@code true}/{@code false}
*/
public boolean useStreamForLobBinding();
/**
* Obtain access to the {@link LobCreator}
*
* @return The LOB creator
*/
public LobCreator getLobCreator();
/**
* Allow remapping of descriptors for dealing with sql type.
*
* @param sqlTypeDescriptor The known descriptor
*
* @return The remapped descriptor. May be the same as the known descriptor indicating no remapping.
*/
public SqlTypeDescriptor remapSqlTypeDescriptor(SqlTypeDescriptor sqlTypeDescriptor);
}