Package org.hibernate.type.descriptor.java.spi

Class CollectionJavaType<C>

java.lang.Object

org.hibernate.type.descriptor.java.AbstractClassJavaType<C>

org.hibernate.type.descriptor.java.spi.CollectionJavaType<C>

All Implemented Interfaces:

Serializable, BasicJavaType<C>, JavaType<C>

public class CollectionJavaType<C>
extends AbstractClassJavaType<C>

Extension of the general JavaType for "collection types"

See Also:

CollectionSemantics, Serialized Form

API Note:

"Collection types" are defined loosely here to cover mapping collection types other than those from the "Java Collection Framework".

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.type.descriptor.java.JavaType

JavaType.CoercionContext

Constructor Summary

Constructors

Constructor	Description
CollectionJavaType(Class<? extends C> type, CollectionSemantics<C,?> semantics)

Method Summary

Modifier and Type	Method	Description
boolean	areEqual(C one, C another)	Determine if two instances are equal
JavaType<C>	createJavaType(ParameterizedType parameterizedType, TypeConfiguration typeConfiguration)	Creates the JavaType for the given ParameterizedType based on this JavaType registered for the raw type.
int	extractHashCode(C x)	Extract a proper hash code for the given value.
C	fromString(CharSequence string)
JdbcType	getRecommendedJdbcType(JdbcTypeIndicators context)	Obtain the "recommended" SQL type descriptor for this Java type.
CollectionSemantics<C,?>	getSemantics()
<X> X	unwrap(C value, Class<X> type, WrapperOptions options)	Unwrap an instance of our handled Java type into the requested type.
<X> C	wrap(X value, WrapperOptions options)	Wrap a value as our handled Java type.

Methods inherited from class org.hibernate.type.descriptor.java.AbstractClassJavaType

extractLoggableRepresentation, getComparator, getJavaType, getJavaTypeClass, getMutabilityPlan, unknownUnwrap, unknownWrap

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.descriptor.java.JavaType

appendEncodedString, coerce, createJavaType, fromEncodedString, getCheckCondition, getDefaultSqlLength, getDefaultSqlPrecision, getDefaultSqlScale, getDefaultValue, getLongSqlLength, getReplacement, getTypeName, isInstance, isTemporalType, isWider, toString, useObjectEqualsHashCode

Constructor Detail

CollectionJavaType

public CollectionJavaType(Class<? extends C> type,
                          CollectionSemantics<C,?> semantics)

Method Detail

getSemantics

public CollectionSemantics<C,?> getSemantics()

getRecommendedJdbcType

public JdbcType getRecommendedJdbcType(JdbcTypeIndicators context)

Description copied from interface: BasicJavaType

Obtain the "recommended" SQL type descriptor for this Java type. Often, but not always, the source of this recommendation is the JDBC specification.

Parameters:

context - Contextual information

Returns:

The recommended SQL type descriptor

createJavaType

public JavaType<C> createJavaType(ParameterizedType parameterizedType,
                                  TypeConfiguration typeConfiguration)

Description copied from interface: JavaType

Creates the JavaType for the given ParameterizedType based on this JavaType registered for the raw type.

fromString

public C fromString(CharSequence string)

unwrap

public <X> X unwrap(C value,
                    Class<X> type,
                    WrapperOptions options)

Description copied from interface: JavaType

Unwrap an instance of our handled Java type into the requested type.

As an example, if this is a JavaType<Integer> and we are asked to unwrap the Integer value as a Long, we would return something like Long.valueOf( value.longValue() ).

Intended use is during PreparedStatement binding.

Type Parameters:

X - The conversion type.

Parameters:

value - The value to unwrap

type - The type as which to unwrap

options - The options

Returns:

The unwrapped value.

wrap

public <X> C wrap(X value,
                  WrapperOptions options)

Description copied from interface: JavaType

Wrap a value as our handled Java type.

Intended use is during ResultSet extraction.

Type Parameters:

X - The conversion type.

Parameters:

value - The value to wrap.

options - The options

Returns:

The wrapped value.

areEqual

public boolean areEqual(C one,
                        C another)

Description copied from interface: JavaType

Determine if two instances are equal

Specified by:

areEqual in interface JavaType<C>

Overrides:

areEqual in class AbstractClassJavaType<C>

Parameters:

one - One instance

another - The other instance

Returns:

True if the two are considered equal; false otherwise.

extractHashCode

public int extractHashCode(C x)

Description copied from interface: JavaType

Extract a proper hash code for the given value.

Specified by:

extractHashCode in interface JavaType<C>

Overrides:

extractHashCode in class AbstractClassJavaType<C>

Parameters:

x - The value for which to extract a hash code.

Returns:

The extracted hash code.