All Superinterfaces:

Serializable

All Known Subinterfaces:

AdjustableJdbcType, AggregateJdbcType

All Known Implementing Classes:

AbstractCastingPostGISJdbcType, AbstractHANADialect.HANABlobType, AbstractPostGISJdbcType, AbstractPostgreSQLJsonPGObjectType, AbstractPostgreSQLStructJdbcType, AbstractSqlServerGISType, ArrayJdbcType, BigIntJdbcType, BinaryJdbcType, BlobJdbcType, BooleanJdbcType, CharJdbcType, ClobJdbcType, DateJdbcType, DB2GeometryType, DB2StructJdbcType, DecimalJdbcType, DoubleJdbcType, FloatJdbcType, H2DurationIntervalSecondJdbcType, H2FormatJsonJdbcType, H2GISGeometryType, HANAGeometryType, HANAPointType, InstantAsTimestampJdbcType, InstantAsTimestampWithTimeZoneJdbcType, InstantJdbcType, IntegerJdbcType, JsonAsStringJdbcType, JsonJdbcType, LongNVarcharJdbcType, LongVarbinaryJdbcType, LongVarcharJdbcType, MySQLCastingJsonJdbcType, MySQLGeometryJdbcType, NCharJdbcType, NClobJdbcType, NullJdbcType, NumericJdbcType, NVarcharJdbcType, ObjectJdbcType, ObjectNullAsBinaryTypeJdbcType, ObjectNullAsNullTypeJdbcType, ObjectNullResolvingJdbcType, OracleArrayJdbcType, OracleBooleanJdbcType, OracleJsonBlobJdbcType, OracleJsonJdbcType, OracleReflectionStructJdbcType, OracleStructJdbcType, OracleXmlJdbcType, PGCastingGeographyJdbcType, PGCastingGeometryJdbcType, PGGeographyJdbcType, PGGeometryJdbcType, PostgreSQLCastingInetJdbcType, PostgreSQLCastingIntervalSecondJdbcType, PostgreSQLCastingJsonJdbcType, PostgreSQLInetJdbcType, PostgreSQLIntervalSecondJdbcType, PostgreSQLJsonPGObjectJsonbType, PostgreSQLJsonPGObjectJsonType, PostgreSQLStructCastingJdbcType, PostgreSQLStructPGObjectJdbcType, RealJdbcType, RowIdJdbcType, SDOGeometryType, SmallIntJdbcType, SqlServerGeographyType, SqlServerGeometryType, StructJdbcType, TimeAsTimestampWithTimeZoneJdbcType, TimeJdbcType, TimestampJdbcType, TimestampUtcAsInstantJdbcType, TimestampUtcAsJdbcTimestampJdbcType, TimestampUtcAsOffsetDateTimeJdbcType, TimestampWithTimeZoneJdbcType, TimeUtcAsJdbcTimeJdbcType, TimeUtcAsOffsetTimeJdbcType, TimeWithTimeZoneJdbcType, TinyIntAsSmallIntJdbcType, TinyIntJdbcType, UserTypeSqlTypeAdapter, UUIDJdbcType, VarbinaryJdbcType, VarcharJdbcType, VarcharUUIDJdbcType, XmlAsStringJdbcType, XmlJdbcType
```
public interface JdbcType
extends Serializable
```
Descriptor for the SQL/JDBC side of a value mapping. A JdbcType is always coupled with a JavaType to describe the typing aspects of an attribute mapping from Java to JDBC.
An instance of this type need not correspond directly to a SQL column type on a particular database. Rather, a JdbcType defines how values are read from and written to JDBC. Therefore, implementations of this interface map more directly to the JDBC type codes defined by Types and SqlTypes.
Every JdbcType has a ValueBinder and a ValueExtractor which, respectively, do the hard work of writing values to parameters of a JDBC PreparedStatement, and reading values from the columns of a JDBC ResultSet.
The JDBC type code ultimately determines, in collaboration with the SQL dialect, the SQL column type generated by Hibernate's schema export tool.
A JDBC type may be selected when mapping an entity attribute using the JdbcType annotation, or, indirectly, using the JdbcTypeCode annotation.
Custom implementations should be registered with the JdbcTypeRegistry at startup. The built-in implementations are registered automatically.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default void`	`appendWriteExpression(String writeExpression, SqlAppender appender, Dialect dialect)`	Append the write expression wrapped in a way to be able to write values with this JdbcType's ValueBinder.
`<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`.
`default CastType`	`getCastType()`
`static CastType`	`getCastType(int typeCode)`
`default String`	`getCheckCondition(String columnName, JavaType<?> javaType, Dialect dialect)`	The check constraint that should be added to the column definition in generated DDL.
`default int`	`getDdlTypeCode()`	A JDBC type code that identifies the SQL column type to be used for schema generation.
`default int`	`getDefaultSqlTypeCode()`	A JDBC type code that identifies the SQL column type.
`<X> ValueExtractor<X>`	`getExtractor(JavaType<X> javaType)`	Obtain an extractor object capable of extracting values of the given Java type from a JDBC `ResultSet`.
`default String`	`getFriendlyName()`	A "friendly" name for use in logging
`default <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.
`default <T> JavaType<T>`	`getJdbcRecommendedJavaTypeMapping(Integer precision, Integer scale, TypeConfiguration typeConfiguration)`
`int`	`getJdbcTypeCode()`	The JDBC type code used when interacting with JDBC APIs.
`default Class<?>`	`getPreferredJavaTypeClass(WrapperOptions options)`	The Java type class that is preferred by the binder or null.
`default boolean`	`isBinary()`
`default boolean`	`isDecimal()`
`default boolean`	`isFloat()`
`default boolean`	`isInteger()`
`default boolean`	`isInterval()`
`default boolean`	`isLob()`
`static boolean`	`isLob(int jdbcTypeCode)`
`default boolean`	`isLobOrLong()`
`static boolean`	`isLobOrLong(int jdbcTypeCode)`
`default boolean`	`isNationalized()`
`static boolean`	`isNationalized(int jdbcTypeCode)`
`default boolean`	`isNumber()`
`default boolean`	`isString()`
`default boolean`	`isTemporal()`
`default void`	`registerOutParameter(CallableStatement callableStatement, int index)`	Register the `OUT` parameter on the `CallableStatement` with the given index for this JdbcType.
`default void`	`registerOutParameter(CallableStatement callableStatement, String name)`	Register the `OUT` parameter on the `CallableStatement` with the given name for this JdbcType.
`default Expression`	`wrapTopLevelSelectionExpression(Expression expression)`	Wraps the top level selection expression to be able to read values with this JdbcType's ValueExtractor.
`default String`	`wrapWriteExpression(String writeExpression, Dialect dialect)`	Wraps the write expression to be able to write values with this JdbcType's ValueBinder.

Method Detail

getFriendlyName
```
default String getFriendlyName()
```
A "friendly" name for use in logging

getJdbcTypeCode
```
int getJdbcTypeCode()
```
The JDBC type code used when interacting with JDBC APIs.
For example, it's used when calling PreparedStatement.setNull(int, int).

Returns:

a JDBC type code

getDefaultSqlTypeCode
```
default int getDefaultSqlTypeCode()
```
A JDBC type code that identifies the SQL column type.
This value might be different from getDdlTypeCode() if the actual type e.g. JSON is emulated through a type like CLOB.

Returns:

a JDBC type code

getDdlTypeCode
```
default int getDdlTypeCode()
```
A JDBC type code that identifies the SQL column type to be used for schema generation.
This value is passed to DdlTypeRegistry.getTypeName(int, Size) to obtain the SQL column type.

Returns:

a JDBC type code

Since:

6.2

getJdbcRecommendedJavaTypeMapping

default <T> JavaType<T> getJdbcRecommendedJavaTypeMapping(Integer precision,
                                                          Integer scale,
                                                          TypeConfiguration typeConfiguration)

getJdbcLiteralFormatter
```
default <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.

getBinder
```
<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.

Parameters:

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

Returns:

The appropriate binder.

getExtractor
```
<X> ValueExtractor<X> getExtractor(JavaType<X> javaType)
```
Obtain an extractor object capable of extracting values of the given Java type from a JDBC ResultSet.

Parameters:

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

Returns:

The appropriate extractor

getPreferredJavaTypeClass

@Incubating
default Class<?> getPreferredJavaTypeClass(WrapperOptions options)

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

getCheckCondition
```
default String getCheckCondition(String columnName,
                                 JavaType<?> javaType,
                                 Dialect dialect)
```
The check constraint that should be added to the column definition in generated DDL.

Parameters:

columnName - the name of the column

javaType - the JavaType of the mapped column

dialect - the SQL Dialect

Returns:

a check constraint condition or null

Since:

6.2

wrapTopLevelSelectionExpression
```
@Incubating
default Expression wrapTopLevelSelectionExpression(Expression expression)
```
Wraps the top level selection expression to be able to read values with this JdbcType's ValueExtractor.

Since:

6.2

wrapWriteExpression

@Incubating
default String wrapWriteExpression(String writeExpression,
                                   Dialect dialect)

Wraps the write expression to be able to write values with this JdbcType's ValueBinder.

Since:: 6.2

appendWriteExpression

@Incubating
default void appendWriteExpression(String writeExpression,
                                   SqlAppender appender,
                                   Dialect dialect)

Append the write expression wrapped in a way to be able to write values with this JdbcType's ValueBinder.

Since:: 6.2

isInteger
```
default boolean isInteger()
```

isFloat
```
default boolean isFloat()
```

isDecimal
```
default boolean isDecimal()
```

isNumber
```
default boolean isNumber()
```

isBinary
```
default boolean isBinary()
```

isString
```
default boolean isString()
```

isTemporal
```
default boolean isTemporal()
```

isLob
```
default boolean isLob()
```

isLob

static boolean isLob(int jdbcTypeCode)

isLobOrLong
```
default boolean isLobOrLong()
```

isLobOrLong

static boolean isLobOrLong(int jdbcTypeCode)

isNationalized
```
default boolean isNationalized()
```

isNationalized

static boolean isNationalized(int jdbcTypeCode)

isInterval
```
default boolean isInterval()
```

getCastType
```
default CastType getCastType()
```

getCastType

static CastType getCastType(int typeCode)

registerOutParameter

default void registerOutParameter(CallableStatement callableStatement,
                                  String name)
                           throws SQLException

Register the OUT parameter on the CallableStatement with the given name for this JdbcType.

Throws:: SQLException
Since:: 6.2

registerOutParameter

default void registerOutParameter(CallableStatement callableStatement,
                                  int index)
                           throws SQLException

Register the OUT parameter on the CallableStatement with the given index for this JdbcType.

Throws:: SQLException
Since:: 6.2

Interface JdbcType

Method Summary

Method Detail

getFriendlyName

getJdbcTypeCode

getDefaultSqlTypeCode

getDdlTypeCode

getJdbcRecommendedJavaTypeMapping

getJdbcLiteralFormatter

getBinder

getExtractor

getPreferredJavaTypeClass

getCheckCondition

wrapTopLevelSelectionExpression

wrapWriteExpression

appendWriteExpression

isInteger

isFloat

isDecimal

isNumber

isBinary

isString

isTemporal

isLob

isLob

isLobOrLong

isLobOrLong

isNationalized

isNationalized

isInterval

getCastType

getCastType

registerOutParameter

registerOutParameter