Top Description Methods
org.jooq

public Interface Parameter<T>

extends Named, Typed<T>
Known Direct Implementers
org.jooq.impl.ParameterImpl
Type Parameters
<T>
The parameter type

A parameter to a stored procedure or function.

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

Author
Lukas Eder

Method Summary

Modifier and TypeMethod and Description
public ParamMode
getParamMode()

Get the parameter mode for this parameter.

public boolean
isDefaulted()

Whether this parameter has a default value

Procedures and functions with defaulted parameters behave slightly different from ones without defaulted parameters.

public boolean
isUnnamed()

Whether this parameter has a name or not.

Inherited from org.jooq.Named:
$namegetCommentgetCommentPartgetNamegetQualifiedNamegetUnqualifiedName
Inherited from org.jooq.Typed:
$dataTypegetBindinggetConvertergetDataTypegetDataTypegetType

Method Detail

getParamModeback to summary
public ParamMode getParamMode()

Get the parameter mode for this parameter.

isDefaultedback to summary
public 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

isUnnamedback to summary
public boolean isUnnamed()

Whether this parameter has a name or not.

Some databases (e.g. SQLDialect#POSTGRES) allow for using unnamed parameters. In this case, getName() will return a synthetic name created from the parameter index.