graphql.util

Interface TraverserContext<T>

Type Parameters:

T - type of tree node

All Known Implementing Classes:

SimpleTraverserContext

@PublicApi
public interface TraverserContext<T>

Traversal context

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getInitialData() Used to share something across all TraverserContext.
TraverserContext<T>	getParentContext() Returns parent context.
java.lang.Object	getParentResult() The result of the getParentContext().
java.lang.Object	getResult() The result of this TraverserContext..
<S> S	getVar(java.lang.Class<? super S> key) Obtains a context local variable
boolean	isVisited() Informs that the current node has been already "visited"
void	setResult(java.lang.Object result) Set the result for this TraverserContext.
<S> TraverserContext<T>	setVar(java.lang.Class<? super S> key, S value) Stores a variable in the context
T	thisNode() Returns current node being visited
java.util.Set<T>	visitedNodes() Obtains all visited nodes and values received by the TraverserVisitor.enter(graphql.util.TraverserContext) method

Method Detail

thisNode

T thisNode()

Returns current node being visited

Returns:

current node traverser is visiting

getParentContext

TraverserContext<T> getParentContext()

Returns parent context. Effectively organizes Context objects in a linked list so by following getParentContext() links one could obtain the current path as well as the variables getVar(java.lang.Class) stored in every parent context.

Returns:

context associated with the node parent

getParentResult

java.lang.Object getParentResult()

The result of the getParentContext().

Returns:

isVisited

boolean isVisited()

Informs that the current node has been already "visited"

Returns:

true if a node had been already visited

visitedNodes

java.util.Set<T> visitedNodes()

Obtains all visited nodes and values received by the TraverserVisitor.enter(graphql.util.TraverserContext) method

Returns:

a map containg all nodes visited and values passed when visiting nodes for the first time

getVar

<S> S getVar(java.lang.Class<? super S> key)

Obtains a context local variable

Type Parameters:

S - type of the variable

Parameters:

key - key to lookup the variable value

Returns:

a variable value of null

setVar

<S> TraverserContext<T> setVar(java.lang.Class<? super S> key,
                               S value)

Stores a variable in the context

Type Parameters:

S - type of a varable

Parameters:

key - key to create bindings for the variable

value - value of variable

Returns:

this context to allow operations chaining

setResult

void setResult(java.lang.Object result)

Set the result for this TraverserContext.

Parameters:

result -

getResult

java.lang.Object getResult()

The result of this TraverserContext..

Returns:

getInitialData

java.lang.Object getInitialData()

Used to share something across all TraverserContext.

Returns: