org.jooq

Interface Parameter<T>

Type Parameters:

T - The parameter type

All Superinterfaces:

Adapter, Attachable, Comparable<NamedQueryPart>, NamedQueryPart, NamedTypeProviderQueryPart<T>, QueryPart, Serializable

public interface Parameter<T>
extends NamedTypeProviderQueryPart<T>

A parameter to a stored procedure or function.

Author:

Lukas Eder

Method Summary

Methods

Modifier and Type	Method and Description
DataType<T>	getDataType() The type of this parameter (might not be dialect-specific)
DataType<T>	getDataType(Configuration configuration) The dialect-specific type of this parameter
String	getName() The name of this parameter
Class<? extends T>	getType() The Java type of the parameter.
boolean	isDefaulted() Whether this parameter has a default value Procedures and functions with defaulted parameters behave slightly different from ones without defaulted parameters.

Methods inherited from interface org.jooq.QueryPart

attach

Methods inherited from interface org.jooq.Adapter

internalAPI

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getName

String getName()

The name of this parameter

Specified by:

getName in interface NamedQueryPart

getType

Class<? extends T> getType()

The Java type of the parameter.

Specified by:

getType in interface NamedTypeProviderQueryPart<T>

getDataType

DataType<T> getDataType()

The type of this parameter (might not be dialect-specific)

Specified by:

getDataType in interface NamedTypeProviderQueryPart<T>

getDataType

DataType<T> getDataType(Configuration configuration)

The dialect-specific type of this parameter

Specified by:

getDataType in interface NamedTypeProviderQueryPart<T>

isDefaulted

@Support(value=ORACLE)
boolean isDefaulted()

Whether this parameter has a default value

Procedures and functions with defaulted parameters behave slightly different from ones without defaulted parameters. In PL/SQL and other procedural languages, it is possible to pass parameters by name, reordering names and omitting defaulted parameters:

 CREATE PROCEDURE MY_PROCEDURE (P_DEFAULTED IN NUMBER := 0
                                P_MANDATORY IN NUMBER);

 -- The above procedure can be called as such:
 BEGIN
   -- Assign parameters by index
   MY_PROCEDURE(1, 2);

   -- Assign parameters by name
   MY_PROCEDURE(P_DEFAULTED => 1,
                P_MANDATORY => 2);

   -- Omitting defaulted parameters
   MY_PROCEDURE(P_MANDATORY => 2);
 END;
 

If a procedure has defaulted parameters, jOOQ binds them by name, rather than by index.

Currently, this is only supported for Oracle 11g