Module org.jooq

Package org.jooq.impl

Class Internal

java.lang.Object

org.jooq.impl.Internal

@Internal
public final class Internal
extends Object

A utility class that grants access to internal API, to be used only by generated code.

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

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
static final <T> Class<T[]>	arrayType(Class<T> type)	JDK agnostic abstraction over Class.arrayType() and Array.newInstance(Class, int).
static final boolean	commercial()	Whether this is a commercial edition of jOOQ.
static final boolean	commercial(Supplier<String> logMessage)	Whether this is a commercial edition of jOOQ, logging a warning message, if not.
static final Object[]	convert(Object[] values, Class<?>[] types)	Deprecated, for removal: This API element is subject to removal in a future version.
static final Object[]	convert(Object[] values, Field<?>[] fields)	Deprecated, for removal: This API element is subject to removal in a future version.
static final <T> T	convert(Object from, Class<? extends T> toClass)	Deprecated, for removal: This API element is subject to removal in a future version.
static final <U> U	convert(Object from, Converter<?,? extends U> converter)	Deprecated, for removal: This API element is subject to removal in a future version.
static final <T> List<T>	convert(Collection<?> collection, Class<? extends T> type)	Deprecated, for removal: This API element is subject to removal in a future version.
static final <U> List<U>	convert(Collection<?> collection, Converter<?,? extends U> converter)	Deprecated, for removal: This API element is subject to removal in a future version.
static final Object[]	convertArray(Object[] from, Class<?> toClass)	Deprecated, for removal: This API element is subject to removal in a future version.
static final <U> U[]	convertArray(Object[] from, Converter<?,? extends U> converter)	Deprecated, for removal: This API element is subject to removal in a future version.
static final <U> U[]	convertCollection(Collection from, Class<? extends U[]> to)	Deprecated, for removal: This API element is subject to removal in a future version.
static final ConverterContext	converterContext()
static final <R extends Record> @NotNull Check<R>	createCheck(Table<R> table, Name name, String condition)	Factory method for check constraints.
static final <R extends Record> @NotNull Check<R>	createCheck(Table<R> table, Name name, String condition, boolean enforced)	Factory method for check constraints.
static final <T, U> @NotNull Domain<U>	createDomain(Schema schema, Name name, DataType<T> type, Binding<T,U> binding, Check<?>... checks)	Factory method for domain specifications.
static final <T> @NotNull Domain<T>	createDomain(Schema schema, Name name, DataType<T> type, Check<?>... checks)	Factory method for domain specifications.
static final <T, U> @NotNull Domain<U>	createDomain(Schema schema, Name name, DataType<T> type, Converter<T,U> converter, Check<?>... checks)	Factory method for domain specifications.
static final <T, X, U> @NotNull Domain<U>	createDomain(Schema schema, Name name, DataType<T> type, Converter<X,U> converter, Binding<T,X> binding, Check<?>... checks)	Factory method for domain specifications.
static final <R extends Record, E extends EmbeddableRecord<E>> @NotNull TableField<R,E>	createEmbeddable(Name name, Class<E> recordType, boolean replacesFields, Table<R> table, TableField<R,?>... fields)	Factory method for embeddable types.
static final <R extends Record, E extends EmbeddableRecord<E>> @NotNull TableField<R,E>	createEmbeddable(Name name, Class<E> recordType, Table<R> table, TableField<R,?>... fields)	Factory method for embeddable types.
static final <R extends Record, U extends Record> @NotNull ForeignKey<R,U>	createForeignKey(Table<R> table, Name name, TableField<R,?>[] fkFields, UniqueKey<U> uk, TableField<U,?>[] ukFields, boolean enforced)	Factory method for foreign keys.
static final <R extends Record, U extends Record, ER extends EmbeddableRecord<ER>> @NotNull ForeignKey<R,U>	createForeignKey(Table<R> table, Name name, TableField<R,ER> fkEmbeddableField, UniqueKey<U> uk, TableField<U,ER> ukEmbeddableField, boolean enforced)	Factory method for foreign keys.
static final <R extends Record, U extends Record> @NotNull ForeignKey<R,U>	createForeignKey(UniqueKey<U> key, Table<R> table, String name, TableField<R,?>... fields)	Deprecated, for removal: This API element is subject to removal in a future version. - 3.14.0 - [#9404] - Please re-generate your code.
static final <R extends Record, U extends Record> @NotNull ForeignKey<R,U>	createForeignKey(UniqueKey<U> key, Table<R> table, String name, TableField<R,?>[] fields, boolean enforced)	Deprecated, for removal: This API element is subject to removal in a future version. - 3.14.0 - [#9404] - Please re-generate your code.
static final <R extends Record, U extends Record> @NotNull ForeignKey<R,U>	createForeignKey(UniqueKey<U> key, Table<R> table, TableField<R,?>... fields)	Deprecated. - 3.14.0 - [#9404] - Please re-generate your code.
static final <R extends Record, T> @NotNull Identity<R,T>	createIdentity(Table<R> table, TableField<R,T> field)	Factory method for identities.
static final @NotNull Index	createIndex(String name, Table<?> table, OrderField<?>[] sortFields, boolean unique)	Deprecated, for removal: This API element is subject to removal in a future version. - 3.14.0 - [#9404] - Please re-generate your code.
static final @NotNull Index	createIndex(Name name, Table<?> table, OrderField<?>[] sortFields, boolean unique)	Factory method for indexes.
static final <T> @NotNull Parameter<T>	createParameter(String name, DataType<T> type, boolean isDefaulted, boolean isUnnamed)	Factory method for parameters.
static final <T, U> @NotNull Parameter<U>	createParameter(String name, DataType<T> type, boolean isDefaulted, boolean isUnnamed, Binding<T,U> binding)	Factory method for parameters.
static final <T, U> @NotNull Parameter<U>	createParameter(String name, DataType<T> type, boolean isDefaulted, boolean isUnnamed, Converter<T,U> converter)	Factory method for parameters.
static final <T, X, U> @NotNull Parameter<U>	createParameter(String name, DataType<T> type, boolean isDefaulted, boolean isUnnamed, Converter<X,U> converter, Binding<T,X> binding)	Factory method for parameters.
static final @NotNull Name	createPathAlias(Table<?> child, ForeignKey<?,?> path)	Factory method for path aliases.
static final <R extends UDTRecord<R>> @NotNull Queue<R>	createQueue(String name, Schema schema, UDT<R> type)
static final <T extends Number> @NotNull Sequence<T>	createSequence(String name, Schema schema, DataType<T> type)	Factory method for sequences.
static final <T extends Number> @NotNull Sequence<T>	createSequence(String name, Schema schema, DataType<T> type, Number startWith, Number incrementBy, Number minvalue, Number maxvalue, boolean cycle, Number cache)	Factory method for sequences.
static final <R extends Record> @NotNull UniqueKey<R>	createUniqueKey(Table<R> table, String name, TableField<R,?>... fields)	Deprecated, for removal: This API element is subject to removal in a future version. - 3.14.0 - [#9404] - Please re-generate your code.
static final <R extends Record> @NotNull UniqueKey<R>	createUniqueKey(Table<R> table, String name, TableField<R,?>[] fields, boolean enforced)	Deprecated, for removal: This API element is subject to removal in a future version. - 3.14.0 - [#9404] - Please re-generate your code.
static final <R extends Record> @NotNull UniqueKey<R>	createUniqueKey(Table<R> table, Name name, TableField<R,?>... fields)	Factory method for unique keys.
static final <R extends Record> @NotNull UniqueKey<R>	createUniqueKey(Table<R> table, Name name, TableField<R,?>[] fields, boolean enforced)	Factory method for unique keys.
static final <R extends Record, ER extends EmbeddableRecord<ER>> @NotNull UniqueKey<R>	createUniqueKey(Table<R> table, Name name, TableField<R,ER> embeddableField, boolean enforced)	Factory method for unique keys.
static final <R extends Record> @NotNull UniqueKey<R>	createUniqueKey(Table<R> table, TableField<R,?>... fields)	Factory method for unique keys.
static final Replacer	decomposing()	The implementation of Replacers.decomposing().
static final <R extends Record, ER extends EmbeddableRecord<ER>> @NotNull TableField<R,?>[]	fields(TableField<R,ER> embeddableField)	Deprecated, for removal: This API element is subject to removal in a future version. - [#11058] - 3.14.5 - Please re-generate your code.
static final <R extends Record, ER extends EmbeddableRecord<ER>> @NotNull Row	fieldsRow(TableField<R,ER> embeddableField)	Deprecated, for removal: This API element is subject to removal in a future version. - [#12238] - 3.16.0 - Please re-generate your code.
static final int	hash(QueryPart part)	Return a non-negative hash code for a QueryPart, taking into account FindBugs' RV_ABSOLUTE_VALUE_OF_HASHCODE pattern
static final int	javaVersion()	Get the Java version (relevant to jOOQ) as an int.
static final void	requireCommercial(Supplier<String> logMessage)	Whether this is a commercial edition of jOOQ, throwing an exception with a message, if not.
static final <R extends Record> Result<R>	result(R record)	Create an empty result from a Record using its row type.
static final <T> org.reactivestreams.Subscriber<T>	subscriber(Consumer<? super org.reactivestreams.Subscription> subscription, Consumer<? super T> onNext, Consumer<? super Throwable> onError, Runnable onComplete)	Create a Subscriber from a set of lambdas.

Methods inherited from class java.lang.Object

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

Method Details

createEmbeddable

@SafeVarargs
@NotNull
public static final <R extends Record,
E extends EmbeddableRecord<E>>
@NotNull TableField<R,E> createEmbeddable(Name name,
 Class<E> recordType,
 Table<R> table,
 TableField<R,?>... fields)

Factory method for embeddable types.

createEmbeddable

@SafeVarargs
@NotNull
public static final <R extends Record,
E extends EmbeddableRecord<E>>
@NotNull TableField<R,E> createEmbeddable(Name name,
 Class<E> recordType,
 boolean replacesFields,
 Table<R> table,
 TableField<R,?>... fields)

Factory method for embeddable types.

createIndex

@NotNull
public static final @NotNull Index createIndex(Name name,
 Table<?> table,
 OrderField<?>[] sortFields,
 boolean unique)

Factory method for indexes.

createIdentity

@NotNull
public static final <R extends Record,
T>
@NotNull Identity<R,T> createIdentity(Table<R> table,
 TableField<R,T> field)

Factory method for identities.

createUniqueKey

@NotNull
@SafeVarargs
public static final <R extends Record>
@NotNull UniqueKey<R> createUniqueKey(Table<R> table,
 TableField<R,?>... fields)

Factory method for unique keys.

createUniqueKey

@NotNull
@SafeVarargs
public static final <R extends Record>
@NotNull UniqueKey<R> createUniqueKey(Table<R> table,
 Name name,
 TableField<R,?>... fields)

Factory method for unique keys.

createUniqueKey

@NotNull
public static final <R extends Record>
@NotNull UniqueKey<R> createUniqueKey(Table<R> table,
 Name name,
 TableField<R,?>[] fields,
 boolean enforced)

Factory method for unique keys.

createUniqueKey

@NotNull
public static final <R extends Record,
ER extends EmbeddableRecord<ER>>
@NotNull UniqueKey<R> createUniqueKey(Table<R> table,
 Name name,
 TableField<R,ER> embeddableField,
 boolean enforced)

Factory method for unique keys.

createForeignKey

@Deprecated
@NotNull
@SafeVarargs
public static final <R extends Record,
U extends Record>
@NotNull ForeignKey<R,U> createForeignKey(UniqueKey<U> key,
 Table<R> table,
 TableField<R,?>... fields)

Deprecated.

- 3.14.0 - [#9404] - Please re-generate your code.

Factory method for foreign keys.

createForeignKey

@NotNull
public static final <R extends Record,
U extends Record>
@NotNull ForeignKey<R,U> createForeignKey(Table<R> table,
 Name name,
 TableField<R,?>[] fkFields,
 UniqueKey<U> uk,
 TableField<U,?>[] ukFields,
 boolean enforced)

Factory method for foreign keys.

createForeignKey

@NotNull
public static final <R extends Record,
U extends Record,
ER extends EmbeddableRecord<ER>>
@NotNull ForeignKey<R,U> createForeignKey(Table<R> table,
 Name name,
 TableField<R,ER> fkEmbeddableField,
 UniqueKey<U> uk,
 TableField<U,ER> ukEmbeddableField,
 boolean enforced)

Factory method for foreign keys.

createSequence

@NotNull
public static final <T extends Number>
@NotNull Sequence<T> createSequence(String name,
 Schema schema,
 DataType<T> type)

Factory method for sequences.

createSequence

@NotNull
public static final <T extends Number>
@NotNull Sequence<T> createSequence(String name,
 Schema schema,
 DataType<T> type,
 Number startWith,
 Number incrementBy,
 Number minvalue,
 Number maxvalue,
 boolean cycle,
 Number cache)

Factory method for sequences.

createCheck

@NotNull
public static final <R extends Record>
@NotNull Check<R> createCheck(Table<R> table,
 Name name,
 String condition)

Factory method for check constraints.

createCheck

@NotNull
public static final <R extends Record>
@NotNull Check<R> createCheck(Table<R> table,
 Name name,
 String condition,
 boolean enforced)

Factory method for check constraints.

createDomain

@NotNull
public static final <T> @NotNull Domain<T> createDomain(Schema schema,
 Name name,
 DataType<T> type,
 Check<?>... checks)

Factory method for domain specifications.

createDomain

@NotNull
public static final <T,
U> @NotNull Domain<U> createDomain(Schema schema,
 Name name,
 DataType<T> type,
 Converter<T,U> converter,
 Check<?>... checks)

Factory method for domain specifications.

createDomain

@NotNull
public static final <T,
U> @NotNull Domain<U> createDomain(Schema schema,
 Name name,
 DataType<T> type,
 Binding<T,U> binding,
 Check<?>... checks)

Factory method for domain specifications.

createDomain

@NotNull
public static final <T,
X,
U> @NotNull Domain<U> createDomain(Schema schema,
 Name name,
 DataType<T> type,
 Converter<X,U> converter,
 Binding<T,X> binding,
 Check<?>... checks)

Factory method for domain specifications.

createPathAlias

@NotNull
public static final @NotNull Name createPathAlias(Table<?> child,
 ForeignKey<?,?> path)

Factory method for path aliases.

createParameter

@NotNull
public static final <T> @NotNull Parameter<T> createParameter(String name,
 DataType<T> type,
 boolean isDefaulted,
 boolean isUnnamed)

Factory method for parameters.

createParameter

@NotNull
public static final <T,
U> @NotNull Parameter<U> createParameter(String name,
 DataType<T> type,
 boolean isDefaulted,
 boolean isUnnamed,
 Converter<T,U> converter)

Factory method for parameters.

createParameter

@NotNull
public static final <T,
U> @NotNull Parameter<U> createParameter(String name,
 DataType<T> type,
 boolean isDefaulted,
 boolean isUnnamed,
 Binding<T,U> binding)

Factory method for parameters.

createParameter

@NotNull
public static final <T,
X,
U> @NotNull Parameter<U> createParameter(String name,
 DataType<T> type,
 boolean isDefaulted,
 boolean isUnnamed,
 Converter<X,U> converter,
 Binding<T,X> binding)

Factory method for parameters.

createQueue

@NotNull
@Pro
public static final <R extends UDTRecord<R>>
@NotNull Queue<R> createQueue(String name,
 Schema schema,
 UDT<R> type)

createIndex

@NotNull
@Deprecated(since="3.14",
            forRemoval=true)
public static final @NotNull Index createIndex(String name,
 Table<?> table,
 OrderField<?>[] sortFields,
 boolean unique)

Deprecated, for removal: This API element is subject to removal in a future version.

- 3.14.0 - [#9404] - Please re-generate your code.

Factory method for indexes.

createUniqueKey

@NotNull
@SafeVarargs
@Deprecated(since="3.14",
            forRemoval=true)
public static final <R extends Record>
@NotNull UniqueKey<R> createUniqueKey(Table<R> table,
 String name,
 TableField<R,?>... fields)

Deprecated, for removal: This API element is subject to removal in a future version.

- 3.14.0 - [#9404] - Please re-generate your code.

Factory method for unique keys.

createUniqueKey

@NotNull
@Deprecated(since="3.14",
            forRemoval=true)
public static final <R extends Record>
@NotNull UniqueKey<R> createUniqueKey(Table<R> table,
 String name,
 TableField<R,?>[] fields,
 boolean enforced)

Deprecated, for removal: This API element is subject to removal in a future version.

- 3.14.0 - [#9404] - Please re-generate your code.

Factory method for unique keys.

createForeignKey

@NotNull
@SafeVarargs
@Deprecated(since="3.14",
            forRemoval=true)
public static final <R extends Record,
U extends Record>
@NotNull ForeignKey<R,U> createForeignKey(UniqueKey<U> key,
 Table<R> table,
 String name,
 TableField<R,?>... fields)

Deprecated, for removal: This API element is subject to removal in a future version.

- 3.14.0 - [#9404] - Please re-generate your code.

Factory method for foreign keys.

createForeignKey

@NotNull
@Deprecated(since="3.14",
            forRemoval=true)
public static final <R extends Record,
U extends Record>
@NotNull ForeignKey<R,U> createForeignKey(UniqueKey<U> key,
 Table<R> table,
 String name,
 TableField<R,?>[] fields,
 boolean enforced)

Deprecated, for removal: This API element is subject to removal in a future version.

- 3.14.0 - [#9404] - Please re-generate your code.

Factory method for foreign keys.

fields

@NotNull
@Deprecated(since="3.14",
            forRemoval=true)
public static final <R extends Record,
ER extends EmbeddableRecord<ER>>
@NotNull TableField<R,?>[] fields(TableField<R,ER> embeddableField)

Deprecated, for removal: This API element is subject to removal in a future version.

- [#11058] - 3.14.5 - Please re-generate your code.

Get the fields of an embeddable type.

fieldsRow

@NotNull
@Deprecated(since="3.16",
            forRemoval=true)
public static final <R extends Record,
ER extends EmbeddableRecord<ER>>
@NotNull Row fieldsRow(TableField<R,ER> embeddableField)

Deprecated, for removal: This API element is subject to removal in a future version.

- [#12238] - 3.16.0 - Please re-generate your code.

Get the fields row of an embeddable type.

subscriber

public static final <T>
org.reactivestreams.Subscriber<T> subscriber(Consumer<? super org.reactivestreams.Subscription> subscription,
 Consumer<? super T> onNext,
 Consumer<? super Throwable> onError,
 Runnable onComplete)

Create a Subscriber from a set of lambdas.

This is used for internal purposes and thus subject for change.

arrayType

public static final <T> Class<T[]> arrayType(Class<T> type)

JDK agnostic abstraction over Class.arrayType() and Array.newInstance(Class, int).

result

public static final <R extends Record> Result<R> result(R record)

Create an empty result from a Record using its row type.

commercial

public static final boolean commercial()

Whether this is a commercial edition of jOOQ.

commercial

public static final boolean commercial(Supplier<String> logMessage)

Whether this is a commercial edition of jOOQ, logging a warning message, if not.

requireCommercial

public static final void requireCommercial(Supplier<String> logMessage)
                                    throws DataAccessException

Whether this is a commercial edition of jOOQ, throwing an exception with a message, if not.

Throws:

DataAccessException

decomposing

@Pro
public static final Replacer decomposing()

The implementation of Replacers.decomposing().

hash

public static final int hash(QueryPart part)

Return a non-negative hash code for a QueryPart, taking into account FindBugs' RV_ABSOLUTE_VALUE_OF_HASHCODE pattern

converterContext

public static final ConverterContext converterContext()

javaVersion

public static final int javaVersion()

Get the Java version (relevant to jOOQ) as an int.

Supported versions are:

• 8
• 11
• 17
• 21

convert

@Deprecated(forRemoval=true)
public static final Object[] convert(Object[] values,
 Field<?>[] fields)

Deprecated, for removal: This API element is subject to removal in a future version.

[#11898] [#16044] This method just acts as a bridge to internal API from the deprecated-for-removal Convert utility. Do not reuse these methods.

convert

@Deprecated(forRemoval=true)
public static final Object[] convert(Object[] values,
 Class<?>[] types)

Deprecated, for removal: This API element is subject to removal in a future version.

[#11898] [#16044] This method just acts as a bridge to internal API from the deprecated-for-removal Convert utility. Do not reuse these methods.

convertArray

@Deprecated(forRemoval=true)
public static final <U> U[] convertArray(Object[] from,
 Converter<?,? extends U> converter)
                                  throws DataTypeException

Deprecated, for removal: This API element is subject to removal in a future version.

[#11898] [#16044] This method just acts as a bridge to internal API from the deprecated-for-removal Convert utility. Do not reuse these methods.

Throws:

DataTypeException

convertArray

@Deprecated(forRemoval=true)
public static final Object[] convertArray(Object[] from,
 Class<?> toClass)
                                   throws DataTypeException

Deprecated, for removal: This API element is subject to removal in a future version.

[#11898] [#16044] This method just acts as a bridge to internal API from the deprecated-for-removal Convert utility. Do not reuse these methods.

Throws:

DataTypeException

convertCollection

@Deprecated(forRemoval=true)
public static final <U> U[] convertCollection(Collection from,
 Class<? extends U[]> to)

Deprecated, for removal: This API element is subject to removal in a future version.

[#11898] [#16044] This method just acts as a bridge to internal API from the deprecated-for-removal Convert utility. Do not reuse these methods.

convert

@Deprecated(forRemoval=true)
public static final <U> U convert(Object from,
 Converter<?,? extends U> converter)
                           throws DataTypeException

Deprecated, for removal: This API element is subject to removal in a future version.

[#11898] [#16044] This method just acts as a bridge to internal API from the deprecated-for-removal Convert utility. Do not reuse these methods.

Throws:

DataTypeException

convert

@Deprecated(forRemoval=true)
public static final <T> T convert(Object from,
 Class<? extends T> toClass)
                           throws DataTypeException

Deprecated, for removal: This API element is subject to removal in a future version.

[#11898] [#16044] This method just acts as a bridge to internal API from the deprecated-for-removal Convert utility. Do not reuse these methods.

Throws:

DataTypeException

convert

@Deprecated(forRemoval=true)
public static final <T> List<T> convert(Collection<?> collection,
 Class<? extends T> type)
                                 throws DataTypeException

Deprecated, for removal: This API element is subject to removal in a future version.

[#11898] [#16044] This method just acts as a bridge to internal API from the deprecated-for-removal Convert utility. Do not reuse these methods.

Throws:

DataTypeException

convert

@Deprecated(forRemoval=true)
public static final <U> List<U> convert(Collection<?> collection,
 Converter<?,? extends U> converter)
                                 throws DataTypeException

Deprecated, for removal: This API element is subject to removal in a future version.

[#11898] [#16044] This method just acts as a bridge to internal API from the deprecated-for-removal Convert utility. Do not reuse these methods.

Throws:

DataTypeException