Class EnumArrayType

  • All Implemented Interfaces:
    java.io.Serializable, org.hibernate.type.BasicType, org.hibernate.type.ProcedureParameterExtractionAware<java.lang.Enum[]>, org.hibernate.type.ProcedureParameterNamedBinder, org.hibernate.type.SingleColumnType<java.lang.Enum[]>, org.hibernate.type.StringRepresentableType<java.lang.Enum[]>, org.hibernate.type.Type, org.hibernate.usertype.DynamicParameterizedType, org.hibernate.usertype.ParameterizedType

    public class EnumArrayType
    extends AbstractArrayType<java.lang.Enum[]>
    Maps an Enum[] array on a database ARRAY type. Multidimensional arrays are supported as well, as explained in this article.

    The SQL_ARRAY_TYPE parameter is used to define the enum type name in the database.

    For more details about how to use it, check out this article on vladmihalcea.com.

    See Also:
    Serialized Form
    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.hibernate.usertype.DynamicParameterizedType

        org.hibernate.usertype.DynamicParameterizedType.ParameterType
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static java.lang.String DEFAULT_TYPE_NAME  
      static EnumArrayType INSTANCE  
      private java.lang.String name  
      • Fields inherited from interface org.hibernate.usertype.DynamicParameterizedType

        ACCESS_TYPE, ENTITY, IS_DYNAMIC, IS_PRIMARY_KEY, PARAMETER_TYPE, PROPERTY, RETURNED_CLASS, XPROPERTY
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getName()  
      void setParameterValues​(java.util.Properties parameters)  
      • Methods inherited from class org.hibernate.type.AbstractSingleColumnStandardBasicType

        nullSafeSet, sqlType
      • Methods inherited from class org.hibernate.type.AbstractStandardBasicType

        assemble, beforeAssemble, canDoExtraction, canDoSetting, compare, deepCopy, deepCopy, defaultSizes, dictatedSizes, disassemble, extract, extract, fromString, fromStringValue, get, getColumnSpan, getDefaultSize, getDictatedSize, getHashCode, getHashCode, getJavaTypeDescriptor, getMutabilityPlan, getRegistrationKeys, getReplacement, getReturnedClass, getSemiResolvedType, getSqlTypeDescriptor, hydrate, isAnyType, isAssociationType, isCollectionType, isComponentType, isDirty, isDirty, isDirty, isEntityType, isEqual, isEqual, isModified, isMutable, isSame, isXMLElement, nullSafeGet, nullSafeGet, nullSafeGet, nullSafeGet, nullSafeSet, nullSafeSet, nullSafeSet, nullSafeSet, remapSqlTypeDescriptor, replace, replace, resolve, semiResolve, set, setJavaTypeDescriptor, setSqlTypeDescriptor, sqlTypes, toColumnNullness, toLoggableString, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface org.hibernate.type.SingleColumnType

        fromStringValue, get, nullSafeGet, set, toString
      • Methods inherited from interface org.hibernate.type.Type

        assemble, beforeAssemble, compare, deepCopy, defaultSizes, dictatedSizes, disassemble, getColumnSpan, getHashCode, getHashCode, getReturnedClass, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isComponentType, isDirty, isDirty, isEntityType, isEqual, isEqual, isModified, isMutable, isSame, nullSafeGet, nullSafeGet, nullSafeSet, replace, replace, resolve, resolve, semiResolve, sqlTypes, toColumnNullness, toLoggableString
    • Field Detail

      • DEFAULT_TYPE_NAME

        private static final java.lang.String DEFAULT_TYPE_NAME
        See Also:
        Constant Field Values
      • name

        private java.lang.String name
    • Constructor Detail

      • EnumArrayType

        public EnumArrayType()
      • EnumArrayType

        public EnumArrayType​(Configuration configuration)
      • EnumArrayType

        public EnumArrayType​(java.lang.Class arrayClass,
                             java.lang.String sqlArrayType)
    • Method Detail

      • getName

        public java.lang.String getName()
      • setParameterValues

        public void setParameterValues​(java.util.Properties parameters)
        Specified by:
        setParameterValues in interface org.hibernate.usertype.ParameterizedType
        Overrides:
        setParameterValues in class AbstractArrayType<java.lang.Enum[]>