VisitContext (jOOQ 3.4.5 API)

```
public interface VisitContext
```
A context object for QueryPart traversal passed to registered VisitListener's.

Author:

Lukas Eder

See Also:

VisitListener

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BindContext`	`bindContext()` The underlying `BindContext` or `null`, if the underlying context is a `RenderContext`.
`Clause`	`clause()` The most recent clause that was encountered through `Context.start(Clause)`.
`Clause[]`	`clauses()` A path of clauses going through the visiting tree.
`int`	`clausesLength()` This is the same as calling `clauses().length`.
`Configuration`	`configuration()` The configuration wrapped by this context.
`Context<?>`	`context()` The underlying `RenderContext` or `BindContext` object.
`Map<Object,Object>`	`data()` Get all custom data from this `VisitContext`.
`Object`	`data(Object key)` Get some custom data from this `VisitContext`.
`Object`	`data(Object key, Object value)` Set some custom data to this `VisitContext`.
`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)`.
`QueryPart[]`	`queryParts()` A path of `QueryPart`s going through the visiting tree.
`int`	`queryPartsLength()` This is the same as calling `queryParts().length`.
`RenderContext`	`renderContext()` The underlying `RenderContext` or `null`, if the underlying context is a `BindContext`.

- Method Detail
  - data
```
Map<Object,Object> data()
```
    Get all custom data from this VisitContext.
    This corresponds to Context.data() returned from context().
    
    Returns:
    
    The custom data. This is never null
    
    See Also:
    
    VisitListener
  - data
```
Object data(Object key)
```
    Get some custom data from this VisitContext.
    This corresponds to Context.data(Object) returned from context().
    
    Parameters:
    
    key - A key to identify the custom data
    
    Returns:
    
    The custom data or null if no such data is contained in this VisitListener
    
    See Also:
    
    VisitListener
  - data
```
Object data(Object key,
            Object value)
```
    Set some custom data to this VisitContext.
    This corresponds to Context.data(Object, Object) returned from context().
    
    Parameters:
    
    key - A key to identify the custom data
    
    value - The custom data
    
    Returns:
    
    The previously set custom data or null if no data was previously set for the given key
    
    See Also:
    
    VisitContext
  - configuration
```
Configuration configuration()
```
    The configuration wrapped by this context.
  - clause
```
Clause clause()
```
    The most recent clause that was encountered through Context.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 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
```
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
```
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.
  - queryPartsLength
```
int queryPartsLength()
```
    This is the same as calling queryParts().length.
  - context
```
Context<?> context()
```
    The underlying RenderContext or BindContext object.
  - renderContext
```
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
```
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

Interface VisitContext

Method Summary

Method Detail

data

data

data

configuration

clause

clauses

clausesLength

queryPart

queryPart

queryParts

queryPartsLength

context

renderContext

bindContext