Module org.jooq

Package org.jooq.impl

Class DefaultBinding<T,U>

java.lang.Object

org.jooq.impl.DefaultBinding<T,U>

All Implemented Interfaces:

Serializable, Binding<T,U>

public class DefaultBinding<T,U>
extends Object
implements Binding<T,U>

Author:

Lukas Eder

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultBinding.SdoElemInfoArray
static class	DefaultBinding.SdoGeometryRecord
static class	DefaultBinding.SdoOrdinateArray
static class	DefaultBinding.SdoPointTypeRecord

Constructor Summary

Constructors

Constructor	Description
DefaultBinding(Binding<T,U> delegate)	Deprecated, for removal: This API element is subject to removal in a future version. - 3.21.0 - [#19125] - This class will be removed from public API, do not reuse.
DefaultBinding(Converter<T,U> converter)	Deprecated, for removal: This API element is subject to removal in a future version. - 3.11 - [#6631] - Use binding(Converter) instead.

Method Summary

Modifier and Type	Method	Description
Binding<T[],U[]>	arrayBinding()	Get an array binding for this binding, or null if no such array binding is available.
Binding<?,?>	arrayComponentBinding()	Get an array component binding for this binding, or null if this binding isn't for an array type.
static final <T, U> Binding<T,U>	binding(Converter<T,U> converter)	Get the internal default binding for a Converter.
static final <T> Binding<T,T>	binding(DataType<T> dataType)	Get the internal default binding for a DataType.
Converter<T,U>	converter()	A converter that can convert between the database type and the custom type.
Formatter	formatter()	Get an optional Formatter implementation, instructing jOOQ on how to embed the user type in SQLDataType.JSON, SQLDataType.JSONB, and SQLDataType.XML contexts.
void	get(BindingGetResultSetContext<U> ctx)	Get a ResultSet's OUT value.
void	get(BindingGetSQLInputContext<U> ctx)	Get a SQLInput's OUT value.
void	get(BindingGetStatementContext<U> ctx)	Get a CallableStatement's OUT value.
void	register(BindingRegisterContext<U> ctx)	Register a CallableStatement's OUT parameter.
void	set(BindingSetSQLOutputContext<U> ctx)	Set a SQLOutput's IN parameter.
void	set(BindingSetStatementContext<U> ctx)	Set a PreparedStatement's IN parameter.
void	sql(BindingSQLContext<U> ctx)	Generate SQL code for the bind variable.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultBinding

@Deprecated(forRemoval=true)
public DefaultBinding(Converter<T,U> converter)

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

- 3.11 - [#6631] - Use binding(Converter) instead.

DefaultBinding

@Deprecated(forRemoval=true)
public DefaultBinding(Binding<T,U> delegate)

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

- 3.21.0 - [#19125] - This class will be removed from public API, do not reuse.

Method Details

binding

public static final <T,
U> Binding<T,U> binding(Converter<T,U> converter)

Get the internal default binding for a Converter.

binding

public static final <T> Binding<T,T> binding(DataType<T> dataType)

Get the internal default binding for a DataType.

formatter

public Formatter formatter()

Description copied from interface: Binding

Get an optional Formatter implementation, instructing jOOQ on how to embed the user type in SQLDataType.JSON, SQLDataType.JSONB, and SQLDataType.XML contexts.

This may be necessary when embedding user-defined types in DSL.multiset(TableLike) queries, when the user-defined type serialises differently in a NestedCollectionEmulation.JSONB emulation than standalone, for example.

A null formatter will have no effect on generated SQL.

Note: while it is possible to implement a custom formatter for array types, it is usually simpler to just delegate to the Binding.arrayComponentBinding() for this, and let jOOQ's internals handle the intricate mapping of generic arrays to XML or JSON.

Specified by:

formatter in interface Binding<T,U>

arrayBinding

public Binding<T[],U[]> arrayBinding()

Description copied from interface: Binding

Get an array binding for this binding, or null if no such array binding is available.

Specified by:

arrayBinding in interface Binding<T,U>

arrayComponentBinding

public Binding<?,?> arrayComponentBinding()

Description copied from interface: Binding

Get an array component binding for this binding, or null if this binding isn't for an array type.

Implementations must ensure that the resulting type is Binding<X, Y>, if this Binding's type variables resolve to T = X[] and U = Y[], as this cannot be enforced by the Java compiler.

Specified by:

arrayComponentBinding in interface Binding<T,U>

converter

public Converter<T,U> converter()

Description copied from interface: Binding

A converter that can convert between the database type and the custom type.

While the Converter property of a binding is not optional (Converter.fromType() and Converter.toType() are needed by jOOQ's internals), the conversion implementation (i.e. Converter.from(Object) and Converter.to(Object)) isn't strictly required if implementations don't rely on it. If these conversion implementations are non-functional, it is advised to hint at this fact in Converter.fromSupported() and Converter.toSupported().

Specified by:

converter in interface Binding<T,U>

sql

public void sql(BindingSQLContext<U> ctx)
         throws SQLException

Description copied from interface: Binding

Generate SQL code for the bind variable.

Implementations should generate SQL code onto BindingSQLContext.render(), given the context's bind variable located at BindingSQLContext.value(). Examples of such SQL code are:

• "?": Default implementations can simply generate a question mark.
  
  
• "123": Implementations may choose to inline bind variables to influence execution plan generation.
  
  Context.paramType() contains information whether inlined bind variables are expected in the current context.
  
  
• "CAST(? AS DATE)": Cast a database to a more specific type. This can be useful in databases like Oracle, which map both DATE and TIMESTAMP SQL types to Timestamp.
  
  Context.castMode() may contain some hints about whether casting is suggested in the current context.
  
  
• "?::json": Vendor-specific bind variables can be supported, e.g. SQLDialect.POSTGRES's JSON data type.

Implementations must provide consistent behaviour between Binding.sql(BindingSQLContext) and Binding.set(BindingSetStatementContext), i.e. when bind variables are inlined, then they must not be bound to the PreparedStatement in Binding.set(BindingSetStatementContext)

Specified by:

sql in interface Binding<T,U>

Parameters:

ctx - The context object containing all argument objects.

Throws:

SQLException - Implementations are allowed to pass on all SQLExceptions to the caller to be wrapped in DataAccessExceptions.

register

public void register(BindingRegisterContext<U> ctx)
              throws SQLException

Description copied from interface: Binding

Register a CallableStatement's OUT parameter.

Specified by:

register in interface Binding<T,U>

Parameters:

ctx - The context object containing all argument objects.

Throws:

SQLException - Implementations are allowed to pass on all SQLExceptions to the caller to be wrapped in DataAccessExceptions.

set

public void set(BindingSetStatementContext<U> ctx)
         throws SQLException

Description copied from interface: Binding

Set a PreparedStatement's IN parameter.

Specified by:

set in interface Binding<T,U>

Parameters:

ctx - The context object containing all argument objects.

Throws:

SQLException - Implementations are allowed to pass on all SQLExceptions to the caller to be wrapped in DataAccessExceptions.

set

public void set(BindingSetSQLOutputContext<U> ctx)
         throws SQLException

Description copied from interface: Binding

Set a SQLOutput's IN parameter.

Specified by:

set in interface Binding<T,U>

Parameters:

ctx - The context object containing all argument objects.

Throws:

SQLException - Implementations are allowed to pass on all SQLExceptions to the caller to be wrapped in DataAccessExceptions.

get

public void get(BindingGetResultSetContext<U> ctx)
         throws SQLException

Description copied from interface: Binding

Get a ResultSet's OUT value.

Implementations are expected to produce a value by calling BindingGetResultSetContext.value(Object), passing the resulting value to the method.

Specified by:

get in interface Binding<T,U>

Parameters:

ctx - The context object containing all argument objects.

Throws:

SQLException - Implementations are allowed to pass on all SQLExceptions to the caller to be wrapped in DataAccessExceptions.

get

public void get(BindingGetStatementContext<U> ctx)
         throws SQLException

Description copied from interface: Binding

Get a CallableStatement's OUT value.

Implementations are expected to produce a value by calling BindingGetStatementContext.value(Object), passing the resulting value to the method.

Specified by:

get in interface Binding<T,U>

Parameters:

ctx - The context object containing all argument objects.

Throws:

SQLException - Implementations are allowed to pass on all SQLExceptions to the caller to be wrapped in DataAccessExceptions.

get

public void get(BindingGetSQLInputContext<U> ctx)
         throws SQLException

Description copied from interface: Binding

Get a SQLInput's OUT value.

Implementations are expected to produce a value by calling BindingGetSQLInputContext.value(Object), passing the resulting value to the method.

Specified by:

get in interface Binding<T,U>

Parameters:

ctx - The context object containing all argument objects.

Throws:

SQLException - Implementations are allowed to pass on all SQLExceptions to the caller to be wrapped in DataAccessExceptions.

toString

public String toString()

Overrides:

toString in class Object