jOOQ 3.18.7 · org.jooq.impl.CustomQueryPart

A base class for custom QueryPart implementations in client code.

Client code may provide proper Condition implementations extending this useful base class. All necessary parts of the Condition interface are already implemented. Only this method needs further implementation: accept(Context).

Refer to that methods' Javadoc for further details about their expected behaviour.

Such custom QueryPart implementations can be useful in any of these scenarios:

When reusing a custom QueryPart in other custom QueryParts, e.g. in CustomCondition, CustomField, CustomTable, etc.
When inlining a custom QueryPart in plain SQL methods, such as DSL#condition(String, QueryPart...), DSL#field(String, QueryPart...), DSL#table(String, QueryPart...)

Modifier and Type	Field and Description
private static final Clause[]	CLAUSES Deprecated as a consequence of `Clause` being deprecated.

Access	Constructor and Description
protected	CustomQueryPart()

Method Summary

Modifier and Type	Method and Description
public abstract void	accept(Context<?> ctx) Redeclares org.jooq.QueryPartInternal.accept. Subclasses must implement this method.
public final Clause[]	clauses(Context<?> ctx) Overrides org.jooq.impl.AbstractQueryPart.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 final boolean	declaresFields() Overrides org.jooq.impl.AbstractQueryPart.declaresFields. Implements org.jooq.QueryPartInternal.declaresFields. Subclasses may override this
public final boolean	declaresTables() Overrides org.jooq.impl.AbstractQueryPart.declaresTables. Implements org.jooq.QueryPartInternal.declaresTables. Subclasses may override this
public static final CustomQueryPart	of(Consumer<? super Context<?>> consumer) Create a `CustomQueryPart` from a lambda expression.

Inherited from org.jooq.impl.AbstractQueryPart:: configuration create create create declaresCTE declaresWindows equals generatesCast hashCode rendersContent toString translate

Field Detail

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

Constructor Detail

CustomQueryPart	back to summary
protected CustomQueryPart()

Method Detail

accept back to summary

accept	back to summary
public abstract void accept(Context<?> ctx) Redeclares org.jooq.QueryPartInternal.accept. Doc from org.jooq.QueryPartInternal.accept. Subclasses must implement this method. This `QueryPart` can `accept` a `Context` object in order to render a SQL string or to bind its variables. Annotations @Override

public abstract void accept(Context<?> ctx)

Redeclares org.jooq.QueryPartInternal.accept.

Doc from org.jooq.QueryPartInternal.accept.

Subclasses must implement this method.

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.AbstractQueryPart.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.AbstractQueryPart.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

declaresFields	back to summary
public final boolean declaresFields() Overrides org.jooq.impl.AbstractQueryPart.declaresFields. Implements org.jooq.QueryPartInternal.declaresFields. Doc from org.jooq.impl.AbstractQueryPart.declaresFields. Subclasses may override this Annotations @Override

declaresFields

back to summary

public final boolean declaresFields()

Overrides org.jooq.impl.AbstractQueryPart.declaresFields.

Implements org.jooq.QueryPartInternal.declaresFields.

Doc from org.jooq.impl.AbstractQueryPart.declaresFields.

Subclasses may override this

Annotations

@Override

declaresTables	back to summary
public final boolean declaresTables() Overrides org.jooq.impl.AbstractQueryPart.declaresTables. Implements org.jooq.QueryPartInternal.declaresTables. Doc from org.jooq.impl.AbstractQueryPart.declaresTables. Subclasses may override this Annotations @Override

declaresTables

back to summary

public final boolean declaresTables()

Overrides org.jooq.impl.AbstractQueryPart.declaresTables.

Implements org.jooq.QueryPartInternal.declaresTables.

Doc from org.jooq.impl.AbstractQueryPart.declaresTables.

Subclasses may override this

Annotations