Module org.jooq

Package org.jooq

Interface VisitContext

All Superinterfaces:

Scope

public interface VisitContext
extends Scope

A context object for QueryPart traversal passed to registered VisitListener's.

This type is a Scope with whose lifecycle is shared with the parent rendering Context scope. It also shares the latter's Scope.data() map.

Author:

Lukas Eder

See Also:

• VisitListener

Method Summary

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

Methods inherited from interface org.jooq.Scope

configuration, creationTime, data, data, data, dialect, dsl, family, settings

Method Details

clause

@NotNull
@NotNull Clause clause()

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

clauses

@NotNull
@NotNull Clause @NotNull [] clauses()

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.

clausesLength

int clausesLength()

This is the same as calling clauses().length.

queryPart

@NotNull
@NotNull QueryPart queryPart()

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

queryPart

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 - The new QueryPart.

queryParts

@NotNull
@NotNull QueryPart @NotNull [] 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.

queryPartsLength

int queryPartsLength()

This is the same as calling queryParts().length.

context

@NotNull
@NotNull Context<?> context()

The underlying RenderContext or BindContext object.

renderContext

@Nullable
@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.

bindContext

@Nullable
@Nullable BindContext bindContext()
                           throws UnsupportedOperationException

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

Throws:

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