Package org.hibernate.usertype

package org.hibernate.usertype

An API for user-defined custom types which extend the set of built-in types defined in org.hibernate.type.

A custom type might map a single column, or it might map multiple columns.

See Also:

• UserType
• CompositeUserType
• org.hibernate.type

API Note:

Historically, UserType was the most important extension point in Hibernate, and CompositeUserType was much less popular. But in modern Hibernate, the terrain formerly occupied by UserType has been encroached, first by AttributeConverter, and then by the new "compositional" approach to basic types. Contrariwise, CompositeUserType has been redesigned and is now more powerful and much easier to use.

Related Packages

Package	Description
org.hibernate	This package defines the central Hibernate APIs, beginning with SessionFactory, which represents an instance of Hibernate at runtime and is the source of new instances of Session and StatelessSession, the most important APIs exposing persistence-related operations for entities.
org.hibernate.usertype.internal

Class	Description
BaseUserTypeSupport<T>
CompositeUserType<J>	This interface should be implemented by user-defined custom types that have persistent attributes and can be thought of as something more like an embeddable object.
DynamicParameterizedType	Types which implement this interface will have ParameterizedType.setParameterValues(Properties) called with an instance of the class DynamicParameterizedType.ParameterType instead of the key "org.hibernate.type.ParameterType".
DynamicParameterizedType.ParameterType
EnhancedUserType<J>	A custom type that may function as an identifier or discriminator type
LoggableUserType	Marker interface for user types which want to perform custom logging of their corresponding values
ParameterizedType	Support for parameterizable types.
StaticUserTypeSupport<T>
UserCollectionType	A custom type for mapping user-written classes which implement PersistentCollection.
UserType<J>	This interface should be implemented by user-defined custom types that extend the set of types defined in org.hibernate.type.
UserTypeLegacyBridge	Convenience UserType implementation which mimics the legacy @Type annotation which was based on the hbm.xml mapping's string-based type support.
UserTypeSupport<T>
UserVersionType<T>	A user type that may be used for a version property