Interface UDT<R extends UDTRecord<R>>

Type Parameters:

R - The record type

All Superinterfaces:

Fields, Named, Qualified, QueryPart, RecordQualifier<R>, Serializable

All Known Implementing Classes:

UDTImpl

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

UDT definition.

Instances of this type cannot be created directly. They are available from generated code.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
@NotNull Field<R>	construct(Field<?>... args)	Create a constructor call for UDTs.
@NotNull List<UDT<?>>	getSubtypes()	Get the subtypes of this UDT or an empty list, if there are no known subtypes.
@Nullable UDT<?>	getSupertype()	Get the supertype of this UDT, or null if this type has no supertype.
boolean	isAssignableFrom(UDT<?> other)	Check if this type is a supertype or the same type as another UDT type.
boolean	isSQLUsable()	Whether this data type can be used from SQL statements.
boolean	isSynthetic()	Whether this data type is a synthetic, structural UDT type.

Methods inherited from interface Fields

dataType, dataType, dataType, dataTypes, field, field, field, field, field, field, field, field, field, field, fields, fields, fields, fields, fields, fieldsIncludingHidden, fieldsRow, fieldStream, indexOf, indexOf, indexOf, type, type, type, types

Methods inherited from interface Named

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

Methods inherited from interface Qualified

$schema, getCatalog, getSchema

Methods inherited from interface QueryPart

$replace, $replace, $traverse, $traverse, equals, hashCode, toString

Methods inherited from interface RecordQualifier

getDataType, getPackage, getRecordType, newRecord

Method Details

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.

getSupertype

@Nullable
@Nullable UDT<?> getSupertype()

Get the supertype of this UDT, or null if this type has no supertype.

getSubtypes

@NotNull
@NotNull List<UDT<?>> getSubtypes()

Get the subtypes of this UDT or an empty list, if there are no known subtypes.

isAssignableFrom

boolean isAssignableFrom(UDT<?> other)

Check if this type is a supertype or the same type as another UDT type.

construct

@Support({AURORA_POSTGRES,COCKROACHDB,DUCKDB,INFORMIX,ORACLE,POSTGRES,YUGABYTEDB})
@NotNull
@NotNull Field<R> construct(Field<?>... args)

Create a constructor call for UDTs.