Package org.hibernate.usertype

Class BaseUserTypeSupport<T>

java.lang.Object

org.hibernate.usertype.BaseUserTypeSupport<T>

All Implemented Interfaces:

UserType<T>

Direct Known Subclasses:

UserTypeLegacyBridge, UserTypeSupport

public abstract class BaseUserTypeSupport<T>
extends Object
implements UserType<T>

Constructor Summary

Constructors

Constructor	Description
BaseUserTypeSupport()

Method Summary

Modifier and Type	Method	Description
T	assemble(Serializable cached, Object owner)	Reconstruct an object from the cacheable representation.
T	deepCopy(T value)	Return a deep copy of the persistent state, stopping at entities and at collections.
Serializable	disassemble(T value)	Transform the object into its cacheable representation.
boolean	equals(T x, T y)	Compare two instances of the class mapped by this type for persistence "equality".
int	getSqlType()	Return the SQL type code for the column mapped by this type.
int	hashCode(T x)	Get a hashcode for the instance, consistent with persistence "equality"
boolean	isMutable()	Are objects of this type mutable?
protected BasicJavaType<T>	javaType()
protected JdbcType	jdbcType()
T	nullSafeGet(ResultSet rs, int position, SharedSessionContractImplementor session, Object owner)	Retrieve an instance of the mapped class from a JDBC resultset.
void	nullSafeSet(PreparedStatement st, T value, int index, SharedSessionContractImplementor session)	Write an instance of the mapped class to a prepared statement.
T	replace(T original, T target, Object owner)	During merge, replace the existing (target) value in the entity we are merging to with a new (original) value from the detached entity we are merging.
protected abstract void	resolve(BiConsumer<BasicJavaType<T>,JdbcType> resolutionConsumer)
Class<T>	returnedClass()	The class returned by nullSafeGet().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.usertype.UserType

getDefaultSqlLength, getDefaultSqlPrecision, getDefaultSqlScale, getJdbcType, getValueConverter

Constructor Detail

BaseUserTypeSupport

public BaseUserTypeSupport()

Method Detail

resolve

protected abstract void resolve(BiConsumer<BasicJavaType<T>,JdbcType> resolutionConsumer)

jdbcType

protected JdbcType jdbcType()

javaType

protected BasicJavaType<T> javaType()

getSqlType

public int getSqlType()

Description copied from interface: UserType

Return the SQL type code for the column mapped by this type. The codes are generally defined on org.hibernate.type.SqlTypes, but could be database-specific codes

Specified by:

getSqlType in interface UserType<T>

See Also:

SqlTypes

returnedClass

public Class<T> returnedClass()

Description copied from interface: UserType

The class returned by nullSafeGet().

Specified by:

returnedClass in interface UserType<T>

Returns:

Class

equals

public boolean equals(T x,
                      T y)
               throws HibernateException

Description copied from interface: UserType

Compare two instances of the class mapped by this type for persistence "equality". Equality of the persistent state.

Specified by:

equals in interface UserType<T>

Throws:

HibernateException

hashCode

public int hashCode(T x)
             throws HibernateException

Description copied from interface: UserType

Get a hashcode for the instance, consistent with persistence "equality"

Specified by:

hashCode in interface UserType<T>

Throws:

HibernateException

nullSafeGet

public T nullSafeGet(ResultSet rs,
                     int position,
                     SharedSessionContractImplementor session,
                     Object owner)
              throws SQLException

Description copied from interface: UserType

Retrieve an instance of the mapped class from a JDBC resultset. Implementors should handle possibility of null values.

Specified by:

nullSafeGet in interface UserType<T>

Throws:

SQLException

nullSafeSet

public void nullSafeSet(PreparedStatement st,
                        T value,
                        int index,
                        SharedSessionContractImplementor session)
                 throws SQLException

Description copied from interface: UserType

Write an instance of the mapped class to a prepared statement. Implementors should handle possibility of null values. A multi-column type should be written to parameters starting from index.

Specified by:

nullSafeSet in interface UserType<T>

Throws:

SQLException

deepCopy

public T deepCopy(T value)
           throws HibernateException

Description copied from interface: UserType

Return a deep copy of the persistent state, stopping at entities and at collections. It is not necessary to copy immutable objects, or null values, in which case it is safe to simply return the argument.

Specified by:

deepCopy in interface UserType<T>

Parameters:

value - the object to be cloned, which may be null

Returns:

Object a copy

Throws:

HibernateException

isMutable

public boolean isMutable()

Description copied from interface: UserType

Are objects of this type mutable?

Specified by:

isMutable in interface UserType<T>

Returns:

boolean

disassemble

public Serializable disassemble(T value)
                         throws HibernateException

Description copied from interface: UserType

Transform the object into its cacheable representation. At the very least this method should perform a deep copy if the type is mutable. That may not be enough for some implementations, however; for example, associations must be cached as identifier values. (optional operation)

Specified by:

disassemble in interface UserType<T>

Parameters:

value - the object to be cached

Returns:

a cacheable representation of the object

Throws:

HibernateException

assemble

public T assemble(Serializable cached,
                  Object owner)
           throws HibernateException

Description copied from interface: UserType

Reconstruct an object from the cacheable representation. At the very least this method should perform a deep copy if the type is mutable. (optional operation)

Specified by:

assemble in interface UserType<T>

Parameters:

cached - the object to be cached

owner - the owner of the cached object

Returns:

a reconstructed object from the cacheable representation

Throws:

HibernateException

replace

public T replace(T original,
                 T target,
                 Object owner)
          throws HibernateException

Description copied from interface: UserType

During merge, replace the existing (target) value in the entity we are merging to with a new (original) value from the detached entity we are merging. For immutable objects, or null values, it is safe to simply return the first parameter. For mutable objects, it is safe to return a copy of the first parameter. For objects with component values, it might make sense to recursively replace component values.

Specified by:

replace in interface UserType<T>

Parameters:

original - the value from the detached entity being merged

target - the value in the managed entity

Returns:

the value to be merged

Throws:

HibernateException