jOOQ 3.18.7 · org.jooq.VisitContext

Method Summary

Modifier and Type	Method and Description
public @Nullable BindContext	bindContext() The underlying `BindContext` or `null`, if the underlying context is a `RenderContext`.
public @NotNull Clause	clause() Deprecated as a consequence of `Clause` being deprecated. The most recent clause that was encountered through `Context#start(Clause)`.
public @NotNull @NotNull Clause[]	clauses() Deprecated as a consequence of `Clause` being deprecated. A path of clauses going through the visiting tree.
public int	clausesLength() This is the same as calling `clauses().length`.
public @NotNull Context<?>	context() The underlying `RenderContext` or `BindContext` object.
public @NotNull QueryPart	queryPart() The most recent `QueryPart` that was encountered through `Context#visit(QueryPart)`.
public void	queryPart(QueryPart The new `QueryPart`. part) Replace the most recent `QueryPart` that was encountered through `Context#visit(QueryPart)`.
public @NotNull @NotNull QueryPart[]	queryParts() A path of `QueryPart`s going through the visiting tree.
public int	queryPartsLength() This is the same as calling `queryParts().length`.
public @Nullable RenderContext	renderContext() The underlying `RenderContext` or `null`, if the underlying context is a `BindContext`.

Inherited from org.jooq.Scope:: configuration creationTime data data data dialect dsl family settings

Method Detail

bindContext back to summary

bindContext	back to summary
public @Nullable BindContext bindContext() throws UnsupportedOperationException The underlying `BindContext` or `null`, if the underlying context is a `RenderContext`. Annotations @Nullable Exceptions UnsupportedOperationException: [#2694] [#2695] As of jOOQ 3.2, this method is not yet implemented as `QueryPart` traversal SPI through `VisitListener` is only implemented for `RenderContext`

public @Nullable BindContext bindContext() throws UnsupportedOperationException

The underlying BindContext or null, if the underlying context is a RenderContext.

Annotations

@Nullable

Exceptions

UnsupportedOperationException:: [#2694] [#2695] As of jOOQ 3.2, this method is not yet implemented as QueryPart traversal SPI through VisitListener is only implemented for RenderContext

clause back to summary

clause	back to summary
public @NotNull Clause clause() Deprecated as a consequence of `Clause` being deprecated. See corresponding docs for further information. The most recent clause that was encountered through `Context#start(Clause)`. Annotations @NotNull

public @NotNull Clause clause()

Deprecated

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

The most recent clause that was encountered through Context#start(Clause).

Annotations

@NotNull

clauses back to summary

clauses	back to summary
public @NotNull @NotNull Clause[] clauses() Deprecated as a consequence of `Clause` being deprecated. See corresponding docs for further information. A path of clauses going through the visiting tree. This returns all previous clauses that were encountered through `Context#start(Clause)` and that haven't been removed yet through `Context#end(Clause)`. In other words, `VisitContext` contains a stack of clauses. Annotations @NotNull

public @NotNull @NotNull Clause[] clauses()

Deprecated

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

A path of clauses going through the visiting tree.

This returns all previous clauses that were encountered through Context#start(Clause) and that haven't been removed yet through Context#end(Clause). In other words, VisitContext contains a stack of clauses.

Annotations

@NotNull

clausesLength	back to summary
public int clausesLength() This is the same as calling `clauses().length`.

context back to summary

context	back to summary
public @NotNull Context<?> context() The underlying `RenderContext` or `BindContext` object. Annotations @NotNull

public @NotNull Context<?> context()

The underlying RenderContext or BindContext object.

Annotations

@NotNull

queryPart back to summary

queryPart	back to summary
public @NotNull QueryPart queryPart() The most recent `QueryPart` that was encountered through `Context#visit(QueryPart)`. Annotations @NotNull

public @NotNull QueryPart queryPart()

The most recent QueryPart that was encountered through Context#visit(QueryPart).

Annotations

@NotNull

queryPart back to summary

queryPart	back to summary
public void queryPart(QueryPart part) Replace the most recent `QueryPart` that was encountered through `Context#visit(QueryPart)`. This method can be called by `VisitListener` implementation methods, in particular by `VisitListener#visitStart(VisitContext)`. Parameters part:QueryPart The new `QueryPart`.

public void queryPart(QueryPart part)

Replace the most recent QueryPart that was encountered through Context#visit(QueryPart).

This method can be called by VisitListener implementation methods, in particular by VisitListener#visitStart(VisitContext).

Parameters

part:QueryPart: The new QueryPart.

queryParts back to summary

queryParts	back to summary
public @NotNull @NotNull QueryPart[] queryParts() A path of `QueryPart`s going through the visiting tree. This returns all previous `QueryParts` that were encountered through `Context#visit(QueryPart)`. In other words, `VisitContext` contains a stack of `QueryParts`. Annotations @NotNull

public @NotNull @NotNull QueryPart[] queryParts()

A path of QueryParts going through the visiting tree.

This returns all previous QueryParts that were encountered through Context#visit(QueryPart). In other words, VisitContext contains a stack of QueryParts.

Annotations

@NotNull

queryPartsLength	back to summary
public int queryPartsLength() This is the same as calling `queryParts().length`.

renderContext back to summary

renderContext	back to summary
public @Nullable RenderContext renderContext() The underlying `RenderContext` or `null`, if the underlying context is a `BindContext`. [#2694] [#2695] As of jOOQ 3.2, the `QueryPart` traversal SPI through `VisitListener` is only implemented for `RenderContext`. Hence, you may need to inline bind values if applicable. Annotations @Nullable

public @Nullable RenderContext renderContext()

The underlying RenderContext or null, if the underlying context is a BindContext.

[#2694] [#2695] As of jOOQ 3.2, the QueryPart traversal SPI through VisitListener is only implemented for RenderContext. Hence, you may need to inline bind values if applicable.

Annotations

@Nullable

public Interface VisitContext

Method Summary

Method Detail