graphql

Class GraphqlErrorBuilder<B extends GraphqlErrorBuilder<?>>

java.lang.Object

graphql.GraphqlErrorBuilder<B>

Type Parameters:

B - this base class allows you to derive new classes from this base error builder

@PublicApi
public class GraphqlErrorBuilder<B extends GraphqlErrorBuilder<?>>
extends java.lang.Object

This helps you build GraphQLErrors and also has a quick way to make a DataFetcherResults from that error.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GraphqlErrorBuilder()

Method Summary

Modifier and Type	Method and Description
GraphQLError	build()
B	errorType(ErrorClassification errorType)
B	extensions(java.util.Map<java.lang.String,java.lang.Object> extensions)
ErrorClassification	getErrorType()
java.util.Map<java.lang.String,java.lang.Object>	getExtensions()
java.util.List<SourceLocation>	getLocations()
java.lang.String	getMessage()
java.util.List<java.lang.Object>	getPath()
B	location(SourceLocation location)
B	locations(java.util.List<SourceLocation> locations)
B	message(java.lang.String message, java.lang.Object... formatArgs)
static GraphqlErrorBuilder<?>	newError()
static GraphqlErrorBuilder<?>	newError(DataFetchingEnvironment dataFetchingEnvironment) This will set up the GraphQLError.getLocations() and GraphQLError.getPath() for you from the fetching environment.
B	path(java.util.List<java.lang.Object> path)
B	path(ResultPath path)
DataFetcherResult<?>	toResult() A helper method that allows you to return this error as a DataFetcherResult

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GraphqlErrorBuilder

protected GraphqlErrorBuilder()

Method Detail

getMessage

public java.lang.String getMessage()

getPath

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

getLocations

public java.util.List<SourceLocation> getLocations()

getErrorType

public ErrorClassification getErrorType()

getExtensions

public java.util.Map<java.lang.String,java.lang.Object> getExtensions()

newError

public static GraphqlErrorBuilder<?> newError()

Returns:

a builder of GraphQLErrors

newError

public static GraphqlErrorBuilder<?> newError(DataFetchingEnvironment dataFetchingEnvironment)

This will set up the GraphQLError.getLocations() and GraphQLError.getPath() for you from the fetching environment.

Parameters:

dataFetchingEnvironment - the data fetching environment

Returns:

a builder of GraphQLErrors

message

public B message(java.lang.String message,
                 java.lang.Object... formatArgs)

locations

public B locations(java.util.List<SourceLocation> locations)

location

public B location(SourceLocation location)

path

public B path(ResultPath path)

path

public B path(java.util.List<java.lang.Object> path)

errorType

public B errorType(ErrorClassification errorType)

extensions

public B extensions(java.util.Map<java.lang.String,java.lang.Object> extensions)

build

public GraphQLError build()

Returns:

a newly built GraphqlError

toResult

public DataFetcherResult<?> toResult()

A helper method that allows you to return this error as a DataFetcherResult

Returns:

a new data fetcher result that contains the built error