UDTImpl (jOOQ 3.9.6 API)

java.lang.Object
- org.jooq.impl.UDTImpl<R>

All Implemented Interfaces:

Serializable, QueryPart, QueryPartInternal, UDT<R>
```
public class UDTImpl<R extends UDTRecord<R>>
extends Object
implements UDT<R>
```
A common base type for UDT's
This type is for JOOQ INTERNAL USE only. Do not reference directly

Author:

Lukas Eder

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

UDTImpl(String name, Schema schema)

UDTImpl(String name, Schema schema, Package pkg)

Constructors
Constructor and Description
`UDTImpl(String name, Schema schema)`
`UDTImpl(String name, Schema schema, Package pkg)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`accept(Context<?> ctx)` This `QueryPart` can `accept` a `Context` object in order to render a SQL string or to bind its variables.
`void`	`bind(BindContext context)` Deprecated. - 3.4.0 - [#2694] - Use `QueryPartInternal.accept(Context)` instead.
`Clause[]`	`clauses(Context<?> ctx)` The `Clause`s that are represented by this query part.
`protected DSLContext`	`create()` Internal convenience method
`protected DSLContext`	`create(Configuration configuration)` Internal convenience method
`protected DSLContext`	`create(Context<?> ctx)` Internal convenience method
`protected static <R extends UDTRecord<R>,T> UDTField<R,T>`	`createField(String name, DataType<T> type, UDT<R> udt)` Subclasses may call this method to create `UDTField` objects that are linked to this table.
`protected static <R extends UDTRecord<R>,T> UDTField<R,T>`	`createField(String name, DataType<T> type, UDT<R> udt, String comment)` Subclasses may call this method to create `UDTField` objects that are linked to this table.
`protected static <R extends UDTRecord<R>,T,U> UDTField<R,U>`	`createField(String name, DataType<T> type, UDT<R> udt, String comment, Binding<T,U> binding)` Subclasses may call this method to create `UDTField` objects that are linked to this table.
`protected static <R extends UDTRecord<R>,T,U> UDTField<R,U>`	`createField(String name, DataType<T> type, UDT<R> udt, String comment, Converter<T,U> converter)` Subclasses may call this method to create `UDTField` objects that are linked to this table.
`protected static <R extends UDTRecord<R>,T,X,U> UDTField<R,U>`	`createField(String name, DataType<T> type, UDT<R> udt, String comment, Converter<X,U> converter, Binding<T,X> binding)` Subclasses may call this method to create `UDTField` objects that are linked to this table.
`boolean`	`declaresCTE()` Subclasses may override this
`boolean`	`declaresFields()` Subclasses may override this
`boolean`	`declaresTables()` Subclasses may override this
`boolean`	`declaresWindows()` Subclasses may override this
`boolean`	`equals(Object that)` Check whether this `QueryPart` can be considered equal to another `QueryPart`.
`<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 fieldName)` Get a specific field from this UDT.
`Field<?>`	`field(String string)` Get a specific field from this UDT.
`Field<?>[]`	`fields()` Get all fields from this UDT.
`Field<?>[]`	`fields(Field<?>... f)` 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(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`.
`boolean`	`generatesCast()` Subclasses may override this
`Catalog`	`getCatalog()` Get the UDT catalog.
`DataType<R>`	`getDataType()` The UDT's data type as known to the database.
`String`	`getName()` The name of this UDT.
`Package`	`getPackage()` Get the UDT package.
`Class<R>`	`getRecordType()` Subclasses must override this method if they use the generic type parameter for other types than `Record`
`Schema`	`getSchema()` Get the UDT schema.
`int`	`hashCode()` Generate a hash code from this `QueryPart`.
`boolean`	`isSQLUsable()` Whether this data type can be used from SQL statements.
`R`	`newRecord()` Create a new `Record` of this UDT's type.
`void`	`toSQL(RenderContext context)` Deprecated. - 3.4.0 - [#2694] - Use `QueryPartInternal.accept(Context)` instead.
`String`	`toString()` Render a SQL string of this `QueryPart` For improved debugging, this renders a SQL string of this `QueryPart` with inlined bind variables.
`protected DataAccessException`	`translate(String sql, SQLException e)` Internal convenience method

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jooq.QueryPart
equals, toString

- Constructor Detail
  - UDTImpl
```
public UDTImpl(String name,
               Schema schema)
```
  - UDTImpl
```
public UDTImpl(String name,
               Schema schema,
               Package pkg)
```
- Method Detail
  - getCatalog
```
public final Catalog getCatalog()
```
    Description copied from interface: UDT
    
    Get the UDT catalog.
    
    Specified by:
    
    getCatalog in interface UDT<R extends UDTRecord<R>>
  - getSchema
```
public Schema getSchema()
```
    Description copied from interface: UDT
    
    Get the UDT schema.
    
    Specified by:
    
    getSchema in interface UDT<R extends UDTRecord<R>>
  - getPackage
```
public final Package getPackage()
```
    Description copied from interface: UDT
    
    Get the UDT package.
    
    Specified by:
    
    getPackage in interface UDT<R extends UDTRecord<R>>
  - getName
```
public final String getName()
```
    Description copied from interface: UDT
    
    The name of this UDT.
    
    Specified by:
    
    getName in interface UDT<R extends UDTRecord<R>>
  - fieldsRow
```
public final Row fieldsRow()
```
    Description copied from interface: UDT
    
    Get this UDT's fields as a Row.
    
    Specified by:
    
    fieldsRow in interface UDT<R extends UDTRecord<R>>
  - fieldStream
```
public final java.util.stream.Stream<Field<?>> fieldStream()
```
    Description copied from interface: UDT
    
    Get this table's fields as a Stream.
    
    Specified by:
    
    fieldStream in interface UDT<R extends UDTRecord<R>>
  - field
```
public final <T> Field<T> field(Field<T> field)
```
    Description copied from interface: UDT
    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.
    Specified by:
    
    field in interface UDT<R extends UDTRecord<R>>
    
    See Also:
    
    Row.field(Field)
  - field
```
public final Field<?> field(String string)
```
    Description copied from interface: UDT
    
    Get a specific field from this UDT.
    
    Specified by:
    
    field in interface UDT<R extends UDTRecord<R>>
    
    See Also:
    
    Row.field(String)
  - field
```
public final Field<?> field(Name fieldName)
```
    Description copied from interface: UDT
    
    Get a specific field from this UDT.
    
    Specified by:
    
    field in interface UDT<R extends UDTRecord<R>>
    
    See Also:
    
    Row.field(Name)
  - field
```
public final Field<?> field(int index)
```
    Description copied from interface: UDT
    
    Get a specific field from this UDT.
    
    Specified by:
    
    field in interface UDT<R extends UDTRecord<R>>
    
    See Also:
    
    Row.field(int)
  - fields
```
public final Field<?>[] fields()
```
    Description copied from interface: UDT
    
    Get all fields from this UDT.
    
    Specified by:
    
    fields in interface UDT<R extends UDTRecord<R>>
    
    See Also:
    
    Row.fields()
  - fields
```
public final Field<?>[] fields(Field<?>... f)
```
    Description copied from interface: UDT
    
    Get all fields from this UDT, providing some fields.
    
    Specified by:
    
    fields in interface UDT<R extends UDTRecord<R>>
    
    Returns:
    
    All available fields
    
    See Also:
    
    Row.fields(Field...)
  - fields
```
public final Field<?>[] fields(String... fieldNames)
```
    Description copied from interface: UDT
    
    Get all fields from this UDT, providing some field names.
    
    Specified by:
    
    fields in interface UDT<R extends UDTRecord<R>>
    
    Returns:
    
    All available fields
    
    See Also:
    
    Row.fields(String...)
  - fields
```
public final Field<?>[] fields(Name... fieldNames)
```
    Description copied from interface: UDT
    
    Get all fields from this UDT, providing some field names.
    
    Specified by:
    
    fields in interface UDT<R extends UDTRecord<R>>
    
    Returns:
    
    All available fields
    
    See Also:
    
    Row.fields(Name...)
  - fields
```
public final Field<?>[] fields(int... fieldIndexes)
```
    Description copied from interface: UDT
    
    Get all fields from this UDT, providing some field indexes.
    
    Specified by:
    
    fields in interface UDT<R extends UDTRecord<R>>
    
    Returns:
    
    All available fields
    
    See Also:
    
    Row.fields(int...)
  - getRecordType
```
public Class<R> getRecordType()
```
    Subclasses must override this method if they use the generic type parameter for other types than Record
    
    Specified by:
    
    getRecordType in interface UDT<R extends UDTRecord<R>>
    
    Returns:
    
    The record type produced by this table.
  - isSQLUsable
```
public final boolean isSQLUsable()
```
    Description copied from interface: UDT
    
    Whether this data type can be used from SQL statements.
    
    Specified by:
    
    isSQLUsable in interface UDT<R extends UDTRecord<R>>
  - newRecord
```
public final R newRecord()
```
    Description copied from interface: UDT
    
    Create a new Record of this UDT's type.
    
    Specified by:
    
    newRecord in interface UDT<R extends UDTRecord<R>>
    
    See Also:
    
    DSLContext.newRecord(UDT)
  - getDataType
```
public final DataType<R> getDataType()
```
    Description copied from interface: UDT
    
    The UDT's data type as known to the database.
    
    Specified by:
    
    getDataType in interface UDT<R extends UDTRecord<R>>
  - 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
  - clauses
```
public final Clause[] clauses(Context<?> ctx)
```
    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.
  - createField
```
protected static final <R extends UDTRecord<R>,T> UDTField<R,T> createField(String name,
                                                                            DataType<T> type,
                                                                            UDT<R> udt)
```
    Subclasses may call this method to create UDTField objects that are linked to this table.
    
    Parameters:
    
    name - The name of the field (case-sensitive!)
    
    type - The data type of the field
  - createField
```
protected static final <R extends UDTRecord<R>,T> UDTField<R,T> createField(String name,
                                                                            DataType<T> type,
                                                                            UDT<R> udt,
                                                                            String comment)
```
    Subclasses may call this method to create UDTField objects that are linked to this table.
    
    Parameters:
    
    name - The name of the field (case-sensitive!)
    
    type - The data type of the field
  - createField
```
protected static final <R extends UDTRecord<R>,T,U> UDTField<R,U> createField(String name,
                                                                              DataType<T> type,
                                                                              UDT<R> udt,
                                                                              String comment,
                                                                              Converter<T,U> converter)
```
    Subclasses may call this method to create UDTField objects that are linked to this table.
    
    Parameters:
    
    name - The name of the field (case-sensitive!)
    
    type - The data type of the field
  - createField
```
protected static final <R extends UDTRecord<R>,T,U> UDTField<R,U> createField(String name,
                                                                              DataType<T> type,
                                                                              UDT<R> udt,
                                                                              String comment,
                                                                              Binding<T,U> binding)
```
    Subclasses may call this method to create UDTField objects that are linked to this table.
    
    Parameters:
    
    name - The name of the field (case-sensitive!)
    
    type - The data type of the field
  - createField
```
protected static final <R extends UDTRecord<R>,T,X,U> UDTField<R,U> createField(String name,
                                                                                DataType<T> type,
                                                                                UDT<R> udt,
                                                                                String comment,
                                                                                Converter<X,U> converter,
                                                                                Binding<T,X> binding)
```
    Subclasses may call this method to create UDTField objects that are linked to this table.
    
    Parameters:
    
    name - The name of the field (case-sensitive!)
    
    type - The data type of the field
  - 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
  - toSQL
```
@Deprecated
public final void toSQL(RenderContext context)
```
    Deprecated. - 3.4.0 - [#2694] - Use QueryPartInternal.accept(Context) instead.
    
    Description copied from interface: QueryPartInternal
    
    Render this QueryPart to a SQL string contained in context.sql(). The context will contain additional information about how to render this QueryPart, e.g. whether this QueryPart should be rendered as a declaration or reference, whether this QueryPart's contained bind variables should be inlined or replaced by '?', etc.
    
    Specified by:
    
    toSQL in interface QueryPartInternal
  - bind
```
@Deprecated
public final void bind(BindContext context)
                             throws DataAccessException
```
    Deprecated. - 3.4.0 - [#2694] - Use QueryPartInternal.accept(Context) instead.
    
    Description copied from interface: QueryPartInternal
    
    Bind all parameters of this QueryPart to a PreparedStatement
    This method is for JOOQ INTERNAL USE only. Do not reference directly
    
    Specified by:
    
    bind in interface QueryPartInternal
    
    Parameters:
    
    context - The context holding the next bind index and other information for variable binding
    
    Throws:
    
    DataAccessException - If something went wrong while binding a variable
  - 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
  - generatesCast
```
public boolean generatesCast()
```
    Subclasses may override this
    
    Specified by:
    
    generatesCast in interface QueryPartInternal
  - equals
```
public boolean equals(Object that)
```
    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
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    that - The other QueryPart
    
    Returns:
    
    Whether the two query parts are equal
  - toString
```
public String toString()
```
    Description copied from interface: QueryPart
    
    Render a SQL string of this QueryPart
    For improved debugging, this renders a SQL string of this QueryPart with inlined bind variables. If you wish to gain more control over the concrete SQL rendering of this QueryPart, use DSLContext.renderContext() to obtain a configurable render context for SQL rendering.
    
    Specified by:
    
    toString in interface QueryPart
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A SQL string representation of this QueryPart
  - create
```
protected final DSLContext create()
```
    Internal convenience method
  - create
```
protected final DSLContext create(Configuration configuration)
```
    Internal convenience method
  - create
```
protected final DSLContext create(Context<?> ctx)
```
    Internal convenience method
  - translate
```
protected final DataAccessException translate(String sql,
                                              SQLException e)
```
    Internal convenience method

Class UDTImpl<R extends UDTRecord<R>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.jooq.QueryPart

Constructor Detail

UDTImpl

UDTImpl

Method Detail

getCatalog

getSchema

getPackage

getName

fieldsRow

fieldStream

field

field

field

field

fields

fields

fields

fields

fields

getRecordType

isSQLUsable

newRecord

getDataType

accept

clauses

createField

createField

createField

createField

createField

hashCode

toSQL

bind

declaresFields

declaresTables

declaresWindows

declaresCTE

generatesCast

equals

toString

create

create

create

translate