Package org.hibernate.type.descriptor

Interface WrapperOptions

All Known Subinterfaces:

EventSource, SessionImplementor, SharedSessionContractImplementor

All Known Implementing Classes:

AbstractDelegateSessionImplementor, AbstractSharedSessionContract, SessionDelegatorBaseImpl, SessionImpl, SharedSessionDelegatorBaseImpl, StatelessSessionImpl, ToOneDelegateSessionImplementor

public interface WrapperOptions

Options for binding values to and extracting values from JDBC prepared statements and result sets.

See Also:

• ValueBinder
• ValueExtractor

Method Summary

Modifier and Type	Method	Description
default Dialect	getDialect()	Access to the current dialect.
default TimeZone	getJdbcTimeZone()	The JDBC TimeZone used when writing a value of type Time or Timestamp to a JDBC PreparedStatement, or when reading from a JDBC ResultSet.
FormatMapper	getJsonFormatMapper()	Obtain the JSON FormatMapper.
default LobCreator	getLobCreator()	Obtain access to the LobCreator.
default int	getPreferredSqlTypeCodeForBoolean()	The JDBC type code used to bind a null boolean value.
SharedSessionContractImplementor	getSession()	Access to the current session.
default SessionFactoryImplementor	getSessionFactory()	Access to the current session factory.
default TypeConfiguration	getTypeConfiguration()	Obtain the TypeConfiguration.
FormatMapper	getXmlFormatMapper()	Obtain the XML FormatMapper.
default boolean	useStreamForLobBinding()	Determines whether streams should be used for binding LOB values.

Method Details

getSession

SharedSessionContractImplementor getSession()

Access to the current session.

getSessionFactory

default SessionFactoryImplementor getSessionFactory()

Access to the current session factory.

getDialect

default Dialect getDialect()

Access to the current dialect.

useStreamForLobBinding

default boolean useStreamForLobBinding()

Determines whether streams should be used for binding LOB values.

Returns:

true/false

See Also:

• Dialect.useInputStreamToInsertBlob()

getPreferredSqlTypeCodeForBoolean

default int getPreferredSqlTypeCodeForBoolean()

The JDBC type code used to bind a null boolean value.

See Also:

• MappingSettings.PREFERRED_BOOLEAN_JDBC_TYPE
• Dialect.getPreferredSqlTypeCodeForBoolean()

getLobCreator

default LobCreator getLobCreator()

Obtain access to the LobCreator.

Returns:

The LOB creator

See Also:

• JdbcSettings.NON_CONTEXTUAL_LOB_CREATION
• Dialect.getDefaultNonContextualLobCreation()

getJdbcTimeZone

default TimeZone getJdbcTimeZone()

The JDBC TimeZone used when writing a value of type Time or Timestamp to a JDBC PreparedStatement, or when reading from a JDBC ResultSet.

• When getJdbcTimeZone() is null, the method PreparedStatement.setTimestamp(int, java.sql.Timestamp) is called to write a timestamp, and ResultSet.getTimestamp(int) is called to read a timestamp.
• But when not null, the method PreparedStatement.setTimestamp(int, java.sql.Timestamp, java.util.Calendar) is called to write a timestamp, and ResultSet.getTimestamp(int, java.util.Calendar) is called to read a timestamp.

Thus, the storage TimeZone can differ from the default JVM TimeZone given by TimeZone.getDefault().

Returns:

the JDBC TimeZone, or null if no JDBC timezone was explicitly set

See Also:

• JdbcSettings.JDBC_TIME_ZONE

getTypeConfiguration

default TypeConfiguration getTypeConfiguration()

Obtain the TypeConfiguration.

Since:

7.0

getXmlFormatMapper

FormatMapper getXmlFormatMapper()

Obtain the XML FormatMapper.

Since:

7.0

getJsonFormatMapper

FormatMapper getJsonFormatMapper()

Obtain the JSON FormatMapper.

Since:

7.0