graphql.execution

Class ExecutionPath

java.lang.Object

graphql.execution.ExecutionPath

@PublicApi
public class ExecutionPath
extends java.lang.Object

As a graphql query is executed, each field forms a hierarchical path from parent field to child field and this class represents that path as a series of segments.

Method Summary

Modifier and Type	Method and Description
ExecutionPath	append(ExecutionPath path) Appends the provided path to the current one
ExecutionPath	dropSegment() Drops the last segment off the path
boolean	equals(java.lang.Object o)
static ExecutionPath	fromList(java.util.List<?> objects) This will create an execution path from the list of objects
int	getLevel()
ExecutionPath	getPathWithoutListEnd()
java.lang.String	getSegmentName()
int	hashCode()
boolean	isListSegment()
boolean	isNamedSegment()
boolean	isRootPath()
static ExecutionPath	parse(java.lang.String pathString) Parses an execution path from the provided path string in the format /segment1/segment2[index]/segmentN
ExecutionPath	replaceSegment(int segment) Replaces the last segment on the path eg ExecutionPath.parse("/a/b[1]").replaceSegment(9) equals "/a/b[9]"
ExecutionPath	replaceSegment(java.lang.String segment) Replaces the last segment on the path eg ExecutionPath.parse("/a/b[1]").replaceSegment("x") equals "/a/b/x"
static ExecutionPath	rootPath() All paths start from here
ExecutionPath	segment(int segment) Takes the current path and adds a new segment to it, returning a new path
ExecutionPath	segment(java.lang.String segment) Takes the current path and adds a new segment to it, returning a new path
ExecutionPath	sibling(java.lang.String siblingField)
java.util.List<java.lang.Object>	toList()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

rootPath

public static ExecutionPath rootPath()

All paths start from here

Returns:

the root path

getLevel

public int getLevel()

getPathWithoutListEnd

public ExecutionPath getPathWithoutListEnd()

getSegmentName

public java.lang.String getSegmentName()

parse

public static ExecutionPath parse(java.lang.String pathString)

Parses an execution path from the provided path string in the format /segment1/segment2[index]/segmentN

Parameters:

pathString - the path string

Returns:

a parsed execution path

fromList

public static ExecutionPath fromList(java.util.List<?> objects)

This will create an execution path from the list of objects

Parameters:

objects - the path objects

Returns:

a new execution path

segment

public ExecutionPath segment(java.lang.String segment)

Takes the current path and adds a new segment to it, returning a new path

Parameters:

segment - the string path segment to add

Returns:

a new path containing that segment

segment

public ExecutionPath segment(int segment)

Takes the current path and adds a new segment to it, returning a new path

Parameters:

segment - the int path segment to add

Returns:

a new path containing that segment

dropSegment

public ExecutionPath dropSegment()

Drops the last segment off the path

Returns:

a new path with the last segment dropped off

replaceSegment

public ExecutionPath replaceSegment(int segment)

Replaces the last segment on the path eg ExecutionPath.parse("/a/b[1]").replaceSegment(9) equals "/a/b[9]"

Parameters:

segment - the integer segment to use

Returns:

a new path with the last segment replaced

replaceSegment

public ExecutionPath replaceSegment(java.lang.String segment)

Replaces the last segment on the path eg ExecutionPath.parse("/a/b[1]").replaceSegment("x") equals "/a/b/x"

Parameters:

segment - the string segment to use

Returns:

a new path with the last segment replaced

isListSegment

public boolean isListSegment()

Returns:

true if the end of the path has a list style segment eg 'a/b[2]'

isNamedSegment

public boolean isNamedSegment()

Returns:

true if the end of the path has a named style segment eg 'a/b[2]/c'

isRootPath

public boolean isRootPath()

Returns:

true if the path is the rootPath()

append

public ExecutionPath append(ExecutionPath path)

Appends the provided path to the current one

Parameters:

path - the path to append

Returns:

a new path

sibling

public ExecutionPath sibling(java.lang.String siblingField)

toList

public java.util.List<java.lang.Object> toList()

Returns:

converts the path into a list of segments

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

the path as a string which represents the call hierarchy

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object