com.atlassian.hibernate.extras.type

Class GenericEnumUserType

java.lang.Object

com.atlassian.hibernate.extras.type.GenericEnumUserType

All Implemented Interfaces:

Serializable, org.hibernate.usertype.EnhancedUserType, org.hibernate.usertype.ParameterizedType, org.hibernate.usertype.UserType

public class GenericEnumUserType
extends Object
implements org.hibernate.usertype.EnhancedUserType, org.hibernate.usertype.ParameterizedType, Serializable

Implements a generic enum user type identified/represented by a single identifier/column.

• The enum type being represented by the certain user type must be set by using the 'enumClass' property.
• The identifier representing a enum value is retrieved by the identifierMethod. The name of the identifier method can be specified by the 'identifierMethod' property and by default the getId() method is used.
• The identifier type is automatically determined by the return-type of the identifierMethod.
• The valueOfMethod is the name of the static factory method returning the enumeration object being represented by the given identifier. The valueOfMethod's name can be specified by setting the 'valueOfMethod' property. The default valueOfMethod's name is 'fromId'.

Example of an enum type represented by an int value:

 package com.atlassian.demo;

 public enum SimpleNumber {
     UNKNOWN(-1),
     ZERO(0),
     ONE(1),
     TWO(2),
     THREE(3);

     public int getId() {
         return value;
     }

     public SimpleNumber fromId(int value) {
         switch(value) {
             case 0: return ZERO;
             case 1: return ONE;
             case 2: return TWO;
             case 3: return THREE;
             default: return UNKNOWN;
         }
     }
 }
 

Using JPA, the mapping would look like this:

 @Type(type = "com.atlassian.stash.internal.hibernate.GenericEnumUserType", parameters = {
     @Parameter(name = "enumClass", value = "com.atlassian.demo.SimpleNumber"),
     @Parameter(name = "identifierMethod", value = "getId"),
     @Parameter(name = "valueOfMethod", value = "fromId")})
 private SimpleNumber randomNumber;
 

In this example, the properties for the GenericEnumUserType are fully specified to make the example more clear on the type's usage. However, because the identifier and valueOf methods follow standard naming, properties for them may be omitted from the mapping to reduce configuration.

Since:

4.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GenericEnumUserType()

Method Summary

Methods

Modifier and Type	Method and Description
Object	assemble(Serializable cached, Object owner)
Object	deepCopy(Object value)
Serializable	disassemble(Object value)
boolean	equals(Object x, Object y)
Object	fromXMLString(String xmlValue)
int	hashCode(Object x)
boolean	isMutable()
Object	nullSafeGet(ResultSet rs, String[] names, Object owner)
void	nullSafeSet(PreparedStatement st, Object value, int index)
String	objectToSQLString(Object value)
Object	replace(Object original, Object target, Object owner)
Class	returnedClass()
void	setParameterValues(Properties parameters)
int[]	sqlTypes()
String	toXMLString(Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericEnumUserType

public GenericEnumUserType()

Method Detail

assemble

public Object assemble(Serializable cached,
              Object owner)
                throws org.hibernate.HibernateException

Specified by:

assemble in interface org.hibernate.usertype.UserType

Throws:

org.hibernate.HibernateException

deepCopy

public Object deepCopy(Object value)
                throws org.hibernate.HibernateException

Specified by:

deepCopy in interface org.hibernate.usertype.UserType

Throws:

org.hibernate.HibernateException

disassemble

public Serializable disassemble(Object value)
                         throws org.hibernate.HibernateException

Specified by:

disassemble in interface org.hibernate.usertype.UserType

Throws:

org.hibernate.HibernateException

equals

public boolean equals(Object x,
             Object y)
               throws org.hibernate.HibernateException

Specified by:

equals in interface org.hibernate.usertype.UserType

Throws:

org.hibernate.HibernateException

fromXMLString

public Object fromXMLString(String xmlValue)

Specified by:

fromXMLString in interface org.hibernate.usertype.EnhancedUserType

hashCode

public int hashCode(Object x)
             throws org.hibernate.HibernateException

Specified by:

hashCode in interface org.hibernate.usertype.UserType

Throws:

org.hibernate.HibernateException

isMutable

public boolean isMutable()

Specified by:

isMutable in interface org.hibernate.usertype.UserType

nullSafeGet

public Object nullSafeGet(ResultSet rs,
                 String[] names,
                 Object owner)
                   throws org.hibernate.HibernateException,
                          SQLException

Specified by:

nullSafeGet in interface org.hibernate.usertype.UserType

Throws:

org.hibernate.HibernateException

SQLException

nullSafeSet

public void nullSafeSet(PreparedStatement st,
               Object value,
               int index)
                 throws org.hibernate.HibernateException,
                        SQLException

Specified by:

nullSafeSet in interface org.hibernate.usertype.UserType

Throws:

org.hibernate.HibernateException

SQLException

objectToSQLString

public String objectToSQLString(Object value)

Specified by:

objectToSQLString in interface org.hibernate.usertype.EnhancedUserType

replace

public Object replace(Object original,
             Object target,
             Object owner)
               throws org.hibernate.HibernateException

Specified by:

replace in interface org.hibernate.usertype.UserType

Throws:

org.hibernate.HibernateException

returnedClass

public Class returnedClass()

Specified by:

returnedClass in interface org.hibernate.usertype.UserType

setParameterValues

public void setParameterValues(Properties parameters)

Specified by:

setParameterValues in interface org.hibernate.usertype.ParameterizedType

sqlTypes

public int[] sqlTypes()

Specified by:

sqlTypes in interface org.hibernate.usertype.UserType

toXMLString

public String toXMLString(Object value)

Specified by:

toXMLString in interface org.hibernate.usertype.EnhancedUserType