Class ArrayJdbcType

java.lang.Object

org.hibernate.type.descriptor.jdbc.ArrayJdbcType

All Implemented Interfaces:

Serializable, JdbcType

Direct Known Subclasses:

JsonArrayJdbcType, OracleArrayJdbcType, PostgreSQLArrayJdbcType, XmlArrayJdbcType

public class ArrayJdbcType
extends Object
implements JdbcType

Descriptor for ARRAY handling.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ArrayJdbcType(JdbcType elementJdbcType)

Method Summary

Modifier and Type	Method	Description
protected <T,E> Object[]	convertToArray(BasicBinder<T> binder, ValueBinder<E> elementBinder, BasicPluralJavaType<E> pluralJavaType, T value, WrapperOptions options)
protected static JavaType<?>	elementJavaType(JavaType<?> javaTypeDescriptor)
boolean	equals(Object that)	Check equality.
protected <X> X	getArray(BasicExtractor<X> extractor, Array array, WrapperOptions options)
<X> ValueBinder<X>	getBinder(JavaType<X> javaTypeDescriptor)	Obtain a binder object capable of binding values of the given Java type to parameters of a JDBC PreparedStatement.
JdbcType	getElementJdbcType()
protected String	getElementTypeName(JavaType<?> javaType, SharedSessionContractImplementor session)
<X> ValueExtractor<X>	getExtractor(JavaType<X> javaTypeDescriptor)	Obtain an extractor object capable of extracting values of the given Java type from a JDBC ResultSet.
String	getFriendlyName()	A "friendly" name for use in logging
<T> JdbcLiteralFormatter<T>	getJdbcLiteralFormatter(JavaType<T> javaTypeDescriptor)	Obtain a formatter object capable of rendering values of the given Java type as SQL literals of the type represented by this object.
int	getJdbcTypeCode()	The JDBC type code used when interacting with JDBC APIs.
Class<?>	getPreferredJavaTypeClass(WrapperOptions options)	The Java type class that is preferred by the binder or null.
JavaType<?>	getRecommendedJavaType(Integer precision, Integer scale, TypeConfiguration typeConfiguration)	The Java type usually is used to represent values of this JDBC type in the entity model of the data.
int	hashCode()
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface JdbcType

addAuxiliaryDatabaseObjects, appendWriteExpression, appendWriteExpression, castFromPattern, castToPattern, getCastType, getCheckCondition, getDdlTypeCode, getDefaultSqlTypeCode, getExtraCreateTableInfo, getJdbcRecommendedJavaTypeMapping, hasDatePart, hasTimePart, isArray, isBinary, isBoolean, isComparable, isDecimal, isDuration, isFloat, isImplicitJson, isImplicitXml, isInteger, isInterval, isJson, isLob, isLobOrLong, isNationalized, isNumber, isSmallInteger, isSpatial, isString, isStringLike, isStringLikeExcludingClob, isTemporal, isWriteExpressionTyped, isXml, registerOutParameter, registerOutParameter, wrapTopLevelSelectionExpression, wrapWriteExpression, wrapWriteExpression

Constructor Details

ArrayJdbcType

public ArrayJdbcType(JdbcType elementJdbcType)

Method Details

getJdbcTypeCode

public int getJdbcTypeCode()

Description copied from interface: JdbcType

The JDBC type code used when interacting with JDBC APIs.

For example, it's used when calling PreparedStatement.setNull(int, int).

Specified by:

getJdbcTypeCode in interface JdbcType

Returns:

a JDBC type code

getElementJdbcType

public JdbcType getElementJdbcType()

getRecommendedJavaType

public JavaType<?> getRecommendedJavaType(Integer precision,
 Integer scale,
 TypeConfiguration typeConfiguration)

Description copied from interface: JdbcType

The Java type usually is used to represent values of this JDBC type in the entity model of the data. Often, but not always, the source of this recommendation is the JDBC specification.

Specified by:

getRecommendedJavaType in interface JdbcType

elementJavaType

protected static JavaType<?> elementJavaType(JavaType<?> javaTypeDescriptor)

getJdbcLiteralFormatter

public <T> JdbcLiteralFormatter<T> getJdbcLiteralFormatter(JavaType<T> javaTypeDescriptor)

Description copied from interface: JdbcType

Obtain a formatter object capable of rendering values of the given Java type as SQL literals of the type represented by this object.

Specified by:

getJdbcLiteralFormatter in interface JdbcType

getPreferredJavaTypeClass

public Class<?> getPreferredJavaTypeClass(WrapperOptions options)

Description copied from interface: JdbcType

The Java type class that is preferred by the binder or null.

Specified by:

getPreferredJavaTypeClass in interface JdbcType

getElementTypeName

protected String getElementTypeName(JavaType<?> javaType,
 SharedSessionContractImplementor session)

convertToArray

protected <T,E> Object[] convertToArray(BasicBinder<T> binder,
 ValueBinder<E> elementBinder,
 BasicPluralJavaType<E> pluralJavaType,
 T value,
 WrapperOptions options)
                                 throws SQLException

Throws:

SQLException

getArray

protected <X> X getArray(BasicExtractor<X> extractor,
 Array array,
 WrapperOptions options)
                  throws SQLException

Throws:

SQLException

getBinder

public <X> ValueBinder<X> getBinder(JavaType<X> javaTypeDescriptor)

Description copied from interface: JdbcType

Obtain a binder object capable of binding values of the given Java type to parameters of a JDBC PreparedStatement.

Specified by:

getBinder in interface JdbcType

Parameters:

javaTypeDescriptor - The descriptor describing the types of Java values to be bound

Returns:

The appropriate binder.

getExtractor

public <X> ValueExtractor<X> getExtractor(JavaType<X> javaTypeDescriptor)

Description copied from interface: JdbcType

Obtain an extractor object capable of extracting values of the given Java type from a JDBC ResultSet.

Specified by:

getExtractor in interface JdbcType

Parameters:

javaTypeDescriptor - The descriptor describing the types of Java values to be extracted

Returns:

The appropriate extractor

getFriendlyName

public String getFriendlyName()

Description copied from interface: JdbcType

A "friendly" name for use in logging

Specified by:

getFriendlyName in interface JdbcType

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object that)

Check equality. Needed so that ArrayJdbcType in collections correctly match each other.

Overrides:

equals in class Object

Returns:

true if the two array types share the same element type

hashCode

public int hashCode()

Overrides:

hashCode in class Object