graphql

Class GraphqlErrorBuilder

java.lang.Object

graphql.GraphqlErrorBuilder

@PublicApi
public class GraphqlErrorBuilder
extends java.lang.Object

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

Method Summary

Modifier and Type	Method and Description
GraphQLError	build()
GraphqlErrorBuilder	errorType(ErrorClassification errorType)
GraphqlErrorBuilder	extensions(java.util.Map<java.lang.String,java.lang.Object> extensions)
GraphqlErrorBuilder	location(SourceLocation location)
GraphqlErrorBuilder	locations(java.util.List<SourceLocation> locations)
GraphqlErrorBuilder	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.
GraphqlErrorBuilder	path(ExecutionPath path)
GraphqlErrorBuilder	path(java.util.List<java.lang.Object> 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

Method Detail

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 GraphqlErrorBuilder message(java.lang.String message,
                                   java.lang.Object... formatArgs)

locations

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

location

public GraphqlErrorBuilder location(SourceLocation location)

path

public GraphqlErrorBuilder path(ExecutionPath path)

path

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

errorType

public GraphqlErrorBuilder errorType(ErrorClassification errorType)

extensions

public GraphqlErrorBuilder 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