jOOQ 3.18.7 · org.jooq.impl.AbstractParam

Modifier and Type	Field and Description
private static final Clause[]	CLAUSES Hides org.jooq.impl.AbstractField.CLAUSES. Deprecated as a consequence of `Clause` being deprecated.
private boolean	inline
private final String	paramName
pack-priv T	value

Access	Constructor and Description
pack-priv	AbstractParam(T value, DataType<T> type)
pack-priv	AbstractParam(T value, DataType<T> type, String paramName)

Method Summary

Modifier and Type	Method and Description
public final boolean	$inline() Implements org.jooq.Param.$inline. Experimental query object model accessor method, see also `QOM`.
public Param<T>	$inline(boolean inline) Implements org.jooq.Param.$inline. Deprecated as a consequence of `Param` being deprecated. Experimental query object model accessor method, see also `QOM`.
public final T	$value() Implements org.jooq.Param.$value. Experimental query object model accessor method, see also `QOM`.
public Param<T>	$value(T newValue) Implements org.jooq.Param.$value. Deprecated as a consequence of `Param` being deprecated. Experimental query object model accessor method, see also `QOM`.
public 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 Clause[]	clauses(Context<?> ctx) Overrides org.jooq.impl.AbstractField.clauses. Implements org.jooq.QueryPartInternal.clauses. Deprecated as a consequence of `Clause` being deprecated. The `Clause`s that are represented by this query part.
public boolean	equals(Object The other `QueryPart` that) Overrides org.jooq.impl.AbstractNamed.equals. Implements org.jooq.QueryPart.equals, org.jooq.Field.equals. Check whether this `QueryPart` can be considered equal to another `QueryPart`.
public final boolean	generatesCast() Overrides org.jooq.impl.AbstractQueryPart.generatesCast. Implements org.jooq.QueryPartInternal.generatesCast. Check whether this `QueryPart` is able to generate `CAST` expressions around bind variables.
public final ParamMode	getParamMode() Implements org.jooq.Param.getParamMode. The parameter mode.
public final String	getParamName() Implements org.jooq.Param.getParamName. The parameter name.
public final ParamType	getParamType() Implements org.jooq.Param.getParamType. The parameter type.
public final T	getValue() Implements org.jooq.Param.getValue. Get the parameter's underlying value.
public int	hashCode() Overrides org.jooq.impl.AbstractNamed.hashCode. Implements org.jooq.QueryPart.hashCode. Generate a hash code from this `QueryPart`.
public final boolean	isInline() Implements org.jooq.Param.isInline. A flag on the bind value to force it to be inlined in rendered SQL
pack-priv final boolean	isInline(Context<?> ctx)
pack-priv final boolean	isPossiblyNullable() Overrides org.jooq.impl.AbstractField.isPossiblyNullable.
pack-priv static final Name	name(Object value, String paramName) A utility method that generates a field name.
private static final String	name(Object value)
pack-priv final boolean	parenthesised(Context<?> ctx) Overrides org.jooq.impl.AbstractField.parenthesised. [#7362] Subclasses may override this method to indicate that the condition is already parenthesised, or produces syntax that render parentheses around this condition unnecessary.
private static boolean	positive(Object value)
pack-priv final void	setConverted0(Object value) Implements abstract org.jooq.impl.AbstractParamX.setConverted0.
pack-priv final void	setInline0(boolean inline) Implements abstract org.jooq.impl.AbstractParamX.setInline0.

Inherited from org.jooq.impl.AbstractParamX:: setConverted setInline setValue setValue0

CLAUSES	back to summary
private static final Clause[] CLAUSES Hides org.jooq.impl.AbstractField.CLAUSES. Deprecated as a consequence of `Clause` being deprecated. See corresponding docs for further information.

inline	back to summary
private boolean inline

paramName	back to summary
private final String paramName

value	back to summary
pack-priv T value

AbstractParam	back to summary
pack-priv AbstractParam(T value, DataType<T> type)

AbstractParam	back to summary
pack-priv AbstractParam(T value, DataType<T> type, String paramName)

Method Detail

$inline back to summary

$inline	back to summary
public final boolean $inline() Implements org.jooq.Param.$inline. Doc from org.jooq.Param.$inline. Experimental query object model accessor method, see also `QOM`. Subject to change in future jOOQ versions, use at your own risk. Annotations @Override

public final boolean $inline()

Implements org.jooq.Param.$inline.

Doc from org.jooq.Param.$inline.

Experimental query object model accessor method, see also QOM. Subject to change in future jOOQ versions, use at your own risk.

Annotations

@Override

$inline back to summary

$inline	back to summary
public Param<T> $inline(boolean inline) Implements org.jooq.Param.$inline. Doc from org.jooq.Param.$inline. Deprecated as a consequence of `Param` being deprecated. See corresponding docs for further information. Experimental query object model accessor method, see also `QOM`. Subject to change in future jOOQ versions, use at your own risk. Annotations @Override

public Param<T> $inline(boolean inline)

Implements org.jooq.Param.$inline.

Doc from org.jooq.Param.$inline.

Deprecated

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

Experimental query object model accessor method, see also QOM. Subject to change in future jOOQ versions, use at your own risk.

Annotations

@Override

$value back to summary

$value	back to summary
public final T $value() Implements org.jooq.Param.$value. Doc from org.jooq.Param.$value. Experimental query object model accessor method, see also `QOM`. Subject to change in future jOOQ versions, use at your own risk. Annotations @Override

public final T $value()

Implements org.jooq.Param.$value.

Doc from org.jooq.Param.$value.

Experimental query object model accessor method, see also QOM. Subject to change in future jOOQ versions, use at your own risk.

Annotations

@Override

$value back to summary

$value	back to summary
public Param<T> $value(T newValue) Implements org.jooq.Param.$value. Doc from org.jooq.Param.$value. Deprecated as a consequence of `Param` being deprecated. See corresponding docs for further information. Experimental query object model accessor method, see also `QOM`. Subject to change in future jOOQ versions, use at your own risk. Annotations @Override

public Param<T> $value(T newValue)

Implements org.jooq.Param.$value.

Doc from org.jooq.Param.$value.

Deprecated

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

Experimental query object model accessor method, see also QOM. Subject to change in future jOOQ versions, use at your own risk.

Annotations

@Override

accept back to summary

accept	back to summary
public 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

public 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

clauses back to summary

clauses	back to summary
public final Clause[] clauses(Context<?> ctx) Overrides org.jooq.impl.AbstractField.clauses. Implements org.jooq.QueryPartInternal.clauses. Doc from org.jooq.QueryPartInternal.clauses. Deprecated as a consequence of `Clause` being deprecated. See corresponding docs for further information. The `Clause`s that are represented by this query part. `QueryPart`s can specify several `Clause`s 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 Returns:Clause[] The `Clause`s represented by this query part or `null` or an empty array if this query part does not represent a clause. Annotations @Override

public final Clause[] clauses(Context<?> ctx)

Overrides org.jooq.impl.AbstractField.clauses.

Implements org.jooq.QueryPartInternal.clauses.

Doc from org.jooq.QueryPartInternal.clauses.

Deprecated

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

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

Returns:Clause[]

The Clauses represented by this query part or null or an empty array if this query part does not represent a clause.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object that) Overrides org.jooq.impl.AbstractNamed.equals. Implements org.jooq.QueryPart.equals, org.jooq.Field.equals. Doc from org.jooq.QueryPart.equals. Check whether this `QueryPart` can be considered equal to another `QueryPart`. In general, `QueryPart` equality is defined in terms of `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 `toString()` is an expensive operation, if called many times. Parameters that:Object The other `QueryPart` Returns:boolean Whether the two query parts are equal Annotations @Override

public boolean equals(Object that)

Overrides org.jooq.impl.AbstractNamed.equals.

Implements org.jooq.QueryPart.equals, org.jooq.Field.equals.

Doc from org.jooq.QueryPart.equals.

Check whether this QueryPart can be considered equal to another QueryPart.

In general, QueryPart equality is defined in terms of 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 toString() is an expensive operation, if called many times.

Parameters

that:Object: The other QueryPart

Returns:boolean

Whether the two query parts are equal

Annotations

@Override

generatesCast back to summary

generatesCast	back to summary
public final boolean generatesCast() Overrides org.jooq.impl.AbstractQueryPart.generatesCast. Implements org.jooq.QueryPartInternal.generatesCast. Doc from org.jooq.QueryPartInternal.generatesCast. Check whether this `QueryPart` is able to generate `CAST` expressions around bind variables. This method can be used by any `Context` to check how a certain SQL clause should be rendered. This method is for JOOQ INTERNAL USE only. Do not reference directly Annotations @Override

public final boolean generatesCast()

Overrides org.jooq.impl.AbstractQueryPart.generatesCast.

Implements org.jooq.QueryPartInternal.generatesCast.

Doc from org.jooq.QueryPartInternal.generatesCast.

Check whether this QueryPart is able to generate CAST expressions around bind variables.

This method can be used by any Context to check how a certain SQL clause should be rendered.

This method is for JOOQ INTERNAL USE only. Do not reference directly

Annotations

@Override

getParamMode	back to summary
public final ParamMode getParamMode() Implements org.jooq.Param.getParamMode. Doc from org.jooq.Param.getParamMode. The parameter mode. Annotations @Override

getParamMode

back to summary

public final ParamMode getParamMode()

Implements org.jooq.Param.getParamMode.

Doc from org.jooq.Param.getParamMode.

The parameter mode.

Annotations

@Override

getParamName back to summary

getParamName	back to summary
public final String getParamName() Implements org.jooq.Param.getParamName. Doc from org.jooq.Param.getParamName. The parameter name. This name is useful for two things: Named parameters in frameworks that support them, such as Spring's `JdbcTemplate` Accessing the parameter from the `Query` API, with `Query#getParam(String)`, `Query#getParams()` Annotations @Override

public final String getParamName()

Implements org.jooq.Param.getParamName.

Doc from org.jooq.Param.getParamName.

The parameter name. This name is useful for two things:

Named parameters in frameworks that support them, such as Spring's JdbcTemplate
Accessing the parameter from the Query API, with Query#getParam(String), Query#getParams()

Annotations

@Override

getParamType	back to summary
public final ParamType getParamType() Implements org.jooq.Param.getParamType. Doc from org.jooq.Param.getParamType. The parameter type. Annotations @Override

getParamType

back to summary

public final ParamType getParamType()

Implements org.jooq.Param.getParamType.

Doc from org.jooq.Param.getParamType.

The parameter type.

Annotations

@Override

getValue back to summary

getValue	back to summary
public final T getValue() Implements org.jooq.Param.getValue. Doc from org.jooq.Param.getValue. Get the parameter's underlying value. This returns `null` if no value has been set yet. Annotations @Override

public final T getValue()

Implements org.jooq.Param.getValue.

Doc from org.jooq.Param.getValue.

Get the parameter's underlying value. This returns null if no value has been set yet.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides org.jooq.impl.AbstractNamed.hashCode. Implements org.jooq.QueryPart.hashCode. Doc from org.jooq.QueryPart.hashCode. Generate a hash code from this `QueryPart`. In general, `QueryPart` hash codes are the same as the hash codes generated from `toString()`. This guarantees consistent behaviour with `equals(Object)` Some `QueryPart` implementations may choose to override this behaviour for improved performance, as `toString()` is an expensive operation, if called many times. Returns:int The `QueryPart` hash code Annotations @Override

public int hashCode()

Overrides org.jooq.impl.AbstractNamed.hashCode.

Implements org.jooq.QueryPart.hashCode.

Doc from org.jooq.QueryPart.hashCode.

Generate a hash code from this QueryPart.

In general, QueryPart hash codes are the same as the hash codes generated from toString(). This guarantees consistent behaviour with equals(Object)

Some QueryPart implementations may choose to override this behaviour for improved performance, as toString() is an expensive operation, if called many times.

Returns:int

The QueryPart hash code

Annotations

@Override

isInline	back to summary
public final boolean isInline() Implements org.jooq.Param.isInline. Doc from org.jooq.Param.isInline. A flag on the bind value to force it to be inlined in rendered SQL Annotations @Override

isInline

back to summary

public final boolean isInline()

Implements org.jooq.Param.isInline.

Doc from org.jooq.Param.isInline.

A flag on the bind value to force it to be inlined in rendered SQL

Annotations

@Override

isInline	back to summary
pack-priv final boolean isInline(Context<?> ctx)

isPossiblyNullable	back to summary
pack-priv final boolean isPossiblyNullable() Overrides org.jooq.impl.AbstractField.isPossiblyNullable. Annotations @Override

isPossiblyNullable

back to summary

pack-priv final boolean isPossiblyNullable()

Overrides org.jooq.impl.AbstractField.isPossiblyNullable.

Annotations

@Override

name back to summary

name	back to summary
pack-priv static final Name name(Object value, String paramName) A utility method that generates a field name. If `paramName != null`, take `paramName` Otherwise, take the string value of `value`

pack-priv static final Name name(Object value, String paramName)

A utility method that generates a field name.

If paramName != null, take paramName
Otherwise, take the string value of value

name	back to summary
private static final String name(Object value)

parenthesised back to summary

parenthesised	back to summary
pack-priv final boolean parenthesised(Context<?> ctx) Overrides org.jooq.impl.AbstractField.parenthesised. Doc from org.jooq.impl.AbstractField.parenthesised. [#7362] Subclasses may override this method to indicate that the condition is already parenthesised, or produces syntax that render parentheses around this condition unnecessary. This can help prevent excess parentheses, e.g. when this condition is wrapped in `QOM.Not`, `QOM.BitNot`, or `QOM.Neg` Annotations @Override

pack-priv final boolean parenthesised(Context<?> ctx)

Overrides org.jooq.impl.AbstractField.parenthesised.

Doc from org.jooq.impl.AbstractField.parenthesised.

[#7362] Subclasses may override this method to indicate that the condition is already parenthesised, or produces syntax that render parentheses around this condition unnecessary.

This can help prevent excess parentheses, e.g. when this condition is wrapped in QOM.Not, QOM.BitNot, or QOM.Neg

Annotations

@Override

positive	back to summary
private static boolean positive(Object value)

setConverted0	back to summary
pack-priv final void setConverted0(Object value) Implements abstract org.jooq.impl.AbstractParamX.setConverted0. Annotations @Override

setConverted0

back to summary

pack-priv final void setConverted0(Object value)

Implements abstract org.jooq.impl.AbstractParamX.setConverted0.

Annotations

@Override

setInline0	back to summary
pack-priv final void setInline0(boolean inline) Implements abstract org.jooq.impl.AbstractParamX.setInline0. Annotations @Override

setInline0

back to summary

pack-priv final void setInline0(boolean inline)

Implements abstract org.jooq.impl.AbstractParamX.setInline0.

Annotations

@Override

pack-priv abstract Class AbstractParam<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail