Package org.jooq
Interface VisitContext
-
- All Superinterfaces:
Scope
public interface VisitContext extends Scope
A context object forQueryPart
traversal passed to registeredVisitListener
's.- Author:
- Lukas Eder
- See Also:
VisitListener
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description BindContext
bindContext()
Clause
clause()
The most recent clause that was encountered throughContext.start(Clause)
.Clause[]
clauses()
A path of clauses going through the visiting tree.int
clausesLength()
This is the same as callingclauses()
.length
.Context<?>
context()
The underlyingRenderContext
orBindContext
object.QueryPart
queryPart()
The most recentQueryPart
that was encountered throughContext.visit(QueryPart)
.void
queryPart(QueryPart part)
Replace the most recentQueryPart
that was encountered throughContext.visit(QueryPart)
.QueryPart[]
queryParts()
A path ofQueryPart
s going through the visiting tree.int
queryPartsLength()
This is the same as callingqueryParts()
.length
.RenderContext
renderContext()
-
-
-
Method Detail
-
clause
Clause clause()
The most recent clause that was encountered throughContext.start(Clause)
.
-
clauses
Clause[] 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 throughContext.end(Clause)
. In other words,VisitContext
contains a stack of clauses.
-
clausesLength
int clausesLength()
This is the same as callingclauses()
.length
.
-
queryPart
QueryPart queryPart()
The most recentQueryPart
that was encountered throughContext.visit(QueryPart)
.
-
queryPart
void queryPart(QueryPart part)
Replace the most recentQueryPart
that was encountered throughContext.visit(QueryPart)
.This method can be called by
VisitListener
implementation methods, in particular byVisitListener.visitStart(VisitContext)
.- Parameters:
part
- The newQueryPart
.
-
queryParts
QueryPart[] queryParts()
A path ofQueryPart
s going through the visiting tree.This returns all previous
QueryParts
that were encountered throughContext.visit(QueryPart)
. In other words,VisitContext
contains a stack ofQueryParts
.
-
queryPartsLength
int queryPartsLength()
This is the same as callingqueryParts()
.length
.
-
context
Context<?> context()
The underlyingRenderContext
orBindContext
object.
-
renderContext
RenderContext renderContext()
The underlyingRenderContext
ornull
, if the underlying context is aBindContext
.[#2694] [#2695] As of jOOQ 3.2, the
QueryPart
traversal SPI throughVisitListener
is only implemented forRenderContext
. Hence, you may need to inline bind values if applicable.
-
bindContext
BindContext bindContext() throws java.lang.UnsupportedOperationException
- Throws:
java.lang.UnsupportedOperationException
- [#2694] [#2695] As of jOOQ 3.2, this method is not yet implemented asQueryPart
traversal SPI throughVisitListener
is only implemented forRenderContext
-
-