Class EnumType<T extends Enum<T>>
- java.lang.Object
-
- org.hibernate.type.EnumType<T>
-
- All Implemented Interfaces:
Serializable
,TypeConfigurationAware
,DynamicParameterizedType
,EnhancedUserType<T>
,LoggableUserType
,ParameterizedType
,UserType<T>
public class EnumType<T extends Enum<T>> extends Object implements EnhancedUserType<T>, DynamicParameterizedType, LoggableUserType, TypeConfigurationAware, Serializable
Value type mapper for enumerations.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.hibernate.usertype.DynamicParameterizedType
DynamicParameterizedType.ParameterType
-
-
Field Summary
Fields Modifier and Type Field Description static String
ENUM
static String
NAMED
static String
TYPE
-
Fields inherited from interface org.hibernate.usertype.DynamicParameterizedType
ACCESS_TYPE, ENTITY, IS_DYNAMIC, IS_PRIMARY_KEY, PARAMETER_TYPE, PROPERTY, RETURNED_CLASS, XPROPERTY
-
-
Constructor Summary
Constructors Constructor Description EnumType()
EnumType(Class<T> enumClass, EnumValueConverter<T,?> enumValueConverter, TypeConfiguration typeConfiguration)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description T
assemble(Serializable cached, Object owner)
Reconstruct a value from its destructured representation, during the process of reading the properties of an entity from the second-level cache.T
deepCopy(T value)
Return a clone of the given instance of the Java class mapped by this custom type.Serializable
disassemble(T value)
Transform the given value into a destructured representation, suitable for storage in the second-level cache.boolean
equals(T x, T y)
Compare two instances of the Java class mapped by this custom type for persistence "equality", that is, equality of their persistent state.T
fromStringValue(CharSequence sequence)
Consume the given string representation back into this types java form.EnumValueConverter<T,?>
getEnumValueConverter()
JdbcType
getJdbcType(TypeConfiguration typeConfiguration)
A mappedJdbcType
.int
getSqlType()
The JDBC/SQL type code for the database column mapped by this custom type.TypeConfiguration
getTypeConfiguration()
BasicValueConverter<T,Object>
getValueConverter()
Returns the converter that this custom type uses for transforming from the domain type to the relational type, ornull
if there is no conversion.int
hashCode(T x)
Get a hash code for the given instance of the Java class mapped by this custom type, consistent with the definition of persistence "equality" for this custom type.boolean
isMutable()
Are instances of the Java class mapped by this custom type mutable or immutable?boolean
isOrdinal()
T
nullSafeGet(ResultSet rs, int position, SharedSessionContractImplementor session, Object owner)
Read an instance of the Java class mapped by this custom type from the given JDBCResultSet
.void
nullSafeSet(PreparedStatement st, T value, int index, SharedSessionContractImplementor session)
Write an instance of the Java class mapped by this custom type to the given JDBCPreparedStatement
.T
replace(T original, T target, Object owner)
During merge, replace the existing (target) value in the managed entity we are merging to with a new (original) value from the detached entity we are merging.Class<T>
returnedClass()
The class returned bynullSafeGet()
.void
setParameterValues(Properties parameters)
An instance of this class is "configured" by a call tosetParameterValues(java.util.Properties)
, where configuration parameters are given as entries in aProperties
object.void
setTypeConfiguration(TypeConfiguration typeConfiguration)
String
toLoggableString(Object value, SessionFactoryImplementor factory)
Generate a loggable string representation of the collection (value).String
toSqlLiteral(T value)
Return an SQL literal representation of the valueString
toString(T value)
Render the value to the string representation.-
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
-
-
-
-
Field Detail
-
ENUM
public static final String ENUM
- See Also:
- Constant Field Values
-
NAMED
public static final String NAMED
- See Also:
- Constant Field Values
-
TYPE
public static final String TYPE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EnumType
public EnumType()
-
EnumType
public EnumType(Class<T> enumClass, EnumValueConverter<T,?> enumValueConverter, TypeConfiguration typeConfiguration)
-
-
Method Detail
-
getEnumValueConverter
public EnumValueConverter<T,?> getEnumValueConverter()
-
getJdbcType
public JdbcType getJdbcType(TypeConfiguration typeConfiguration)
Description copied from interface:UserType
- Specified by:
getJdbcType
in interfaceUserType<T extends Enum<T>>
-
getValueConverter
public BasicValueConverter<T,Object> getValueConverter()
Description copied from interface:UserType
Returns the converter that this custom type uses for transforming from the domain type to the relational type, ornull
if there is no conversion.Note that it is vital to provide a converter if a column should be mapped to multiple domain types, as Hibernate will only select a column once and materialize values as instances of the Java type given by
JdbcMapping.getJdbcJavaType()
. Support for multiple domain type representations works by converting objects of that type to the domain type.- Specified by:
getValueConverter
in interfaceUserType<T extends Enum<T>>
-
setParameterValues
public void setParameterValues(Properties parameters)
An instance of this class is "configured" by a call to
setParameterValues(java.util.Properties)
, where configuration parameters are given as entries in aProperties
object. There are two distinct ways an instance may be configured:- one for
hbm.xml
-based mapping, and - another for annotation-based or
orm.xml
-based mapping.
orm.xml
, aDynamicParameterizedType.ParameterType
is passed tosetParameterValues(java.util.Properties)
under the key "org.hibernate.type.ParameterType".But in the case of
hbm.xml
, there are multiple parameters:- "enumClass", the name of the Java enumeration class.
- "useNamed", specifies if the enum should be mapped by name. Default is to map as ordinal.
- "type", a JDBC type code (legacy alternative to "useNamed").
- Specified by:
setParameterValues
in interfaceParameterizedType
- one for
-
getSqlType
public int getSqlType()
Description copied from interface:UserType
The JDBC/SQL type code for the database column mapped by this custom type.The type code is usually one of the standard type codes declared by
SqlTypes
, but it could be a database-specific code.
-
returnedClass
public Class<T> returnedClass()
Description copied from interface:UserType
The class returned bynullSafeGet()
.- Specified by:
returnedClass
in interfaceUserType<T extends Enum<T>>
- Returns:
- Class
-
equals
public boolean equals(T x, T y) throws HibernateException
Description copied from interface:UserType
Compare two instances of the Java class mapped by this custom type for persistence "equality", that is, equality of their persistent state.
-
hashCode
public int hashCode(T x) throws HibernateException
Description copied from interface:UserType
Get a hash code for the given instance of the Java class mapped by this custom type, consistent with the definition of persistence "equality" for this custom type.
-
nullSafeGet
public T nullSafeGet(ResultSet rs, int position, SharedSessionContractImplementor session, Object owner) throws SQLException
Description copied from interface:UserType
Read an instance of the Java class mapped by this custom type from the given JDBCResultSet
. Implementors must handle null column values.- Specified by:
nullSafeGet
in interfaceUserType<T extends Enum<T>>
- Throws:
SQLException
-
nullSafeSet
public void nullSafeSet(PreparedStatement st, T value, int index, SharedSessionContractImplementor session) throws HibernateException, SQLException
Description copied from interface:UserType
Write an instance of the Java class mapped by this custom type to the given JDBCPreparedStatement
. Implementors must handle null values of the Java class. A multi-column type should be written to parameters starting fromindex
.- Specified by:
nullSafeSet
in interfaceUserType<T extends Enum<T>>
- Throws:
HibernateException
SQLException
-
deepCopy
public T deepCopy(T value) throws HibernateException
Description copied from interface:UserType
Return a clone of the given instance of the Java class mapped by this custom type.- It's not necessary to clone immutable objects. If the Java class mapped by this custom type is an immutable class, this method may safely just return its argument.
- For mutable objects, it's necessary to deep copy persistent state, stopping at associations to other entities, and at persistent collections.
- If the argument is a reference to an entity, just return the argument.
- Finally, if the argument is null, just return null.
-
isMutable
public boolean isMutable()
Description copied from interface:UserType
Are instances of the Java class mapped by this custom type mutable or immutable?
-
disassemble
public Serializable disassemble(T value) throws HibernateException
Description copied from interface:UserType
Transform the given value into a destructured representation, suitable for storage in the second-level cache. This method is called only during the process of writing the properties of an entity to the second-level cache.If the value is mutable then, at the very least, this method should perform a deep copy. That may not be enough for some types, however. For example, associations must be cached as identifier values.
This is an optional operation, but, if left unimplemented, this type will not be cacheable in the second-level cache.
- Specified by:
disassemble
in interfaceUserType<T extends Enum<T>>
- Parameters:
value
- the object to be cached- Returns:
- a cacheable representation of the object
- Throws:
HibernateException
- See Also:
Cache
-
assemble
public T assemble(Serializable cached, Object owner) throws HibernateException
Description copied from interface:UserType
Reconstruct a value from its destructured representation, during the process of reading the properties of an entity from the second-level cache.If the value is mutable then, at the very least, this method should perform a deep copy. That may not be enough for some types, however. For example, associations must be cached as identifier values.
This is an optional operation, but, if left unimplemented, this type will not be cacheable in the second-level cache.
-
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 managed entity we are merging to with a new (original) value from the detached entity we are merging.- For immutable objects, or null values, it's safe to simply return the first argument.
- For mutable objects, it's enough to return a copy of the first argument.
- For objects with component values, it might make sense to recursively replace component values.
- Specified by:
replace
in interfaceUserType<T extends Enum<T>>
- Parameters:
original
- the value from the detached entity being mergedtarget
- the value in the managed entity- Returns:
- the value to be merged
- Throws:
HibernateException
- See Also:
Session.merge(Object)
-
getTypeConfiguration
public TypeConfiguration getTypeConfiguration()
- Specified by:
getTypeConfiguration
in interfaceTypeConfigurationAware
-
setTypeConfiguration
public void setTypeConfiguration(TypeConfiguration typeConfiguration)
- Specified by:
setTypeConfiguration
in interfaceTypeConfigurationAware
-
toSqlLiteral
public String toSqlLiteral(T value)
Description copied from interface:EnhancedUserType
Return an SQL literal representation of the value- Specified by:
toSqlLiteral
in interfaceEnhancedUserType<T extends Enum<T>>
-
toString
public String toString(T value)
Description copied from interface:EnhancedUserType
Render the value to the string representation.- Specified by:
toString
in interfaceEnhancedUserType<T extends Enum<T>>
- Parameters:
value
- The value to render to string.- Returns:
- The string representation
-
fromStringValue
public T fromStringValue(CharSequence sequence)
Description copied from interface:EnhancedUserType
Consume the given string representation back into this types java form.- Specified by:
fromStringValue
in interfaceEnhancedUserType<T extends Enum<T>>
- Parameters:
sequence
- The string representation to be consumed.- Returns:
- The java type representation
-
toLoggableString
public String toLoggableString(Object value, SessionFactoryImplementor factory)
Description copied from interface:LoggableUserType
Generate a loggable string representation of the collection (value).- Specified by:
toLoggableString
in interfaceLoggableUserType
- Parameters:
value
- The collection to be logged; guaranteed to be non-null and initialized.factory
- The factory.- Returns:
- The loggable string representation.
-
isOrdinal
public boolean isOrdinal()
-
-