org.jooq

Interface UDT<R extends UDTRecord<R>>

Type Parameters:

R - The record type

All Superinterfaces:

QueryPart, java.io.Serializable

All Known Implementing Classes:

UDTImpl

public interface UDT<R extends UDTRecord<R>>
extends QueryPart

UDT definition

Author:

Lukas Eder

Method Summary

Modifier and Type	Method and Description
<T> Field<T>	field(Field<T> field) Get a specific field from this UDT.
Field<?>	field(int index) Get a specific field from this UDT.
Field<?>	field(Name name) Get a specific field from this UDT.
Field<?>	field(java.lang.String name) Get a specific field from this UDT.
Field<?>[]	fields() Get all fields from this UDT.
Field<?>[]	fields(Field<?>... fields) Get all fields from this UDT, providing some fields.
Field<?>[]	fields(int... fieldIndexes) Get all fields from this UDT, providing some field indexes.
Field<?>[]	fields(Name... fieldNames) Get all fields from this UDT, providing some field names.
Field<?>[]	fields(java.lang.String... fieldNames) Get all fields from this UDT, providing some field names.
Row	fieldsRow() Get this UDT's fields as a Row.
java.util.stream.Stream<Field<?>>	fieldStream() Get this table's fields as a Stream.
Catalog	getCatalog() Get the UDT catalog.
DataType<R>	getDataType() The UDT's data type as known to the database.
java.lang.String	getName() The name of this UDT.
Package	getPackage() Get the UDT package.
java.lang.Class<R>	getRecordType()
Schema	getSchema() Get the UDT schema.
boolean	isSQLUsable() Whether this data type can be used from SQL statements.
boolean	isSynthetic() Whether this data type is a synthetic, structural UDT type.
R	newRecord() Create a new Record of this UDT's type.

Methods inherited from interface org.jooq.QueryPart

equals, hashCode, toString

Method Detail

fieldsRow

Row fieldsRow()

Get this UDT's fields as a Row.

fieldStream

java.util.stream.Stream<Field<?>> fieldStream()

Get this table's fields as a Stream.

field

<T> Field<T> field(Field<T> field)

Get a specific field from this UDT.

This will return:

• A field that is the same as the argument field (by identity comparison).
• A field that is equal to the argument field (exact matching fully qualified name).
• A field that is equal to the argument field (partially matching qualified name).
• A field whose name is equal to the name of the argument field.
• null otherwise.

If several fields have the same name, the first one is returned and a warning is logged.

See Also:

Row.field(Field)

field

Field<?> field(java.lang.String name)

Get a specific field from this UDT.

See Also:

Row.field(String)

field

Field<?> field(Name name)

Get a specific field from this UDT.

See Also:

Row.field(Name)

field

Field<?> field(int index)

Get a specific field from this UDT.

See Also:

Row.field(int)

fields

Field<?>[] fields()

Get all fields from this UDT.

See Also:

Row.fields()

fields

Field<?>[] fields(Field<?>... fields)

Get all fields from this UDT, providing some fields.

Returns:

All available fields

See Also:

Row.fields(Field...)

fields

Field<?>[] fields(java.lang.String... fieldNames)

Get all fields from this UDT, providing some field names.

Returns:

All available fields

See Also:

Row.fields(String...)

fields

Field<?>[] fields(Name... fieldNames)

Get all fields from this UDT, providing some field names.

Returns:

All available fields

See Also:

Row.fields(Name...)

fields

Field<?>[] fields(int... fieldIndexes)

Get all fields from this UDT, providing some field indexes.

Returns:

All available fields

See Also:

Row.fields(int...)

getCatalog

Catalog getCatalog()

Get the UDT catalog.

getSchema

Schema getSchema()

Get the UDT schema.

getPackage

Package getPackage()

Get the UDT package.

getName

java.lang.String getName()

The name of this UDT.

getRecordType

java.lang.Class<R> getRecordType()

Returns:

The record type produced by this table.

newRecord

R newRecord()

Create a new Record of this UDT's type.

See Also:

DSLContext.newRecord(UDT)

getDataType

DataType<R> getDataType()

The UDT's data type as known to the database.

isSQLUsable

boolean isSQLUsable()

Whether this data type can be used from SQL statements.

isSynthetic

boolean isSynthetic()

Whether this data type is a synthetic, structural UDT type.

This is true for example:

• For Oracle TAB%ROWTYPE references, which are synthetic PL/SQL RECORD types in PL/SQL.