Package org.hibernate.dialect

Class OracleEnumJdbcType

java.lang.Object

org.hibernate.dialect.OracleEnumJdbcType

All Implemented Interfaces:

Serializable, JdbcType

Direct Known Subclasses:

OracleOrdinalEnumJdbcType

public class OracleEnumJdbcType
extends Object
implements JdbcType

Represents a named enum type on Oracle 23ai+.

Hibernate does not automatically use this for enums mapped as EnumType.STRING, and instead this type must be explicitly requested using:

 @JdbcTypeCode(SqlTypes.NAMED_ENUM)
 

Author:

Loïc Lefèvre

See Also:

• SqlTypes.NAMED_ENUM
• OracleDialect.getEnumTypeDeclaration(String, String[])
• OracleDialect.getCreateEnumTypeCommand(String, String[])
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final OracleEnumJdbcType	INSTANCE

Constructor Summary

Constructors

Constructor	Description
OracleEnumJdbcType()

Method Summary

Modifier and Type	Method	Description
void	addAuxiliaryDatabaseObjects(JavaType<?> javaType, Size columnSize, Database database, JdbcTypeIndicators context)	Add auxiliary database objects for this JdbcType to the Database object.
void	addAuxiliaryDatabaseObjects(JavaType<?> javaType, Size columnSize, Database database, TypeConfiguration typeConfiguration)
<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.
String[]	getCreateEnumTypeCommand(String name, String[] values)	Used to generate the CREATE DDL command for Data Use Case Domain based on VARCHAR2 values.
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.
String	getFriendlyName()	A "friendly" name for use in logging
<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.
String	toString()

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

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

Field Details

INSTANCE

public static final OracleEnumJdbcType INSTANCE

Constructor Details

OracleEnumJdbcType

public OracleEnumJdbcType()

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

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

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

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

addAuxiliaryDatabaseObjects

public void addAuxiliaryDatabaseObjects(JavaType<?> javaType,
 Size columnSize,
 Database database,
 JdbcTypeIndicators context)

Description copied from interface: JdbcType

Add auxiliary database objects for this JdbcType to the Database object.

Specified by:

addAuxiliaryDatabaseObjects in interface JdbcType

addAuxiliaryDatabaseObjects

public void addAuxiliaryDatabaseObjects(JavaType<?> javaType,
 Size columnSize,
 Database database,
 TypeConfiguration typeConfiguration)

Specified by:

addAuxiliaryDatabaseObjects in interface JdbcType

getCreateEnumTypeCommand

public String[] getCreateEnumTypeCommand(String name,
 String[] values)

Used to generate the CREATE DDL command for Data Use Case Domain based on VARCHAR2 values.

Parameters:

name -

values -

Returns:

the DDL command to create that enum