Top Description Fields Constructors Methods
org.jooq.impl

pack-priv final Class ParameterImpl<T>

extends AbstractField<T>
implements Parameter<T>, UEmpty, TypedReference<T>
Class Inheritance
All Implemented Interfaces
org.jooq.impl.TypedReference, org.jooq.Typed, org.jooq.QueryPart, java.io.Serializable, org.jooq.impl.QOM.UEmpty, org.jooq.Parameter, org.jooq.Named
Static Imports
org.jooq.SQLDialect.POSTGRES, org.jooq.impl.Keywords.K_IN, .Keywords.K_INOUT, .Keywords.K_OUT

Deprecated

as a consequence of AbstractField being deprecated. See corresponding docs for further information.

A common base class for stored procedure parameters
Author
Lukas Eder

Field Summary

Modifier and TypeField and Description
private final boolean
private final boolean
private final ParamMode

Constructor Summary

AccessConstructor and Description
pack-priv
ParameterImpl(ParamMode paramMode, Name name, DataType<T> type)

pack-priv
ParameterImpl(ParamMode paramMode, Name name, DataType<T> type, boolean isDefaulted, boolean isUnnamed)

Deprecated - [#11327] - 3.15.0 - Do not reuse this constructor

Method Summary

Modifier and TypeMethod and Description
public final void
accept(Context<?> ctx)

Implements abstract org.jooq.impl.AbstractField.accept.

Implements org.jooq.QueryPartInternal.accept.

This QueryPart can accept a Context object in order to render a SQL string or to bind its variables.
public final ParamMode
getParamMode()

Implements org.jooq.Parameter.getParamMode.

Get the parameter mode for this parameter.
public final boolean
isDefaulted()

Implements org.jooq.Parameter.isDefaulted.

Whether this parameter has a default value

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

public final boolean
isUnnamed()

Implements org.jooq.Parameter.isUnnamed.

Whether this parameter has a name or not.
Inherited from org.jooq.impl.AbstractField:
$alias$aliasedabsacosaddaddasasasasascasciiasinatanatan2atan2avgavgOverbetweenbetweenbetweenbetweenbetweenSymmetricbetweenSymmetricbetweenSymmetricbetweenSymmetricbitAndbitAndbitLengthbitNandbitNandbitNorbitNorbitNotbitOrbitOrbitXNorbitXNorbitXorbitXorcastcastcastceilchangedcharLengthclausescoalescecoalescecoercecoercecoercecollatecollatecollatecommentcommentcomparecomparecomparecompareconcatconcatconcatcontainscontainscontainsIgnoreCasecontainsIgnoreCaseconvertconvertconvertconvertFromconvertFromconvertToconvertTocoscoshcotcothcountcountDistinctcountOverdecodedecodedecodedecodedegdescdivdivdividedivideendsWithendsWithendsWithIgnoreCaseendsWithIgnoreCaseeqeqeqeqequalequalequalequalequalIgnoreCaseequalIgnoreCaseexpextractfieldfirstValuefloorfromgegegegegetgetValuegreaterOrEqualgreaterOrEqualgreaterOrEqualgreaterOrEqualgreaterThangreaterThangreaterThangreaterThangreatestgreatestgtgtgtgtinininininisDistinctFromisDistinctFromisDistinctFromisDocumentisFalseisJsonisNotDistinctFromisNotDistinctFromisNotDistinctFromisNotDocumentisNotJsonisNotNullisNullisNullableisPossiblyNullableisTruelaglaglaglaglastValueleleleleleadleadleadleadleastleastlengthlessOrEquallessOrEquallessOrEquallessOrEquallessThanlessThanlessThanlessThanlikelikelikelikelikelikeIgnoreCaselikeIgnoreCaselikeIgnoreCaselikeIgnoreCaselikeRegexlikeRegexlnloglowerlpadlpadlpadlpadltltltltltrimmaxmaxOvermedianminminOverminusminusmodmodmodulomodulomulmulmultiplymultiplynenenenenegnotBetweennotBetweennotBetweennotBetweennotBetweenSymmetricnotBetweenSymmetricnotBetweenSymmetricnotBetweenSymmetricnotContainsnotContainsnotContainsIgnoreCasenotContainsIgnoreCasenotEqualnotEqualnotEqualnotEqualnotEqualIgnoreCasenotEqualIgnoreCasenotInnotInnotInnotInnotInnotLikenotLikenotLikenotLikenotLikenotLikeIgnoreCasenotLikeIgnoreCasenotLikeIgnoreCasenotLikeIgnoreCasenotLikeRegexnotLikeRegexnotSimilarTonotSimilarTonotSimilarTonotSimilarTonotSimilarTonullifnullifnullsFirstnullsLastnvlnvlnvl2nvl2octetLengthoriginalparenthesisedpluspluspositionpositionpowpowpowerpowerprojectionSizeradremremrepeatrepeatreplacereplacereplacereplaceresetroundroundrpadrpadrpadrpadrtrimshlshlshrshrsignsimilarTosimilarTosimilarTosimilarTosimilarTosinsinhsortsortsortAscsortAscsortDefaultsortDescsortDescsqrtstartsWithstartsWithstartsWithIgnoreCasestartsWithIgnoreCasestddevPopstddevPopOverstddevSampstddevSampOversubsubsubstringsubstringsubstringsubstringsubtractsubtractsumsumOvertantanhtimestimestrimunaryMinusunaryPlusuppervarPopvarPopOvervarSampvarSampOver

Field Detail

isDefaultedback to summary
private final boolean isDefaulted
isUnnamedback to summary
private final boolean isUnnamed
paramModeback to summary
private final ParamMode paramMode

Constructor Detail

ParameterImplback to summary
pack-priv ParameterImpl(ParamMode paramMode, Name name, DataType<T> type)
ParameterImplback to summary
pack-priv ParameterImpl(ParamMode paramMode, Name name, DataType<T> type, boolean isDefaulted, boolean isUnnamed)

Deprecated

- [#11327] - 3.15.0 - Do not reuse this constructor

Annotations
@Deprecated

Method Detail

acceptback to summary
public final void accept(Context<?> ctx)

Implements abstract org.jooq.impl.AbstractField.accept.

Implements org.jooq.QueryPartInternal.accept.

Doc from org.jooq.QueryPartInternal.accept.

This QueryPart can accept a Context object in order to render a SQL string or to bind its variables.

Annotations
@Override
getParamModeback to summary
public final ParamMode getParamMode()

Implements org.jooq.Parameter.getParamMode.

Doc from org.jooq.Parameter.getParamMode.

Get the parameter mode for this parameter.

Annotations
@Override
isDefaultedback to summary
public final boolean isDefaulted()

Implements org.jooq.Parameter.isDefaulted.

Doc from org.jooq.Parameter.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

Annotations
@Override
isUnnamedback to summary
public final boolean isUnnamed()

Implements org.jooq.Parameter.isUnnamed.

Doc from org.jooq.Parameter.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.

Annotations
@Override