Module org.jooq

Package org.jooq.impl

Class DefaultDataType<T>

java.lang.Object

org.jooq.impl.DefaultDataType<T>

All Implemented Interfaces:

Serializable, DataType<T>, Named, QueryPart, QueryPartInternal

Direct Known Subclasses:

BuiltInDataType

@Internal
public class DefaultDataType<T>
extends Object

A common base class for data types.

This also acts as a static data type registry for jOOQ internally.

This type is for JOOQ INTERNAL USE only. Do not reference directly

Author:

Lukas Eder

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultDataType(SQLDialect dialect, Class<T> type, String typeName)
DefaultDataType(SQLDialect dialect, Class<T> type, String typeName, String castTypeName)
DefaultDataType(SQLDialect dialect, DataType<T> sqlDataType, String typeName)
DefaultDataType(SQLDialect dialect, DataType<T> sqlDataType, String typeName, String castTypeName)

Method Summary

Modifier and Type	Method	Description
void	accept(Context<?> ctx)	This QueryPart can accept a Context object in order to render a SQL string or to bind its variables.
<A extends ArrayRecord<?>> DataType<A>	asArrayDataType(Class<A> arrayDataType)	Retrieve the data type for an Oracle-style ARRAY of this data type.
<U> DataType<U>	asConvertedDataType(Binding<? super T,U> newBinding)	Retrieve the data type for a given binding.
<U> DataType<U>	asConvertedDataType(Converter<? super T,U> converter)	Retrieve the data type for a given converter.
<E extends EnumType> DataType<E>	asEnumDataType(Class<E> enumDataType)	Retrieve the data type for a given enum data type.
CharacterSet	characterSet()	Get the character set of this data type, or null if there is no character set, or if the default character set applies.
DataType<T>	characterSet(CharacterSet c)	Return a new data type like this, with a new character set.
Clause[]	clauses(Context<?> ctx)	Deprecated. - 3.11.0 - [#8179] - This functionality will be removed in the future.
Collation	collation()	Get the collation of this data type, or null if there is no collation, or if the default collation applies.
DataType<T>	collation(Collation c)	Return a new data type like this, with a new collation.
T	convert(Object object)	Convert an arbitrary object into <T>.
T[]	convert(Object... objects)	Convert an arbitrary set of objects into <T>.
List<T>	convert(Collection<?> objects)	Convert an arbitrary set of objects into <T>.
protected DSLContext	create()	Deprecated. - 3.11.0 - [#6722] - Use Attachable.configuration() and Configuration.dsl() instead.
protected DSLContext	create(Configuration configuration)	Deprecated. - 3.11.0 - [#6722] - Use Attachable.configuration() and Configuration.dsl() instead.
protected DSLContext	create(Context<?> ctx)	Deprecated. - 3.11.0 - [#6722] - Use Attachable.configuration() and Configuration.dsl() instead.
boolean	declaresCTE()	Subclasses may override this
boolean	declaresFields()	Subclasses may override this
boolean	declaresParameters()	Subclasses may override this
boolean	declaresTables()	Subclasses may override this
boolean	declaresWindows()	Subclasses may override this
Field<T>	default_()	The expression to be applied as the DEFAULT value for this data type.
DataType<T>	default_(Field<T> d)	Specify an expression to be applied as the DEFAULT value for this data type.
DataType<T>	default_(T d)	Specify an expression to be applied as the DEFAULT value for this data type.
boolean	defaulted()	Get the defaultability of this data type.
DataType<T>	defaulted(boolean d)	Deprecated.
Field<T>	defaultValue()	The expression to be applied as the DEFAULT value for this data type.
DataType<T>	defaultValue(Field<T> d)	Specify an expression to be applied as the DEFAULT value for this data type.
DataType<T>	defaultValue(T d)	Specify an expression to be applied as the DEFAULT value for this data type.
boolean	equals(Object obj)	Check whether this QueryPart can be considered equal to another QueryPart.
boolean	generatesCast()	Subclasses may override this
DataType<?>	getArrayComponentDataType()	Retrieve the Java component data type if this is an ARRAY type, or null, otherwise.
Class<?>	getArrayComponentType()	Retrieve the Java component type if this is an ARRAY type, or null, otherwise.
DataType<T[]>	getArrayDataType()	Retrieve the data type for an ARRAY of this data type.
Class<T[]>	getArrayType()	Retrieve the Java type associated with ARRAYs of this data type.
Binding<?,T>	getBinding()	Get the data type binding associated with this data type.
String	getCastTypeName()	Retrieve the dialect-specific type name associated with this data type used for casting.
String	getCastTypeName(Configuration configuration)	Retrieve the dialect-specific type name associated with this data type used for casting.
String	getComment()	The comment on this object.
Comment	getCommentPart()	The comment on this object as a QueryPart.
Converter<?,T>	getConverter()	Get the converter associated with this data type.
DataType<T>	getDataType(Configuration configuration)	The dialect-specific data type representing this data type.
static DataType<?>	getDataType(SQLDialect dialect, int sqlType)
static <T> DataType<T>	getDataType(SQLDialect dialect, Class<T> type)
static <T> DataType<T>	getDataType(SQLDialect dialect, Class<T> type, DataType<T> fallbackDataType)
static DataType<?>	getDataType(SQLDialect dialect, String typeName)
static DataType<?>	getDataType(SQLDialect dialect, String t, int p, int s)	Convert a type name (using precision and scale) into a Java class
static DataType<?>	getDataType(SQLDialect dialect, String t, int p, int s, boolean forceIntegerTypesOnZeroScaleDecimals)	Convert a type name (using precision and scale) into a Java class
static DataType<?>	getDataType(SQLDialect dialect, SQLType sqlType)
static DataType<Object>	getDefaultDataType(String typeName)
static DataType<Object>	getDefaultDataType(SQLDialect dialect, String typeName)
SQLDialect	getDialect()	Retrieve the underlying SQLDialect.
Domain<T>	getDomain()	Get the defining DOMAIN type or NULL if there is no such type.
String	getName()	The unqualified name of this object.
Name	getQualifiedName()	The qualified name of this object.
Class<? extends Record>	getRecordType()	Get the nested record's record type definition, if this is a DataType.isRecord(), or a DataType.isMultiset(), or NULL otherwise.
Row	getRow()	Get the nested record's Row definition, if this is a DataType.isRecord(), or a DataType.isMultiset(), or NULL otherwise.
DataType<T>	getSQLDataType()	Get the standard SQL data type of this (dialect-specific) data type if available.
int	getSQLType()	Get JDBC Types value.
int	getSQLType(Configuration configuration)	Get the dialect-specific JDBC Types value.
Class<T>	getType()	Retrieve the Java type associated with this data type.
static Class<?>	getType(SQLDialect dialect, String t, int p, int s)	Convert a type name (using precision and scale) into a Java class
String	getTypeName()	Retrieve the dialect-specific type name associated with this data type.
String	getTypeName(Configuration configuration)	Retrieve the dialect-specific type name associated with this data type.
Name	getUnqualifiedName()	The unqualified name of this object.
int	hashCode()	Generate a hash code from this QueryPart.
boolean	hasLength()	Whether this data type has a length.
boolean	hasPrecision()	Whether this data type has a precision.
boolean	hasScale()	Whether this data type has a scale.
boolean	identity()	Get the identity flag of this data type.
DataType<T>	identity(boolean i)	Return a new data type like this, with a new identity flag.
boolean	isArray()	Whether this data type is an array type.
boolean	isBinary()	Whether this data type is any binary type.
boolean	isDate()	Whether this data type is any date type.
boolean	isDateTime()	Whether this data type is any date or time type.
boolean	isEmbeddable()	Whether this data type is an embeddable type.
boolean	isEnum()	Whether this data type is an enum type.
boolean	isInteger()	Whether this data type is any integer data type.
boolean	isInterval()	Whether this data type is any interval type.
boolean	isJSON()	Whether this data type is a JSON type.
boolean	isLob()	Whether this data type is best deserialised as a LOB.
boolean	isMultiset()	Whether this data type is a nested collection type.
boolean	isNString()	Whether this data type is any national character data type.
boolean	isNumeric()	Whether this data type is any numeric data type.
boolean	isRecord()	Whether this data type is a nested record type.
boolean	isString()	Whether this data type is any character data type.
boolean	isTemporal()	Whether this data type is any date or time type.
boolean	isTime()	Whether this data type is any time type.
boolean	isTimestamp()	Whether this data type is any timestamp type.
boolean	isUDT()	Whether this data type is a UDT type.
boolean	isXML()	Whether this data type is an XML type.
int	length()	Get the length of this data type.
DataType<T>	length(int l)	Return a new data type like this, with a new length value.
boolean	lengthDefined()	Whether the precision returned by DataType.length() is defined.
static String	normalise(String typeName)
DataType<T>	notNull()	Synonym for DataType.nullable(boolean), passing false as an argument.
DataType<T>	null_()	Synonym for DataType.nullable(boolean), passing true as an argument.
Nullability	nullability()	Get the nullability of this data type.
DataType<T>	nullability(Nullability n)	Return a new data type like this, with a new nullability.
boolean	nullable()	Get the nullability of this data type.
DataType<T>	nullable(boolean n)	Return a new data type like this, with a new nullability.
int	precision()	Get the precision of this data type.
DataType<T>	precision(int p)	Return a new data type like this, with a new precision value.
DataType<T>	precision(int p, int s)	Return a new data type like this, with a new precision and scale value.
boolean	precisionDefined()	Whether the precision returned by DataType.precision() is defined.
boolean	rendersContent(Context<?> ctx)	Subclasses may override this
int	scale()	Get the scale of this data type.
DataType<T>	scale(int s)	Return a new data type like this, with a new scale value.
boolean	scaleDefined()	Whether the precision returned by DataType.scale() is defined.
String	toString()	Render a SQL string representation of this QueryPart.
protected DataAccessException	translate(String sql, SQLException e)	Internal convenience method

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jooq.DataType

asConvertedDataType, asConvertedDataTypeFrom, asConvertedDataTypeFrom, asConvertedDataTypeTo, asConvertedDataTypeTo

Methods inherited from interface org.jooq.Named

getComment, getCommentPart, getName, getQualifiedName, getUnqualifiedName

Constructor Details

DefaultDataType

public DefaultDataType(SQLDialect dialect,
 DataType<T> sqlDataType,
 String typeName)

DefaultDataType

public DefaultDataType(SQLDialect dialect,
 DataType<T> sqlDataType,
 String typeName,
 String castTypeName)

DefaultDataType

public DefaultDataType(SQLDialect dialect,
 Class<T> type,
 String typeName)

DefaultDataType

public DefaultDataType(SQLDialect dialect,
 Class<T> type,
 String typeName,
 String castTypeName)

Method Details

nullability

public final Nullability nullability()

Description copied from interface: DataType

Get the nullability of this data type.

Returns:

The nullability

collation

public final Collation collation()

Description copied from interface: DataType

Get the collation of this data type, or null if there is no collation, or if the default collation applies.

characterSet

public final CharacterSet characterSet()

Description copied from interface: DataType

Get the character set of this data type, or null if there is no character set, or if the default character set applies.

identity

public final boolean identity()

Description copied from interface: DataType

Get the identity flag of this data type.

Returns:

The identity flag.

default_

public final Field<T> default_()

Description copied from interface: DataType

The expression to be applied as the DEFAULT value for this data type.

Returns:

The default value if present, or null if no default value is specified for this data type.

See Also:

DataType.defaultValue(Field)

getSQLDataType

public final DataType<T> getSQLDataType()

Description copied from interface: DataType

Get the standard SQL data type of this (dialect-specific) data type if available.

getDataType

public final DataType<T> getDataType(Configuration configuration)

Description copied from interface: DataType

The dialect-specific data type representing this data type.

getType

public final Class<T> getType()

Description copied from interface: DataType

Retrieve the Java type associated with this data type.

getBinding

public final Binding<?,T> getBinding()

Description copied from interface: DataType

Get the data type binding associated with this data type.

getDialect

public final SQLDialect getDialect()

Description copied from interface: DataType

Retrieve the underlying SQLDialect.

getDefaultDataType

public static final DataType<Object> getDefaultDataType(String typeName)

getDefaultDataType

public static final DataType<Object> getDefaultDataType(SQLDialect dialect,
 String typeName)

getDataType

public static final DataType<?> getDataType(SQLDialect dialect,
 String typeName)

getDataType

public static final DataType<?> getDataType(SQLDialect dialect,
 SQLType sqlType)

getDataType

public static final DataType<?> getDataType(SQLDialect dialect,
 int sqlType)

getDataType

public static final <T> DataType<T> getDataType(SQLDialect dialect,
 Class<T> type)

getDataType

public static final <T> DataType<T> getDataType(SQLDialect dialect,
 Class<T> type,
 DataType<T> fallbackDataType)

normalise

public static final String normalise(String typeName)

Returns:

The type name without all special characters and white spaces

getDataType

public static final DataType<?> getDataType(SQLDialect dialect,
 String t,
 int p,
 int s)
                                     throws SQLDialectNotSupportedException

Convert a type name (using precision and scale) into a Java class

Throws:

SQLDialectNotSupportedException

getDataType

public static final DataType<?> getDataType(SQLDialect dialect,
 String t,
 int p,
 int s,
 boolean forceIntegerTypesOnZeroScaleDecimals)
                                     throws SQLDialectNotSupportedException

Convert a type name (using precision and scale) into a Java class

Throws:

SQLDialectNotSupportedException

getType

public static final Class<?> getType(SQLDialect dialect,
 String t,
 int p,
 int s)
                              throws SQLDialectNotSupportedException

Convert a type name (using precision and scale) into a Java class

Throws:

SQLDialectNotSupportedException

nullability

public final DataType<T> nullability(Nullability n)

Description copied from interface: DataType

Return a new data type like this, with a new nullability.

[#5709] A nullable column cannot have an DataType.identity().

Specified by:

nullability in interface DataType<T>

Parameters:

n - The new nullability

Returns:

The new data type

collation

public final DataType<T> collation(Collation c)

Description copied from interface: DataType

Return a new data type like this, with a new collation.

Specified by:

collation in interface DataType<T>

characterSet

public final DataType<T> characterSet(CharacterSet c)

Description copied from interface: DataType

Return a new data type like this, with a new character set.

Specified by:

characterSet in interface DataType<T>

identity

public final DataType<T> identity(boolean i)

Description copied from interface: DataType

Return a new data type like this, with a new identity flag.

[#5709] The IDENTITY flag imposes a NOT NULL constraint, and removes all DEFAULT values.

Specified by:

identity in interface DataType<T>

Parameters:

i - The new identity flag

Returns:

The new data type

default_

public final DataType<T> default_(Field<T> d)

Description copied from interface: DataType

Specify an expression to be applied as the DEFAULT value for this data type.

A default value of a data type applies to DDL statements, such as

• CREATE TABLE
• ALTER TABLE

The distinct types of possible DEFAULT expressions is defined by the underlying database. Please refer to your database manual to learn what expressions are possible.

Specified by:

default_ in interface DataType<T>

nullable

public final DataType<T> nullable(boolean n)

Description copied from interface: DataType

Return a new data type like this, with a new nullability.

This is the same as calling DataType.nullability(Nullability) with any of Nullability.NULL or Nullability.NOT_NULL as an argument.

[#5709] A nullable column cannot have an DataType.identity().

Specified by:

nullable in interface DataType<T>

Parameters:

n - The new nullability

Returns:

The new data type

nullable

public final boolean nullable()

Description copied from interface: DataType

Get the nullability of this data type.

This returns true by default, i.e. if DataType.nullability() is Nullability.DEFAULT.

Specified by:

nullable in interface DataType<T>

Returns:

The nullability

null_

public final DataType<T> null_()

Description copied from interface: DataType

Synonym for DataType.nullable(boolean), passing true as an argument.

Specified by:

null_ in interface DataType<T>

notNull

public final DataType<T> notNull()

Description copied from interface: DataType

Synonym for DataType.nullable(boolean), passing false as an argument.

Specified by:

notNull in interface DataType<T>

defaultValue

public final DataType<T> defaultValue(T d)

Description copied from interface: DataType

Specify an expression to be applied as the DEFAULT value for this data type.

[#5709] A defaulted column cannot have an DataType.identity().

This is an alias for DataType.default_(Object).

Specified by:

defaultValue in interface DataType<T>

See Also:

DataType.defaultValue(Field)

defaultValue

public final DataType<T> defaultValue(Field<T> d)

Description copied from interface: DataType

Specify an expression to be applied as the DEFAULT value for this data type.

A default value of a data type applies to DDL statements, such as

• CREATE TABLE
• ALTER TABLE

The distinct types of possible DEFAULT expressions is defined by the underlying database. Please refer to your database manual to learn what expressions are possible.

This is an alias for DataType.default_(Field).

Specified by:

defaultValue in interface DataType<T>

defaultValue

public final Field<T> defaultValue()

Description copied from interface: DataType

The expression to be applied as the DEFAULT value for this data type.

This is an alias for DataType.default_().

Specified by:

defaultValue in interface DataType<T>

Returns:

The default value if present, or null if no default value is specified for this data type.

See Also:

DataType.defaultValue(Field)

default_

public final DataType<T> default_(T d)

Description copied from interface: DataType

Specify an expression to be applied as the DEFAULT value for this data type.

[#5709] A defaulted column cannot have an DataType.identity().

Specified by:

default_ in interface DataType<T>

See Also:

DataType.defaultValue(Field)

defaulted

@Deprecated
public final DataType<T> defaulted(boolean d)

Deprecated.

Description copied from interface: DataType

Return a new data type like this, with a new defaultability.

Specified by:

defaulted in interface DataType<T>

Parameters:

d - The new defaultability

Returns:

The new data type

defaulted

public final boolean defaulted()

Description copied from interface: DataType

Get the defaultability of this data type.

Specified by:

defaulted in interface DataType<T>

Returns:

The defaultability

precision

public final int precision()

Description copied from interface: DataType

Get the precision of this data type.

Specified by:

precision in interface DataType<T>

Returns:

The precision of this data type

precision

public final DataType<T> precision(int p)

Description copied from interface: DataType

Return a new data type like this, with a new precision value.

This will have no effect if DataType.hasPrecision() is false

This is the same as calling DataType.precision(int, int) with scale == 0

Specified by:

precision in interface DataType<T>

Parameters:

p - The new precision value

Returns:

The new data type

precision

public final DataType<T> precision(int p,
 int s)

Description copied from interface: DataType

Return a new data type like this, with a new precision and scale value.

This will have no effect if DataType.hasPrecision() is false , or if scale > 0 and DataType.hasScale() is false

Specified by:

precision in interface DataType<T>

Parameters:

p - The new precision value

s - The new scale value

Returns:

The new data type

hasPrecision

public final boolean hasPrecision()

Description copied from interface: DataType

Whether this data type has a precision.

Specified by:

hasPrecision in interface DataType<T>

Returns:

Whether this data type has a precision

precisionDefined

public final boolean precisionDefined()

Description copied from interface: DataType

Whether the precision returned by DataType.precision() is defined.

The default precision is 0 for all data types. If a data type does not have a precision (see DataType.hasPrecision()), or if it was initialised without precision (e.g. SQLDataType.TIMESTAMP), then the precision is not defined.

Specified by:

precisionDefined in interface DataType<T>

scale

public final int scale()

Description copied from interface: DataType

Get the scale of this data type.

Specified by:

scale in interface DataType<T>

Returns:

The scale of this data type

scale

public final DataType<T> scale(int s)

Description copied from interface: DataType

Return a new data type like this, with a new scale value.

This will have no effect if DataType.hasScale() is false

Specified by:

scale in interface DataType<T>

Parameters:

s - The new scale value

Returns:

The new data type

hasScale

public final boolean hasScale()

Description copied from interface: DataType

Whether this data type has a scale.

Specified by:

hasScale in interface DataType<T>

Returns:

Whether this data type has a scale

scaleDefined

public final boolean scaleDefined()

Description copied from interface: DataType

Whether the precision returned by DataType.scale() is defined.

The default scale is 0 for all data types. If a data type does not have a scale (see DataType.hasScale()), or if it was initialised without scale (e.g. SQLDataType.TIMESTAMP), then the scale is not defined.

Specified by:

scaleDefined in interface DataType<T>

length

public final DataType<T> length(int l)

Description copied from interface: DataType

Return a new data type like this, with a new length value.

This will have no effect if DataType.hasLength() is false

Specified by:

length in interface DataType<T>

Parameters:

l - The new length value

Returns:

The new data type

length

public final int length()

Description copied from interface: DataType

Get the length of this data type.

Specified by:

length in interface DataType<T>

Returns:

The length of this data type

hasLength

public final boolean hasLength()

Description copied from interface: DataType

Whether this data type has a length.

Specified by:

hasLength in interface DataType<T>

Returns:

Whether this data type has a length

lengthDefined

public final boolean lengthDefined()

Description copied from interface: DataType

Whether the precision returned by DataType.length() is defined.

The default length is 0 for all data types. If a data type does not have a length (see DataType.hasLength()), or if it was initialised without length (e.g. SQLDataType.TIMESTAMP), then the length is not defined.

Specified by:

lengthDefined in interface DataType<T>

getSQLType

public int getSQLType()

Description copied from interface: DataType

Get JDBC Types value.

Specified by:

getSQLType in interface DataType<T>

getSQLType

public final int getSQLType(Configuration configuration)

Description copied from interface: DataType

Get the dialect-specific JDBC Types value.

Specified by:

getSQLType in interface DataType<T>

getDomain

public Domain<T> getDomain()

Description copied from interface: DataType

Get the defining DOMAIN type or NULL if there is no such type.

Specified by:

getDomain in interface DataType<T>

getConverter

public final Converter<?,T> getConverter()

Description copied from interface: DataType

Get the converter associated with this data type.

Specified by:

getConverter in interface DataType<T>

getTypeName

public String getTypeName()

Description copied from interface: DataType

Retrieve the dialect-specific type name associated with this data type.

Specified by:

getTypeName in interface DataType<T>

getTypeName

public String getTypeName(Configuration configuration)

Description copied from interface: DataType

Retrieve the dialect-specific type name associated with this data type.

Specified by:

getTypeName in interface DataType<T>

getCastTypeName

public String getCastTypeName()

Description copied from interface: DataType

Retrieve the dialect-specific type name associated with this data type used for casting.

This is useful for some dialects that have specialised type names for cast expressions. Other dialects require type-length binding when casting, (e.g. VARCHAR(32767))

Specified by:

getCastTypeName in interface DataType<T>

getCastTypeName

public String getCastTypeName(Configuration configuration)

Description copied from interface: DataType

Retrieve the dialect-specific type name associated with this data type used for casting.

This is useful for some dialects that have specialised type names for cast expressions. Other dialects require type-length binding when casting, (e.g. VARCHAR(32767))

Specified by:

getCastTypeName in interface DataType<T>

getArrayType

public final Class<T[]> getArrayType()

Description copied from interface: DataType

Retrieve the Java type associated with ARRAYs of this data type.

Specified by:

getArrayType in interface DataType<T>

getArrayDataType

public DataType<T[]> getArrayDataType()

Description copied from interface: DataType

Retrieve the data type for an ARRAY of this data type.

Specified by:

getArrayDataType in interface DataType<T>

getArrayComponentType

public Class<?> getArrayComponentType()

Description copied from interface: DataType

Retrieve the Java component type if this is an ARRAY type, or null, otherwise.

Specified by:

getArrayComponentType in interface DataType<T>

getArrayComponentDataType

public DataType<?> getArrayComponentDataType()

Description copied from interface: DataType

Retrieve the Java component data type if this is an ARRAY type, or null, otherwise.

Specified by:

getArrayComponentDataType in interface DataType<T>

getRow

public Row getRow()

Description copied from interface: DataType

Get the nested record's Row definition, if this is a DataType.isRecord(), or a DataType.isMultiset(), or NULL otherwise.

Specified by:

getRow in interface DataType<T>

getRecordType

public Class<? extends Record> getRecordType()

Description copied from interface: DataType

Get the nested record's record type definition, if this is a DataType.isRecord(), or a DataType.isMultiset(), or NULL otherwise.

Specified by:

getRecordType in interface DataType<T>

asArrayDataType

@Pro
public final <A extends ArrayRecord<?>> DataType<A> asArrayDataType(Class<A> arrayDataType)

Description copied from interface: DataType

Retrieve the data type for an Oracle-style ARRAY of this data type.

Specified by:

asArrayDataType in interface DataType<T>

asEnumDataType

public final <E extends EnumType> DataType<E> asEnumDataType(Class<E> enumDataType)

Description copied from interface: DataType

Retrieve the data type for a given enum data type.

Specified by:

asEnumDataType in interface DataType<T>

asConvertedDataType

public <U> DataType<U> asConvertedDataType(Converter<? super T,U> converter)

Description copied from interface: DataType

Retrieve the data type for a given converter.

Specified by:

asConvertedDataType in interface DataType<T>

asConvertedDataType

public <U> DataType<U> asConvertedDataType(Binding<? super T,U> newBinding)

Description copied from interface: DataType

Retrieve the data type for a given binding.

Specified by:

asConvertedDataType in interface DataType<T>

convert

public T convert(Object object)

Description copied from interface: DataType

Convert an arbitrary object into <T>.

See Convert#convert(Object, Class) for details about conversion rules. Notice this does not pass through any Configuration.converterProvider().

Specified by:

convert in interface DataType<T>

Parameters:

object - The object to be converted

Returns:

The converted object

convert

public final T[] convert(Object... objects)

Description copied from interface: DataType

Convert an arbitrary set of objects into <T>.

See Convert#convert(Object, Class) for details about conversion rules. Notice this does not pass through any Configuration.converterProvider().

Specified by:

convert in interface DataType<T>

Parameters:

objects - The objects to be converted

Returns:

The converted objects

convert

public final List<T> convert(Collection<?> objects)

Description copied from interface: DataType

Convert an arbitrary set of objects into <T>.

See Convert#convert(Object, Class) for details about conversion rules. Notice this does not pass through any Configuration.converterProvider().

Specified by:

convert in interface DataType<T>

Parameters:

objects - The objects to be converted

Returns:

The converted objects

isNumeric

public final boolean isNumeric()

Description copied from interface: DataType

Whether this data type is any numeric data type.

This applies to any of these types:

• SQLDataType.TINYINT
• SQLDataType.SMALLINT
• SQLDataType.INTEGER
• SQLDataType.BIGINT
• SQLDataType.FLOAT
• SQLDataType.DOUBLE
• SQLDataType.REAL
• SQLDataType.DECIMAL
• SQLDataType.DECIMAL_INTEGER
• SQLDataType.NUMERIC

Specified by:

isNumeric in interface DataType<T>

See Also:

DataType.isNumeric()

isInteger

public final boolean isInteger()

Description copied from interface: DataType

Whether this data type is any integer data type.

This applies to any of these types:

• SQLDataType.TINYINT
• SQLDataType.SMALLINT
• SQLDataType.INTEGER
• SQLDataType.BIGINT

Specified by:

isInteger in interface DataType<T>

isString

public final boolean isString()

Description copied from interface: DataType

Whether this data type is any character data type.

This applies to any of these types:

• SQLDataType.CHAR
• SQLDataType.CLOB
• SQLDataType.LONGNVARCHAR
• SQLDataType.LONGVARCHAR
• SQLDataType.NCHAR
• SQLDataType.NCLOB
• SQLDataType.NVARCHAR
• SQLDataType.VARCHAR

Specified by:

isString in interface DataType<T>

isNString

public final boolean isNString()

Description copied from interface: DataType

Whether this data type is any national character data type.

This applies to any of these types:

• SQLDataType.LONGNVARCHAR
• SQLDataType.NCHAR
• SQLDataType.NCLOB
• SQLDataType.NVARCHAR

Specified by:

isNString in interface DataType<T>

isDateTime

public final boolean isDateTime()

Description copied from interface: DataType

Whether this data type is any date or time type.

This applies to any of these types.

• SQLDataType.DATE
• SQLDataType.TIME
• SQLDataType.TIMESTAMP
• SQLDataType.LOCALDATE
• SQLDataType.LOCALTIME
• SQLDataType.LOCALDATETIME
• SQLDataType.OFFSETTIME
• SQLDataType.OFFSETDATETIME
• SQLDataType.INSTANT

Specified by:

isDateTime in interface DataType<T>

See Also:

DataType.isDate()

isDate

public final boolean isDate()

Description copied from interface: DataType

Whether this data type is any date type.

This applies to any of these types.

• SQLDataType.DATE
• SQLDataType.LOCALDATE

Specified by:

isDate in interface DataType<T>

isTimestamp

public final boolean isTimestamp()

Description copied from interface: DataType

Whether this data type is any timestamp type.

This applies to any of these types.

• SQLDataType.TIMESTAMP
• SQLDataType.LOCALDATETIME

Specified by:

isTimestamp in interface DataType<T>

isTime

public final boolean isTime()

Description copied from interface: DataType

Whether this data type is any time type.

This applies to any of these types.

• SQLDataType.TIME
• SQLDataType.LOCALTIME

Specified by:

isTime in interface DataType<T>

isTemporal

public final boolean isTemporal()

Description copied from interface: DataType

Whether this data type is any date or time type.

This applies to any of these types.

• SQLDataType.DATE
• SQLDataType.TIME
• SQLDataType.TIMESTAMP
• SQLDataType.LOCALDATE
• SQLDataType.LOCALTIME
• SQLDataType.LOCALDATETIME
• SQLDataType.OFFSETTIME
• SQLDataType.OFFSETDATETIME
• YearToSecond
• YearToMonth
• DayToSecond

This is a combination of DataType.isDateTime() or DataType.isInterval()

Specified by:

isTemporal in interface DataType<T>

isInterval

public final boolean isInterval()

Description copied from interface: DataType

Whether this data type is any interval type.

This applies to any of these types.

• YearToSecond
• YearToMonth
• DayToSecond

Specified by:

isInterval in interface DataType<T>

isLob

public final boolean isLob()

Description copied from interface: DataType

Whether this data type is best deserialised as a LOB.

This applies to any of these types.

• SQLDataType.BLOB
• SQLDataType.CLOB
• SQLDataType.NCLOB

Specified by:

isLob in interface DataType<T>

isBinary

public final boolean isBinary()

Description copied from interface: DataType

Whether this data type is any binary type.

This applies to any of these types.

• SQLDataType.BINARY
• SQLDataType.BLOB
• SQLDataType.LONGVARBINARY
• SQLDataType.VARBINARY

Specified by:

isBinary in interface DataType<T>

isArray

public final boolean isArray()

Description copied from interface: DataType

Whether this data type is an array type.

Specified by:

isArray in interface DataType<T>

isEmbeddable

public final boolean isEmbeddable()

Description copied from interface: DataType

Whether this data type is an embeddable type.

Specified by:

isEmbeddable in interface DataType<T>

isUDT

public final boolean isUDT()

Description copied from interface: DataType

Whether this data type is a UDT type.

Specified by:

isUDT in interface DataType<T>

isRecord

public boolean isRecord()

Description copied from interface: DataType

Whether this data type is a nested record type.

This is true for anonymous, structural nested record types constructed with DSL.row(SelectField...) or for nominal nested record types, such as DataType.isUDT() or DataType.isEmbeddable().

Specified by:

isRecord in interface DataType<T>

isMultiset

public boolean isMultiset()

Description copied from interface: DataType

Whether this data type is a nested collection type.

This is true for anonymous, structural nested collection types constructed with DSL.multiset(Select) or DSL.multisetAgg(Field...).

Specified by:

isMultiset in interface DataType<T>

isEnum

public final boolean isEnum()

Description copied from interface: DataType

Whether this data type is an enum type.

Specified by:

isEnum in interface DataType<T>

isJSON

public final boolean isJSON()

Description copied from interface: DataType

Whether this data type is a JSON type.

Specified by:

isJSON in interface DataType<T>

isXML

public final boolean isXML()

Description copied from interface: DataType

Whether this data type is an XML type.

Specified by:

isXML in interface DataType<T>

accept

public final void accept(Context<?> ctx)

Description copied from interface: QueryPartInternal

This QueryPart can accept a Context object in order to render a SQL string or to bind its variables.

Specified by:

accept in interface QueryPartInternal

toString

public String toString()

Description copied from interface: QueryPart

Render a SQL string representation of this QueryPart.

For improved debugging, this renders a SQL string of this QueryPart with inlined bind variables. If this QueryPart is Attachable, then the attached Configuration may be used for rendering the SQL string, including SQLDialect and Settings. Do note that most QueryPart instances are not attached to a Configuration, and thus there is no guarantee that the SQL string will make sense in the context of a specific database.

Specified by:

toString in interface QueryPart

Returns:

A SQL string representation of this QueryPart

hashCode

public int hashCode()

Description copied from interface: QueryPart

Generate a hash code from this QueryPart.

In general, QueryPart hash codes are the same as the hash codes generated from QueryPart.toString(). This guarantees consistent behaviour with QueryPart.equals(Object)

Some QueryPart implementations may choose to override this behaviour for improved performance, as QueryPart.toString() is an expensive operation, if called many times.

Specified by:

hashCode in interface QueryPart

Returns:

The QueryPart hash code

equals

public boolean equals(Object obj)

Description copied from interface: QueryPart

Check whether this QueryPart can be considered equal to another QueryPart.

In general, QueryPart equality is defined in terms of QueryPart.toString() equality. In other words, two query parts are considered equal if their rendered SQL (with inlined bind variables) is equal. This means that the two query parts do not necessarily have to be of the same type.

Some QueryPart implementations may choose to override this behaviour for improved performance, as QueryPart.toString() is an expensive operation, if called many times.

Specified by:

equals in interface QueryPart

Parameters:

obj - The other QueryPart

Returns:

Whether the two query parts are equal

getName

public final String getName()

Description copied from interface: Named

The unqualified name of this object.

Specified by:

getName in interface Named

getQualifiedName

public Name getQualifiedName()

Description copied from interface: Named

The qualified name of this object.

Specified by:

getQualifiedName in interface Named

getUnqualifiedName

public final Name getUnqualifiedName()

Description copied from interface: Named

The unqualified name of this object.

Specified by:

getUnqualifiedName in interface Named

getComment

public final String getComment()

Description copied from interface: Named

The comment on this object.

This is the same as calling Named.getCommentPart() and then Comment.getComment().

Specified by:

getComment in interface Named

getCommentPart

public final Comment getCommentPart()

Description copied from interface: Named

The comment on this object as a QueryPart.

Specified by:

getCommentPart in interface Named

clauses

@Deprecated
public Clause[] clauses(Context<?> ctx)

Deprecated.

- 3.11.0 - [#8179] - This functionality will be removed in the future.

Description copied from interface: QueryPartInternal

The Clauses that are represented by this query part.

QueryParts can specify several Clauses for which an event will be emitted before (in forward order) and after (in reverse order) visiting the the query part through Context.visit(QueryPart)

This method is for JOOQ INTERNAL USE only. Do not reference directly

Specified by:

clauses in interface QueryPartInternal

Returns:

The Clauses represented by this query part or null or an empty array if this query part does not represent a clause.

rendersContent

public boolean rendersContent(Context<?> ctx)

Subclasses may override this

Specified by:

rendersContent in interface QueryPartInternal

declaresFields

public boolean declaresFields()

Subclasses may override this

Specified by:

declaresFields in interface QueryPartInternal

declaresTables

public boolean declaresTables()

Subclasses may override this

Specified by:

declaresTables in interface QueryPartInternal

declaresWindows

public boolean declaresWindows()

Subclasses may override this

Specified by:

declaresWindows in interface QueryPartInternal

declaresCTE

public boolean declaresCTE()

Subclasses may override this

Specified by:

declaresCTE in interface QueryPartInternal

declaresParameters

@Pro
public boolean declaresParameters()

Subclasses may override this

Specified by:

declaresParameters in interface QueryPartInternal

generatesCast

public boolean generatesCast()

Subclasses may override this

Specified by:

generatesCast in interface QueryPartInternal

create

@Deprecated
protected final DSLContext create()

Deprecated.

- 3.11.0 - [#6722] - Use Attachable.configuration() and Configuration.dsl() instead.

Internal convenience method

create

@Deprecated
protected final DSLContext create(Configuration configuration)

Deprecated.

- 3.11.0 - [#6722] - Use Attachable.configuration() and Configuration.dsl() instead.

Internal convenience method

create

@Deprecated
protected final DSLContext create(Context<?> ctx)

Deprecated.

- 3.11.0 - [#6722] - Use Attachable.configuration() and Configuration.dsl() instead.

Internal convenience method

translate

protected final DataAccessException translate(String sql,
 SQLException e)

Internal convenience method