Package org.hibernate.type.descriptor.jdbc

Class JsonJdbcType

java.lang.Object

org.hibernate.type.descriptor.jdbc.JsonJdbcType

All Implemented Interfaces:

Serializable, AggregateJdbcType, JdbcType

Direct Known Subclasses:

AbstractPostgreSQLJsonPGObjectType, H2FormatJsonJdbcType, H2JsonJdbcType, JsonAsStringJdbcType, MariaDBCastingJsonJdbcType, MySQLCastingJsonJdbcType, OracleJsonBlobJdbcType, PostgreSQLCastingJsonJdbcType

public class JsonJdbcType
extends Object
implements AggregateJdbcType

Specialized type mapping for JSON and the JSON SQL data type.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonJdbcType	INSTANCE	Singleton access

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JsonJdbcType(EmbeddableMappingType embeddableMappingType)

Method Summary

Modifier and Type	Method	Description
Object	createJdbcValue(Object domainValue, WrapperOptions options)
Object[]	extractJdbcValues(Object rawJdbcValue, WrapperOptions options)
protected <X> X	fromString(String string, JavaType<X> javaType, WrapperOptions options)
<X> ValueBinder<X>	getBinder(JavaType<X> javaType)	Obtain a binder object capable of binding values of the given Java type to parameters of a JDBC PreparedStatement.
int	getDefaultSqlTypeCode()	A JDBC type code that identifies the SQL column type.
EmbeddableMappingType	getEmbeddableMappingType()
<X> ValueExtractor<X>	getExtractor(JavaType<X> javaType)	Obtain an extractor object capable of extracting values of the given Java type from a JDBC ResultSet.
<T> JdbcLiteralFormatter<T>	getJdbcLiteralFormatter(JavaType<T> javaType)	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.
AggregateJdbcType	resolveAggregateJdbcType(EmbeddableMappingType mappingType, String sqlType, RuntimeModelCreationContext creationContext)
String	toString()
protected <X> String	toString(X value, JavaType<X> javaType, WrapperOptions options)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.type.descriptor.jdbc.JdbcType

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

Field Details

INSTANCE

public static final JsonJdbcType INSTANCE

Singleton access

Constructor Details

JsonJdbcType

protected JsonJdbcType(EmbeddableMappingType embeddableMappingType)

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

getDefaultSqlTypeCode

public int getDefaultSqlTypeCode()

Description copied from interface: JdbcType

A JDBC type code that identifies the SQL column type.

This value might be different from JdbcType.getDdlTypeCode() if the actual type e.g. JSON is emulated through a type like CLOB.

Specified by:

getDefaultSqlTypeCode in interface JdbcType

Returns:

a JDBC type code

toString

public String toString()

Overrides:

toString in class Object

getJdbcLiteralFormatter

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

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

resolveAggregateJdbcType

public AggregateJdbcType resolveAggregateJdbcType(EmbeddableMappingType mappingType,
 String sqlType,
 RuntimeModelCreationContext creationContext)

Specified by:

resolveAggregateJdbcType in interface AggregateJdbcType

getEmbeddableMappingType

public EmbeddableMappingType getEmbeddableMappingType()

Specified by:

getEmbeddableMappingType in interface AggregateJdbcType

fromString

protected <X> X fromString(String string,
 JavaType<X> javaType,
 WrapperOptions options)
                    throws SQLException

Throws:

SQLException

createJdbcValue

public Object createJdbcValue(Object domainValue,
 WrapperOptions options)
                       throws SQLException

Specified by:

createJdbcValue in interface AggregateJdbcType

Throws:

SQLException

extractJdbcValues

public Object[] extractJdbcValues(Object rawJdbcValue,
 WrapperOptions options)
                           throws SQLException

Specified by:

extractJdbcValues in interface AggregateJdbcType

Throws:

SQLException

toString

protected <X> String toString(X value,
 JavaType<X> javaType,
 WrapperOptions options)

getBinder

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

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:

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

Returns:

The appropriate binder.

getExtractor

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

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:

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

Returns:

The appropriate extractor