Module org.jooq

Package org.jooq.impl

Class BuiltInDataType<T>

java.lang.Object

org.jooq.impl.DefaultDataType<T>

org.jooq.impl.BuiltInDataType<T>

All Implemented Interfaces:

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

@Internal
public class BuiltInDataType<T>
extends DefaultDataType<T>

An internal marker subtype of DefaultDataType, to be used only by built-in data types in SQLDataType and dialect specific data type classes, such as e.g. PostgresDataType.

Author:

Lukas Eder

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
BuiltInDataType(Class<T> type, String typeName)	Constructor for SQLDataType types.
BuiltInDataType(SQLDialect dialect, DataType<T> sqlDataType, String typeName)	Constructor for dialect specific data types.
BuiltInDataType(SQLDialect dialect, DataType<T> sqlDataType, String typeName, String castTypeName)	Constructor for dialect specific data types.

Method Summary

Modifier and Type	Method	Description
final Name	$name()	Experimental query object model accessor method, see also QOM.
default QueryPart	$replace(Replacer replacer)	Traverse a QueryPart hierarchy and recursively replace its elements by alternatives.
default <R> R	$traverse(Traverser<?,R> traverser)	Traverser this QueryPart expression tree using a composable Traverser, producing a result.
final void	accept(Context<?> ctx)	This QueryPart can accept a Context object in order to render a SQL string or to bind its variables.
final DataType<T[]>	array()	A convenient short for form DataType.getArrayDataType() for DSL usage
final <A extends ArrayRecord<?>> DataType<A>	asArrayDataType(Class<A> arrayDataType)	Retrieve the data type for an Oracle-style ARRAY of this data type.
final <A extends AssociativeArrayRecord<?, ?>> DataType<A>	asAssociativeArrayDataType(Class<A> arrayDataType)	Retrieve the data type for an Oracle-style associative 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.
final <E extends EnumType> DataType<E>	asEnumDataType(Class<E> enumDataType)	Retrieve the data type for a given enum data type.
final DataType<T>	autoIncrement()	Return a new data type like this, with the DataType.identity(boolean) flag set to true.
final 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.
final DataType<T>	collation(Collation c)	Return a new data type like this, with a new collation.
final boolean	computed()	Whether this column is computed.
final boolean	computedOnClient()	Whether this column is computed on the client.
final boolean	computedOnClient(Configuration configuration)	Whether this column is computed on the client.
final boolean	computedOnClientStored()	Whether this column is computed on the client.
final boolean	computedOnClientStored(Configuration configuration)	Whether this column is computed on the client.
final boolean	computedOnClientStoredOn(GeneratorStatementType statementType)	Whether this column is computed on the client.
final boolean	computedOnClientStoredOn(GeneratorStatementType statementType, Configuration configuration)	Whether this column is computed on the client.
final boolean	computedOnClientVirtual()	Whether this column is computed on the client.
final boolean	computedOnClientVirtual(Configuration configuration)	Whether this column is computed on the client.
final boolean	computedOnServer()	Whether this column is computed on the server.
final boolean	computedOnServer(Configuration configuration)	Whether this column is computed on the server.
final T	convert(Object object)	Convert an arbitrary object into <T>.
final T[]	convert(Object... objects)	Convert an arbitrary set of objects into <T>.
final List<T>	convert(Collection<?> objects)	Convert an arbitrary set of objects into <T>.
protected final DSLContext	create()	Deprecated. - 3.11.0 - [#6722] - Use Attachable.configuration() and Configuration.dsl() instead.
protected final DSLContext	create(Configuration configuration)	Deprecated. - 3.11.0 - [#6722] - Use Attachable.configuration() and Configuration.dsl() instead.
protected final 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
final DataType<T>	default_(Field<T> d)	Specify an expression to be applied as the DEFAULT value for this data type.
final DataType<T>	default_(T d)	Specify an expression to be applied as the DEFAULT value for this data type.
final boolean	defaulted()	Get the defaultability of this data type.
final Field<T>	defaultValue()	The expression to be applied as the DEFAULT value for this data type.
final DataType<T>	defaultValue(Field<T> d)	Specify an expression to be applied as the DEFAULT value for this data type.
final 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.
final Field<T>	generatedAlwaysAs()	Get the computed column expression of this data type, if any.
final DataType<T>	generatedAlwaysAs(Field<T> generatedAlwaysAsValue)	Set the computed column expression of this data type to a constant expression.
final DataType<T>	generatedAlwaysAs(Generator<?,?,T> g)	Set the computed column expression of this data type to a dynamic expression.
final DataType<T>	generatedAlwaysAs(T g)	Set the computed column expression of this data type to a constant value.
final DataType<T>	generatedByDefaultAsIdentity()	Return a new data type like this, with the DataType.identity(boolean) flag set to true.
boolean	generatesCast()	Subclasses may override this
final DataType<T>	generationLocation(QOM.GenerationLocation g)	Set the DataType.generationLocation() of the computed column expression.
final DataType<T>	generationOption(QOM.GenerationOption g)	Set the DataType.generationOption() of the computed column expression.
DataType<?>	getArrayBaseDataType()	Retrieve the Java component data type if this is an ARRAY type, or this, otherwise.
Class<?>	getArrayBaseType()	Retrieve the Java base type if this is an ARRAY type, or DataType.getType(), otherwise.
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.
final Class<T[]>	getArrayType()	Retrieve the Java type associated with ARRAYs of 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.
final String	getComment()	The comment on this object.
final Comment	getCommentPart()	The comment on this object as a QueryPart.
final ContextConverter<?,T>	getConverter()	Get the converter associated with this data type.
Domain<T>	getDomain()	Get the defining DOMAIN type or NULL if there is no such type.
final 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.
int	getSQLType()	Get JDBC Types value.
final int	getSQLType(Configuration configuration)	Get the dialect-specific JDBC Types value.
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.
final Name	getUnqualifiedName()	The unqualified name of this object.
final boolean	hasFixedLength()	Whether this data type has a fixed length.
int	hashCode()	Generate a hash code from this QueryPart.
final boolean	hasLength()	Whether this data type has a length.
final boolean	hasPrecision()	Whether this data type has a precision.
final boolean	hasScale()	Whether this data type has a scale.
final DataType<T>	hidden(boolean h)	Return a new data type like this, with a new hidden attribute.
final DataType<T>	identity(boolean i)	Return a new data type like this, with a new identity flag.
final boolean	isArray()	Whether this data type is an array type.
final boolean	isAssociativeArray()	Whether this data type is an array type.
final boolean	isBinary()	Whether this data type is any binary type.
final boolean	isBoolean()	Whether this data type is any boolean data type.
final boolean	isDate()	Whether this data type is any date type.
final boolean	isDateTime()	Whether this data type is any date or time type.
final boolean	isDecimal()	Whether this data type is any decimal numeric data type.
final boolean	isEmbeddable()	Whether this data type is an embeddable type.
final boolean	isEnum()	Whether this data type is an enum type.
final boolean	isFloat()	Whether this data type is any floating point data type.
final boolean	isInteger()	Whether this data type is any integer data type.
final boolean	isInterval()	Whether this data type is any interval type.
final boolean	isJSON()	Whether this data type is a JSON type.
final boolean	isLob()	Whether this data type is best deserialised as a LOB.
boolean	isMultiset()	Whether this data type is a nested collection type.
final boolean	isNString()	Whether this data type is any national character data type.
final boolean	isNumeric()	Whether this data type is any numeric data type.
final boolean	isOther()	Whether this data type is an OTHER type.
boolean	isRecord()	Whether this data type is a nested record type.
final boolean	isSpatial()	Whether this data type is a spatial type.
final boolean	isString()	Whether this data type is any character data type.
final boolean	isTemporal()	Whether this data type is any date or time type.
final boolean	isTime()	Whether this data type is any time type.
final boolean	isTimestamp()	Whether this data type is any timestamp type.
final boolean	isTimestampWithTimeZone()	Whether this data type is any timestamp type.
final boolean	isTimeWithTimeZone()	Whether this data type is any time type.
final boolean	isUDT()	Whether this data type is a UDT type.
final boolean	isUUID()	Whether this data type is a UUID type.
final boolean	isXML()	Whether this data type is an XML type.
final int	length()	Get the length of this data type.
final DataType<T>	length(int l)	Return a new data type like this, with a new length value.
final boolean	lengthDefined()	Whether the precision returned by DataType.length() is defined.
final DataType<T>	notNull()	Synonym for DataType.nullable(boolean), passing false as an argument.
final DataType<T>	null_()	Synonym for DataType.nullable(boolean), passing true as an argument.
final DataType<T>	nullability(Nullability n)	Return a new data type like this, with a new nullability.
final boolean	nullable()	Get the nullability of this data type.
final DataType<T>	nullable(boolean n)	Return a new data type like this, with a new nullability.
final int	precision()	Get the precision of this data type.
final DataType<T>	precision(int p)	Return a new data type like this, with a new precision value.
final DataType<T>	precision(int p, int s)	Return a new data type like this, with a new precision and scale value.
final boolean	precisionDefined()	Whether the precision returned by DataType.precision() is defined.
final DataType<T>	readonly(boolean r)	Return a new data type like this, with a new readonly attribute.
final boolean	readonlyInternal()	Get the readonly attribute of this data type, combined with other flags that influence readonly behaviour.
final boolean	readonlyInternal(Configuration configuration)	Get the readonly attribute of this data type, combined with other flags that influence readonly behaviour.
boolean	rendersContent(Context<?> ctx)	Subclasses may override this
final int	scale()	Get the scale of this data type.
final DataType<T>	scale(int s)	Return a new data type like this, with a new scale value.
final boolean	scaleDefined()	Whether the precision returned by DataType.scale() is defined.
final DataType<T>	stored()	Set the DataType.generationOption() of the computed column expression to QOM.GenerationOption.STORED.
String	toString()	Render a SQL string representation of this QueryPart.
protected final DataAccessException	translate(String sql, SQLException e)	Internal convenience method
final DataType<T>	virtual()	Set the DataType.generationOption() of the computed column expression to QOM.GenerationOption.VIRTUAL.

Methods inherited from class org.jooq.impl.DefaultDataType

characterSet, collation, default_, generatedAlwaysAsGenerator, generationLocation, generationOption, getBinding, getDataType, getDataType, getDataType, getDataType, getDataType, getDataType, getDataType, getDataType, getDefaultDataType, getDefaultDataType, getDialect, getSQLDataType, getType, getType, hidden, identity, normalise, nullability, readonly

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

$name, getComment, getCommentPart, getName, getQualifiedName, getUnqualifiedName

Methods inherited from interface org.jooq.QueryPart

$replace, $traverse

Constructor Details

BuiltInDataType

public BuiltInDataType(Class<T> type,
 String typeName)

Constructor for SQLDataType types.

BuiltInDataType

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

Constructor for dialect specific data types.

BuiltInDataType

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

Constructor for dialect specific data types.

Method Details

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

hidden

public final DataType<T> hidden(boolean h)

Description copied from interface: DataType

Return a new data type like this, with a new hidden attribute.

This feature is implemented in commercial distributions only.

Specified by:

hidden in interface DataType<T>

Returns:

The new data type

readonly

public final DataType<T> readonly(boolean r)

Description copied from interface: DataType

Return a new data type like this, with a new readonly attribute.

This feature is implemented in commercial distributions only.

Specified by:

readonly in interface DataType<T>

Parameters:

r - The new readonly attribute value.

Returns:

The new data type

generatedAlwaysAs

public final DataType<T> generatedAlwaysAs(Generator<?,?,T> g)

Description copied from interface: DataType

Set the computed column expression of this data type to a dynamic expression.

Unlike DataType.generatedAlwaysAs(Object) and DataType.generatedAlwaysAs(Field), which produce a constant value or expression, this allows for generating a dynamic expression if used along with DataType.generationLocation() and QOM.GenerationLocation.CLIENT, in order to implement client side computed columns.

If DataType.generationLocation() is QOM.GenerationLocation.SERVER, then this does not affect generated DML statements, and will be evaluated only in DDL statements, when creating the table.

This implicitly sets DataType.readonly() to true.

This feature is implemented in commercial distributions only.

Specified by:

generatedAlwaysAs in interface DataType<T>

generationOption

public final DataType<T> generationOption(QOM.GenerationOption g)

Description copied from interface: DataType

Set the DataType.generationOption() of the computed column expression.

If not supported by the dialect, this will be ignored.

This feature is implemented in commercial distributions only.

Specified by:

generationOption in interface DataType<T>

generationLocation

public final DataType<T> generationLocation(QOM.GenerationLocation g)

Description copied from interface: DataType

Set the DataType.generationLocation() of the computed column expression.

Specifies whether the DataType.generatedAlwaysAs() expression is computed on the QOM.GenerationLocation.SERVER (by default) or in the QOM.GenerationLocation.CLIENT. The latter is supported in all dialects, the former only in relevant dialects.

The computation happens in Insert, Update, or Merge statements in case DataType.generationOption() is QOM.GenerationOption.STORED, or in Select in case the DataType.generationOption() is QOM.GenerationOption.VIRTUAL.

This feature is implemented in commercial distributions only.

Specified by:

generationLocation in interface DataType<T>

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>

readonlyInternal

public final boolean readonlyInternal()

Description copied from interface: DataType

Get the readonly attribute of this data type, combined with other flags that influence readonly behaviour.

A column may be marked as DataType.readonly() for various reasons, including:

• When it is marked as readonly explicitly by the code generator.
• When it is marked as readonly implicitly because it's a computed column with QOM.GenerationLocation.SERVER or with QOM.GenerationLocation.CLIENT and QOM.GenerationOption.VIRTUAL.

Some columns are readonly for users, meaning users of the jOOQ API cannot write to them, but jOOQ, internally, may still write to those columns. Such columns may include:

• Columns that are computed with QOM.GenerationLocation.CLIENT and QOM.GenerationOption.STORED
• Columns used for optimistic locking

This method returns the static information for this data type. The information may be overridden by a Settings value, e.g. Settings.isEmulateComputedColumns(), in case of which DataType.readonlyInternal(Configuration) should be called.

This feature is implemented in commercial distributions only.

Specified by:

readonlyInternal in interface DataType<T>

readonlyInternal

public final boolean readonlyInternal(Configuration configuration)

Description copied from interface: DataType

Get the readonly attribute of this data type, combined with other flags that influence readonly behaviour.

A column may be marked as DataType.readonly() for various reasons, including:

• When it is marked as readonly explicitly by the code generator.
• When it is marked as readonly implicitly because it's a computed column with QOM.GenerationLocation.SERVER or with QOM.GenerationLocation.CLIENT and QOM.GenerationOption.VIRTUAL.

Some columns are readonly for users, meaning users of the jOOQ API cannot write to them, but jOOQ, internally, may still write to those columns. Such columns may include:

• Columns that are computed with QOM.GenerationLocation.CLIENT and QOM.GenerationOption.STORED
• Columns used for optimistic locking

This feature is implemented in commercial distributions only.

Specified by:

readonlyInternal in interface DataType<T>

computed

public final boolean computed()

Description copied from interface: DataType

Whether this column is computed.

This feature is implemented in commercial distributions only.

Specified by:

computed in interface DataType<T>

computedOnServer

public final boolean computedOnServer()

Description copied from interface: DataType

Whether this column is computed on the server.

This is true only if all of these hold true:

• DataType.computed()
• DataType.generationLocation() == QOM.GenerationLocation.SERVER

This method returns the static information for this data type. The information may be overridden by a Settings value, e.g. Settings.isEmulateComputedColumns(), in case of which DataType.computedOnServer(Configuration) should be called.

This feature is implemented in commercial distributions only.

Specified by:

computedOnServer in interface DataType<T>

computedOnServer

public final boolean computedOnServer(Configuration configuration)

Description copied from interface: DataType

Whether this column is computed on the server.

This is true only if all of these hold true:

• DataType.computed()
• DataType.generationLocation() == QOM.GenerationLocation.SERVER
• == false

This feature is implemented in commercial distributions only.

Specified by:

computedOnServer in interface DataType<T>

computedOnClient

public final boolean computedOnClient()

Description copied from interface: DataType

Whether this column is computed on the client.

This is true only if all of these hold true:

• DataType.computed()
• DataType.generationLocation() == QOM.GenerationLocation.CLIENT

This method returns the static information for this data type. The information may be overridden by a Settings value, e.g. Settings.isEmulateComputedColumns(), in case of which DataType.computedOnClient(Configuration) should be called.

This feature is implemented in commercial distributions only.

Specified by:

computedOnClient in interface DataType<T>

computedOnClient

public final boolean computedOnClient(Configuration configuration)

Description copied from interface: DataType

Whether this column is computed on the client.

This is true only if all of these hold true:

• DataType.computed()
• DataType.generationLocation() == QOM.GenerationLocation.CLIENT

Alternatively, this makes the result true as well:

• DataType.computed()
• DataType.generationLocation() == QOM.GenerationLocation.SERVER
• == true

This feature is implemented in commercial distributions only.

Specified by:

computedOnClient in interface DataType<T>

computedOnClientStored

public final boolean computedOnClientStored()

Description copied from interface: DataType

Whether this column is computed on the client.

This is true only if all of these hold true:

• DataType.computed()
• DataType.generationLocation() == QOM.GenerationLocation.CLIENT
• DataType.generationOption() == QOM.GenerationOption.STORED
• DataType.generatedAlwaysAsGenerator() produces a generator that Generator.supports(GeneratorStatementType) any of GeneratorStatementType.INSERT or GeneratorStatementType.UPDATE

This method returns the static information for this data type. The information may be overridden by a Settings value, e.g. Settings.isEmulateComputedColumns(), in case of which DataType.computedOnClientStored(Configuration) should be called.

This feature is implemented in commercial distributions only.

Specified by:

computedOnClientStored in interface DataType<T>

computedOnClientStored

public final boolean computedOnClientStored(Configuration configuration)

Description copied from interface: DataType

Whether this column is computed on the client.

This is true only if all of these hold true:

• DataType.computed()
• DataType.generationLocation() == QOM.GenerationLocation.CLIENT
• DataType.generationOption() == QOM.GenerationOption.STORED
• DataType.generatedAlwaysAsGenerator() produces a generator that Generator.supports(GeneratorStatementType) any of GeneratorStatementType.INSERT or GeneratorStatementType.UPDATE

This feature is implemented in commercial distributions only.

Specified by:

computedOnClientStored in interface DataType<T>

computedOnClientStoredOn

public final boolean computedOnClientStoredOn(GeneratorStatementType statementType)

Description copied from interface: DataType

Whether this column is computed on the client.

This is true only if all of these hold true:

• DataType.computed()
• DataType.generationLocation() == QOM.GenerationLocation.CLIENT
• DataType.generationOption() == QOM.GenerationOption.STORED
• DataType.generatedAlwaysAsGenerator() produces a generator that Generator.supports(GeneratorStatementType) the argument statementType

This method returns the static information for this data type. The information may be overridden by a Settings value, e.g. Settings.isEmulateComputedColumns(), in case of which DataType.computedOnClientStoredOn(GeneratorStatementType, Configuration) should be called.

This feature is implemented in commercial distributions only.

Specified by:

computedOnClientStoredOn in interface DataType<T>

computedOnClientStoredOn

public final boolean computedOnClientStoredOn(GeneratorStatementType statementType,
 Configuration configuration)

Description copied from interface: DataType

Whether this column is computed on the client.

This is true only if all of these hold true:

• DataType.computed()
• DataType.generationLocation() == QOM.GenerationLocation.CLIENT
• DataType.generationOption() == QOM.GenerationOption.STORED
• DataType.generatedAlwaysAsGenerator() produces a generator that Generator.supports(GeneratorStatementType) the argument statementType

This feature is implemented in commercial distributions only.

Specified by:

computedOnClientStoredOn in interface DataType<T>

computedOnClientVirtual

public final boolean computedOnClientVirtual()

Description copied from interface: DataType

Whether this column is computed on the client.

This is true only if all of these hold true:

• DataType.computed()
• DataType.generationLocation() == QOM.GenerationLocation.CLIENT
• DataType.generationOption() == QOM.GenerationOption.VIRTUAL
• DataType.generatedAlwaysAsGenerator() produces a generator that Generator.supports(GeneratorStatementType) the type GeneratorStatementType.SELECT

This method returns the static information for this data type. The information may be overridden by a Settings value, e.g. Settings.isEmulateComputedColumns(), in case of which DataType.computedOnClientVirtual(Configuration) should be called.

This feature is implemented in commercial distributions only.

Specified by:

computedOnClientVirtual in interface DataType<T>

computedOnClientVirtual

public final boolean computedOnClientVirtual(Configuration configuration)

Description copied from interface: DataType

Whether this column is computed on the client.

This is true only if all of these hold true:

• DataType.computed()
• DataType.generationLocation() == QOM.GenerationLocation.CLIENT
• DataType.generationOption() == QOM.GenerationOption.VIRTUAL
• DataType.generatedAlwaysAsGenerator() produces a generator that Generator.supports(GeneratorStatementType) the type GeneratorStatementType.SELECT

This feature is implemented in commercial distributions only.

Specified by:

computedOnClientVirtual in interface DataType<T>

generatedAlwaysAs

public final DataType<T> generatedAlwaysAs(T g)

Description copied from interface: DataType

Set the computed column expression of this data type to a constant value.

This implicitly sets DataType.readonly() to true.

This feature is implemented in commercial distributions only.

Specified by:

generatedAlwaysAs in interface DataType<T>

generatedAlwaysAs

public final DataType<T> generatedAlwaysAs(Field<T> generatedAlwaysAsValue)

Description copied from interface: DataType

Set the computed column expression of this data type to a constant expression.

This implicitly sets DataType.readonly() to true.

This feature is implemented in commercial distributions only.

Specified by:

generatedAlwaysAs in interface DataType<T>

generatedAlwaysAs

public final Field<T> generatedAlwaysAs()

Description copied from interface: DataType

Get the computed column expression of this data type, if any.

This eagerly evaluates the DataType.generatedAlwaysAsGenerator() generator, which may not produce the same expression upon execution of a query, in case DataType.generationLocation() is QOM.GenerationLocation.CLIENT. The behaviour of QOM.GenerationLocation.SERVER is not affected. The method has been left unmodified for backwards compatibility with jOOQ 3.16.

This feature is implemented in commercial distributions only.

Specified by:

generatedAlwaysAs in interface DataType<T>

stored

public final DataType<T> stored()

Description copied from interface: DataType

Set the DataType.generationOption() of the computed column expression to QOM.GenerationOption.STORED.

If not supported by the dialect, this will be ignored.

This feature is implemented in commercial distributions only.

Specified by:

stored in interface DataType<T>

virtual

public final DataType<T> virtual()

Description copied from interface: DataType

Set the DataType.generationOption() of the computed column expression to QOM.GenerationOption.VIRTUAL.

If not supported by the dialect, this will be ignored.

This feature is implemented in commercial distributions only.

Specified by:

virtual in interface DataType<T>

autoIncrement

public final DataType<T> autoIncrement()

Description copied from interface: DataType

Return a new data type like this, with the DataType.identity(boolean) flag set to true.

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

This is the same as calling identity(true).

Specified by:

autoIncrement in interface DataType<T>

Returns:

The new data type

generatedByDefaultAsIdentity

public final DataType<T> generatedByDefaultAsIdentity()

Description copied from interface: DataType

Return a new data type like this, with the DataType.identity(boolean) flag set to true.

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

This is the same as calling identity(true).

Specified by:

generatedByDefaultAsIdentity in interface DataType<T>

Returns:

The new data type

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

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

hasFixedLength

public final boolean hasFixedLength()

Description copied from interface: DataType

Whether this data type has a fixed length.

Specified by:

hasFixedLength in interface DataType<T>

Returns:

Whether this data type has a fixed 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 ContextConverter<?,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.

Built-in data types, as well as custom data types that have a custom DataType.getConverter() can be translated to array data types using Converter.forArrays(). Data types with custom DataType.getBinding() cannot be translated to an array data type. Use this idiom, instead:

 // Doesn't work
 DataTypeinvalid input: '<'UserType[]> t1 =
   SQLDataType.INTEGER.asConvertedDataType(binding).getArrayDataType();

 // Works
 DataTypeinvalid input: '<'UserType[]> t2 =
   SQLDataType.INTEGER.getArrayDataType().asConvertedDataType(arrayBinding);
 

Specified by:

getArrayDataType in interface DataType<T>

array

public final DataType<T[]> array()

Description copied from interface: DataType

A convenient short for form DataType.getArrayDataType() for DSL usage

Specified by:

array 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.

E.g. for DataTypeinvalid input: '<'String[][][]>, this will return String[][].

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.

E.g. for DataTypeinvalid input: '<'String[][][]>, this will return DataType<String[][]>.

Specified by:

getArrayComponentDataType in interface DataType<T>

getArrayBaseType

public Class<?> getArrayBaseType()

Description copied from interface: DataType

Retrieve the Java base type if this is an ARRAY type, or DataType.getType(), otherwise.

E.g. for DataTypeinvalid input: '<'String[][][]>, this will return String.

Specified by:

getArrayBaseType in interface DataType<T>

getArrayBaseDataType

public DataType<?> getArrayBaseDataType()

Description copied from interface: DataType

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

E.g. for DataTypeinvalid input: '<'String[][][]>, this will return DataType<String>.

Specified by:

getArrayBaseDataType 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>

asAssociativeArrayDataType

@Pro
public final <A extends AssociativeArrayRecord<?,
?>>
DataType<A> asAssociativeArrayDataType(Class<A> arrayDataType)

Description copied from interface: DataType

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

Specified by:

asAssociativeArrayDataType 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 final T convert(Object object)

Description copied from interface: DataType

Convert an arbitrary object into <T>.

See

invalid reference

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

invalid reference

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

invalid reference

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
• SQLDataType.DECFLOAT

Specified by:

isNumeric in interface DataType<T>

See Also:

• DataType.isNumeric()

isDecimal

public final boolean isDecimal()

Description copied from interface: DataType

Whether this data type is any decimal numeric data type.

This applies to any of these types:

• SQLDataType.DECIMAL
• SQLDataType.DECIMAL_INTEGER
• SQLDataType.NUMERIC
• SQLDataType.DECFLOAT

Specified by:

isDecimal in interface DataType<T>

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>

isFloat

public final boolean isFloat()

Description copied from interface: DataType

Whether this data type is any floating point data type.

This applies to any of these types:

• SQLDataType.FLOAT
• SQLDataType.DOUBLE
• SQLDataType.REAL
• SQLDataType.DECFLOAT

Specified by:

isFloat in interface DataType<T>

isBoolean

public final boolean isBoolean()

Description copied from interface: DataType

Whether this data type is any boolean data type.

This applies to any of these types:

• SQLDataType.BIT
• SQLDataType.BOOLEAN

Specified by:

isBoolean 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
• SQLDataType.YEAR

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>

isTimestampWithTimeZone

public final boolean isTimestampWithTimeZone()

Description copied from interface: DataType

Whether this data type is any timestamp type.

This applies to any of these types.

• SQLDataType.TIMESTAMPWITHTIMEZONE
• SQLDataType.INSTANT

Specified by:

isTimestampWithTimeZone 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>

isTimeWithTimeZone

public final boolean isTimeWithTimeZone()

Description copied from interface: DataType

Whether this data type is any time type.

This applies to any of these types.

• SQLDataType.TIMEWITHTIMEZONE

Specified by:

isTimeWithTimeZone 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
• SQLDataType.INSTANT
• SQLDataType.YEAR
• 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>

isAssociativeArray

public final boolean isAssociativeArray()

Description copied from interface: DataType

Whether this data type is an array type.

Specified by:

isAssociativeArray 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(TableLike) 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>

isSpatial

public final boolean isSpatial()

Description copied from interface: DataType

Whether this data type is a spatial type.

Specified by:

isSpatial in interface DataType<T>

isUUID

public final boolean isUUID()

Description copied from interface: DataType

Whether this data type is a UUID type.

Specified by:

isUUID in interface DataType<T>

isOther

public final boolean isOther()

Description copied from interface: DataType

Whether this data type is an OTHER type.

The SQLDataType.OTHER type maps any unknown data types to a jOOQ DataType. This includes unknown vendor specific types as well as unknown user defined types which do not have any custom Converter or Binding attached. The type may still be usable with the jOOQ API, but jOOQ's behaviour may not be well defined. Please note that any future minor release may add support for a vendor specific type, meaning the type loses its "otherness."

Specified by:

isOther 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

$traverse

default <R> R $traverse(Traverser<?,R> traverser)

Description copied from interface: QueryPart

Traverser this QueryPart expression tree using a composable Traverser, producing a result.

This offers a generic way to traverse expression trees to translate the tree to arbitrary other data structures. The simplest traversal would just count all the tree elements:

 int count = CUSTOMER.NAME.eq(1).$traverse(0, (i, p) -> i + 1);
 

The same can be achieved by translating the JDK Collector API to the Traverser API using Traversers.collecting(Collector).

 CUSTOMER.NAME.eq(1).$traverse(Traversers.collecting(Collectors.counting()));
 

Unlike a Collector, a Traverser is optimised for tree traversal, not stream traversal:

• Is not designed for parallelism
• It can Traverser.abort() traversal early when the result can be produced early (e.g. when running Traversers.containing(QueryPart), and a result has been found).
• It can decide whether to Traverser.recurse() into a QueryPart subtree, or whether that is not necessary or even undesirable, e.g. to prevent entering new subquery scopes.
• Unlike a Collector, which can use its Collector.accumulator() to accumulate each element only once, in tree traversal, it's desirable to be able to distinguish between accumulating an item Traverser.before() or Traverser.after() recursing into it. This is useful e.g. to wrap each tree node in XML opening and closing tags.

This is a commercial jOOQ edition only feature.

Specified by:

$traverse in interface QueryPart

$replace

default QueryPart $replace(Replacer replacer)

Description copied from interface: QueryPart

Traverse a QueryPart hierarchy and recursively replace its elements by alternatives.

While replacing contents, this QueryPart isn't modified. Instead, a new object is returned.

This is a commercial jOOQ edition only feature.

Specified by:

$replace in interface QueryPart

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

$name

public final Name $name()

Description copied from interface: Named

Experimental query object model accessor method, see also QOM. Subject to change in future jOOQ versions, use at your own risk.

Specified by:

$name 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