Package org.hibernate.type.internal

Class UserTypeJavaTypeWrapper<J>

java.lang.Object

org.hibernate.type.internal.UserTypeJavaTypeWrapper<J>

All Implemented Interfaces:

Serializable, BasicJavaType<J>, JavaType<J>

Direct Known Subclasses:

UserTypeVersionJavaTypeWrapper

public class UserTypeJavaTypeWrapper<J>
extends Object
implements BasicJavaType<J>

Adaptor between UserType and JavaType.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserTypeJavaTypeWrapper.MutabilityPlanWrapper<J>

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

JavaType.CoercionContext

Field Summary

Fields

Modifier and Type	Field	Description
protected UserType<J>	userType

Constructor Summary

Constructors

Constructor	Description
UserTypeJavaTypeWrapper(UserType<J> userType)

Method Summary

Modifier and Type	Method	Description
boolean	areEqual(J one, J another)	Determine if two instances are equal
int	extractHashCode(J value)	Extract a proper hash code for the given value.
J	fromString(CharSequence string)
Comparator<J>	getComparator()	Retrieve the natural comparator for this type.
long	getDefaultSqlLength(Dialect dialect, JdbcType jdbcType)	The default column length when this Java type is mapped to a SQL data type which is parametrized by length, for example Types.VARCHAR.
int	getDefaultSqlPrecision(Dialect dialect, JdbcType jdbcType)	The default column precision when this Java type is mapped to a SQL data type which is parametrized by precision, for example Types.DECIMAL.
int	getDefaultSqlScale(Dialect dialect, JdbcType jdbcType)	The default column scale when this Java type is mapped to a SQL data type which is parametrized by scale, for example Types.DECIMAL.
Class<J>	getJavaTypeClass()	Get the Java type (the Class object) described by this JavaType.
MutabilityPlan<J>	getMutabilityPlan()	Retrieve the mutability plan for this Java type.
JdbcType	getRecommendedJdbcType(JdbcTypeIndicators context)	Obtain the "recommended" SQL type descriptor for this Java type.
String	toString(J value)
<X> X	unwrap(J value, Class<X> type, WrapperOptions options)	Unwrap an instance of our handled Java type into the requested type.
<X> J	wrap(X value, WrapperOptions options)	Wrap a value as our handled Java type.

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, createJavaType, extractLoggableRepresentation, fromEncodedString, getDefaultValue, getJavaType, getLongSqlLength, getReplacement, isInstance, isTemporalType, isWider

Field Detail

userType

protected final UserType<J> userType

Constructor Detail

UserTypeJavaTypeWrapper

public UserTypeJavaTypeWrapper(UserType<J> userType)

Method Detail

getMutabilityPlan

public MutabilityPlan<J> getMutabilityPlan()

Description copied from interface: JavaType

Retrieve the mutability plan for this Java type.

Specified by:

getMutabilityPlan in interface JavaType<J>

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.

Specified by:

getRecommendedJdbcType in interface BasicJavaType<J>

Specified by:

getRecommendedJdbcType in interface JavaType<J>

Parameters:

context - Contextual information

Returns:

The recommended SQL type descriptor

getDefaultSqlLength

public long getDefaultSqlLength(Dialect dialect,
                                JdbcType jdbcType)

Description copied from interface: JavaType

The default column length when this Java type is mapped to a SQL data type which is parametrized by length, for example Types.VARCHAR.

Specified by:

getDefaultSqlLength in interface JavaType<J>

Returns:

Size.DEFAULT_LENGTH unless overridden

getDefaultSqlPrecision

public int getDefaultSqlPrecision(Dialect dialect,
                                  JdbcType jdbcType)

Description copied from interface: JavaType

The default column precision when this Java type is mapped to a SQL data type which is parametrized by precision, for example Types.DECIMAL.

Specified by:

getDefaultSqlPrecision in interface JavaType<J>

Returns:

Size.DEFAULT_PRECISION unless overridden

getDefaultSqlScale

public int getDefaultSqlScale(Dialect dialect,
                              JdbcType jdbcType)

Description copied from interface: JavaType

The default column scale when this Java type is mapped to a SQL data type which is parametrized by scale, for example Types.DECIMAL.

Specified by:

getDefaultSqlScale in interface JavaType<J>

Returns:

Size.DEFAULT_SCALE unless overridden

getComparator

public Comparator<J> getComparator()

Description copied from interface: JavaType

Retrieve the natural comparator for this type.

Specified by:

getComparator in interface JavaType<J>

extractHashCode

public int extractHashCode(J value)

Description copied from interface: JavaType

Extract a proper hash code for the given value.

Specified by:

extractHashCode in interface JavaType<J>

Parameters:

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

Returns:

The extracted hash code.

areEqual

public boolean areEqual(J one,
                        J another)

Description copied from interface: JavaType

Determine if two instances are equal

Specified by:

areEqual in interface JavaType<J>

Parameters:

one - One instance

another - The other instance

Returns:

True if the two are considered equal; false otherwise.

fromString

public J fromString(CharSequence string)

Specified by:

fromString in interface BasicJavaType<J>

Specified by:

fromString in interface JavaType<J>

toString

public String toString(J value)

Specified by:

toString in interface JavaType<J>

unwrap

public <X> X unwrap(J 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.

Specified by:

unwrap in interface JavaType<J>

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> J wrap(X value,
                  WrapperOptions options)

Description copied from interface: JavaType

Wrap a value as our handled Java type.

Intended use is during ResultSet extraction.

Specified by:

wrap in interface JavaType<J>

Type Parameters:

X - The conversion type.

Parameters:

value - The value to wrap.

options - The options

Returns:

The wrapped value.

getJavaTypeClass

public Class<J> getJavaTypeClass()

Description copied from interface: JavaType

Get the Java type (the Class object) described by this JavaType.

Specified by:

getJavaTypeClass in interface JavaType<J>

See Also:

JavaType.getJavaType()