SerializableType

Class Overview

A type that maps between a VARBINARY and Serializable classes.

Notice specifically the 2 forms:

• INSTANCE indicates a mapping using the Serializable interface itself.
• SerializableType(Class) indicates a mapping using the specific class

The important distinction has to do with locating the appropriate ClassLoader to use during deserialization. In the fist form we are always using the ClassLoader of the JVM (Hibernate will always fallback to trying its classloader as well). The second form is better at targeting the needed ClassLoader actually needed.

Summary

Fields
public static final SerializableType<Serializable>	INSTANCE

Public Constructors
	SerializableType(Class<T> serializableClass)

Public Methods
String	getName()

[Expand] Inherited Methods
From class org.hibernate.type.AbstractSingleColumnStandardBasicType Object get(ResultSet rs, String name) This method is deprecated. Use get(ResultSet, String, SessionImplementor) instead. T nullSafeGet(ResultSet rs, String name) This method is deprecated. Use nullSafeGet(ResultSet, String, SessionImplementor) instead final void nullSafeSet(PreparedStatement st, Object value, int index, boolean[] settable, SessionImplementor session) Write an instance of the mapped class to a prepared statement, ignoring some columns. void nullSafeSet(PreparedStatement st, T value, int index) This method is deprecated. Use nullSafeSet(PreparedStatement, Object, int, SessionImplementor) instead. void set(PreparedStatement st, T value, int index) This method is deprecated. Use set(PreparedStatement, Object, int, SessionImplementor) instead. final int sqlType()
From class org.hibernate.type.AbstractStandardBasicType final Object assemble(Serializable cached, SessionImplementor session, Object owner) Reconstruct the object from its cached "disassembled" state. final void beforeAssemble(Serializable cached, SessionImplementor session) Called before assembling a query result set from the query cache, to allow batch fetching of entities missing from the second-level cache. final int compare(Object x, Object y, EntityMode entityMode) Perform a Comparator style comparison between values final Object deepCopy(Object value, EntityMode entityMode, SessionFactoryImplementor factory) Return a deep copy of the persistent state, stopping at entities and at collections. final T deepCopy(T value) final Serializable disassemble(Object value, SessionImplementor session, Object owner) Return a cacheable "disassembled" representation of the object. T fromString(String string) T fromStringValue(String xml) Consume the given string representation back into this types java form. final Object fromXMLNode(Node xml, Mapping factory) Parse the XML representation of an instance. T fromXMLString(String xml, Mapping factory) Object get(ResultSet rs, String name, SessionImplementor session) final int getColumnSpan(Mapping mapping) How many columns are used to persist this type. final int getHashCode(Object x, EntityMode entityMode) Get a hash code, consistent with persistence "equality". final int getHashCode(Object x) final int getHashCode(Object x, EntityMode entityMode, SessionFactoryImplementor factory) Get a hash code, consistent with persistence "equality". final JavaTypeDescriptor<T> getJavaTypeDescriptor() MutabilityPlan<T> getMutabilityPlan() String[] getRegistrationKeys() Get the names under which this type should be registered in the type registry. T getReplacement(T original, T target) final Class getReturnedClass() The class returned by nullSafeGet(ResultSet, String, SessionImplementor, Object) methods. final Type getSemiResolvedType(SessionFactoryImplementor factory) Get the type of a semi-resolved value. final SqlTypeDescriptor getSqlTypeDescriptor() final Object hydrate(ResultSet rs, String[] names, SessionImplementor session, Object owner) Retrieve an instance of the mapped class, or the identifier of an entity or collection, from a JDBC resultset. final boolean isAnyType() Return true if the implementation is castable to AnyType. final boolean isAssociationType() Return true if the implementation is castable to AssociationType. final boolean isCollectionType() Return true if the implementation is castable to CollectionType. final boolean isComponentType() Return true if the implementation is castable to CompositeType. final boolean isDirty(Object old, Object current, boolean[] checkable, SessionImplementor session) Should the parent be considered dirty, given both the old and current value? final boolean isDirty(Object old, Object current) final boolean isDirty(Object old, Object current, SessionImplementor session) Should the parent be considered dirty, given both the old and current value? final boolean isEntityType() Return true if the implementation is castable to EntityType. final boolean isEqual(Object x, Object y, EntityMode entityMode) Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state). final boolean isEqual(Object x, Object y, EntityMode entityMode, SessionFactoryImplementor factory) Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state). final boolean isEqual(T one, T another) final boolean isModified(Object oldHydratedState, Object currentState, boolean[] checkable, SessionImplementor session) Has the value been modified compared to the current database state? The difference between this and the isDirty(Object, Object, boolean[], SessionImplementor) methods is that here we need to account for "partially" built values. final boolean isMutable() Are objects of this type mutable. final boolean isSame(Object x, Object y) final boolean isSame(Object x, Object y, EntityMode entityMode) Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state) taking a shortcut for entity references. final boolean isXMLElement() final T nullSafeGet(ResultSet rs, String name, WrapperOptions options) final Object nullSafeGet(ResultSet rs, String[] names, SessionImplementor session, Object owner) Retrieve an instance of the mapped class from a JDBC resultset. final Object nullSafeGet(ResultSet rs, String name, SessionImplementor session, Object owner) Retrieve an instance of the mapped class from a JDBC resultset. final T nullSafeGet(ResultSet rs, String name, SessionImplementor session) final void nullSafeSet(PreparedStatement st, Object value, int index, WrapperOptions options) final void nullSafeSet(PreparedStatement st, Object value, int index, SessionImplementor session) Write an instance of the mapped class to a prepared statement. boolean registerUnderJavaType() final Object replace(Object original, Object target, SessionImplementor session, Object owner, Map copyCache) 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. Object replace(Object original, Object target, SessionImplementor session, Object owner, Map copyCache, ForeignKeyDirection foreignKeyDirection) 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. final Object resolve(Object value, SessionImplementor session, Object owner) Map identifiers to entities or collections. final Object semiResolve(Object value, SessionImplementor session, Object owner) Given a hydrated, but unresolved value, return a value that may be used to reconstruct property-ref associations. void set(PreparedStatement st, T value, int index, SessionImplementor session) final void setToXMLNode(Node node, Object value, SessionFactoryImplementor factory) A representation of the value to be embedded in an XML element. final int[] sqlTypes(Mapping mapping) Return the JDBC types codes (per java.sql.Types) for the columns mapped by this type. boolean[] toColumnNullness(Object value, Mapping mapping) Given an instance of the type, return an array of boolean, indicating which mapped columns would be null. final String toLoggableString(Object value, SessionFactoryImplementor factory) A representation of the value to be embedded in a log file. String toString(T value) Render the value to the string representation. String toXMLString(T value, SessionFactoryImplementor factory)
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.hibernate.type.BasicType abstract String[] getRegistrationKeys() Get the names under which this type should be registered in the type registry.
From interface org.hibernate.type.SingleColumnType abstract T fromStringValue(String xml) abstract Object get(ResultSet rs, String name, SessionImplementor session) Get a column value from a result set, without worrying about the possibility of null values. abstract Object get(ResultSet rs, String name) This method is deprecated. Use get(ResultSet, String, SessionImplementor) instead. abstract T nullSafeGet(ResultSet rs, String name, SessionImplementor session) Get a column value from a result set by name. abstract T nullSafeGet(ResultSet rs, String name) This method is deprecated. Use nullSafeGet(ResultSet, String, SessionImplementor) instead abstract void nullSafeSet(PreparedStatement st, T value, int index) This method is deprecated. Use nullSafeSet(PreparedStatement, Object, int, SessionImplementor) instead. abstract void set(PreparedStatement st, T value, int index) This method is deprecated. Use set(PreparedStatement, Object, int, SessionImplementor) instead. abstract void set(PreparedStatement st, T value, int index, SessionImplementor session) Set a parameter value without worrying about the possibility of null values. abstract int sqlType() abstract String toString(T value)
From interface org.hibernate.type.StringRepresentableType abstract T fromStringValue(String string) Consume the given string representation back into this types java form. abstract String toString(T value) Render the value to the string representation.
From interface org.hibernate.type.Type abstract Object assemble(Serializable cached, SessionImplementor session, Object owner) Reconstruct the object from its cached "disassembled" state. abstract void beforeAssemble(Serializable cached, SessionImplementor session) Called before assembling a query result set from the query cache, to allow batch fetching of entities missing from the second-level cache. abstract int compare(Object x, Object y, EntityMode entityMode) Perform a Comparator style comparison between values abstract Object deepCopy(Object value, EntityMode entityMode, SessionFactoryImplementor factory) Return a deep copy of the persistent state, stopping at entities and at collections. abstract Serializable disassemble(Object value, SessionImplementor session, Object owner) Return a cacheable "disassembled" representation of the object. abstract Object fromXMLNode(Node xml, Mapping factory) Parse the XML representation of an instance. abstract int getColumnSpan(Mapping mapping) How many columns are used to persist this type. abstract int getHashCode(Object x, EntityMode entityMode) Get a hash code, consistent with persistence "equality". abstract int getHashCode(Object x, EntityMode entityMode, SessionFactoryImplementor factory) Get a hash code, consistent with persistence "equality". abstract String getName() Returns the abbreviated name of the type. abstract Class getReturnedClass() The class returned by nullSafeGet(ResultSet, String, SessionImplementor, Object) methods. abstract Type getSemiResolvedType(SessionFactoryImplementor factory) Get the type of a semi-resolved value. abstract Object hydrate(ResultSet rs, String[] names, SessionImplementor session, Object owner) Retrieve an instance of the mapped class, or the identifier of an entity or collection, from a JDBC resultset. abstract boolean isAnyType() Return true if the implementation is castable to AnyType. abstract boolean isAssociationType() Return true if the implementation is castable to AssociationType. abstract boolean isCollectionType() Return true if the implementation is castable to CollectionType. abstract boolean isComponentType() Return true if the implementation is castable to CompositeType. abstract boolean isDirty(Object oldState, Object currentState, boolean[] checkable, SessionImplementor session) Should the parent be considered dirty, given both the old and current value? abstract boolean isDirty(Object old, Object current, SessionImplementor session) Should the parent be considered dirty, given both the old and current value? abstract boolean isEntityType() Return true if the implementation is castable to EntityType. abstract boolean isEqual(Object x, Object y, EntityMode entityMode) Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state). abstract boolean isEqual(Object x, Object y, EntityMode entityMode, SessionFactoryImplementor factory) Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state). abstract boolean isModified(Object dbState, Object currentState, boolean[] checkable, SessionImplementor session) Has the value been modified compared to the current database state? The difference between this and the isDirty(Object, Object, boolean[], SessionImplementor) methods is that here we need to account for "partially" built values. abstract boolean isMutable() Are objects of this type mutable. abstract boolean isSame(Object x, Object y, EntityMode entityMode) Compare two instances of the class mapped by this type for persistence "equality" (equality of persistent state) taking a shortcut for entity references. abstract boolean isXMLElement() abstract Object nullSafeGet(ResultSet rs, String name, SessionImplementor session, Object owner) Retrieve an instance of the mapped class from a JDBC resultset. abstract Object nullSafeGet(ResultSet rs, String[] names, SessionImplementor session, Object owner) Retrieve an instance of the mapped class from a JDBC resultset. abstract void nullSafeSet(PreparedStatement st, Object value, int index, boolean[] settable, SessionImplementor session) Write an instance of the mapped class to a prepared statement, ignoring some columns. abstract void nullSafeSet(PreparedStatement st, Object value, int index, SessionImplementor session) Write an instance of the mapped class to a prepared statement. abstract Object replace(Object original, Object target, SessionImplementor session, Object owner, Map copyCache, ForeignKeyDirection foreignKeyDirection) 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. abstract Object replace(Object original, Object target, SessionImplementor session, Object owner, Map copyCache) 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. abstract Object resolve(Object value, SessionImplementor session, Object owner) Map identifiers to entities or collections. abstract Object semiResolve(Object value, SessionImplementor session, Object owner) Given a hydrated, but unresolved value, return a value that may be used to reconstruct property-ref associations. abstract void setToXMLNode(Node node, Object value, SessionFactoryImplementor factory) A representation of the value to be embedded in an XML element. abstract int[] sqlTypes(Mapping mapping) Return the JDBC types codes (per java.sql.Types) for the columns mapped by this type. abstract boolean[] toColumnNullness(Object value, Mapping mapping) Given an instance of the type, return an array of boolean, indicating which mapped columns would be null. abstract String toLoggableString(Object value, SessionFactoryImplementor factory) A representation of the value to be embedded in a log file.
From interface org.hibernate.type.XmlRepresentableType abstract T fromXMLString(String xml, Mapping factory) abstract String toXMLString(T value, SessionFactoryImplementor factory)