graphql

Class GraphqlErrorBuilder<B extends GraphqlErrorBuilder<B>>

java.lang.Object

graphql.GraphqlErrorBuilder<B>

Type Parameters:

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

All Implemented Interfaces:

GraphQLError.Builder<B>

@PublicApi
public class GraphqlErrorBuilder<B extends GraphqlErrorBuilder<B>>
extends java.lang.Object
implements GraphQLError.Builder<B>

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) Sets the ErrorClassification of the message
B	extensions(@Nullable java.util.Map<java.lang.String,java.lang.Object> extensions) Sets the extensions of the message
ErrorClassification	getErrorType()
@Nullable java.util.Map<java.lang.String,java.lang.Object>	getExtensions()
@Nullable java.util.List<SourceLocation>	getLocations()
java.lang.String	getMessage()
@Nullable java.util.List<java.lang.Object>	getPath()
B	location(@Nullable SourceLocation location) This adds a location to the error
B	locations(@Nullable java.util.List<SourceLocation> locations) This adds locations to the error
B	message(java.lang.String message, java.lang.Object... formatArgs) Sets the message of the error using String.format(String, Object...) with the arguments
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(@Nullable java.util.List<java.lang.Object> path) Sets the path of the message
B	path(@Nullable ResultPath path) Sets the path of the message
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

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

getLocations

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

getErrorType

public ErrorClassification getErrorType()

getExtensions

@Nullable
public @Nullable 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)

Description copied from interface: GraphQLError.Builder

Sets the message of the error using String.format(String, Object...) with the arguments

Specified by:

message in interface GraphQLError.Builder<B extends GraphqlErrorBuilder<B>>

Parameters:

message - the message

formatArgs - the arguments to use

Returns:

this builder

locations

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

Description copied from interface: GraphQLError.Builder

This adds locations to the error

Specified by:

locations in interface GraphQLError.Builder<B extends GraphqlErrorBuilder<B>>

Parameters:

locations - the locations to add

Returns:

this builder

location

public B location(@Nullable
                  @Nullable SourceLocation location)

Description copied from interface: GraphQLError.Builder

This adds a location to the error

Specified by:

location in interface GraphQLError.Builder<B extends GraphqlErrorBuilder<B>>

Parameters:

location - the locations to add

Returns:

this builder

path

public B path(@Nullable
              @Nullable ResultPath path)

Description copied from interface: GraphQLError.Builder

Sets the path of the message

Specified by:

path in interface GraphQLError.Builder<B extends GraphqlErrorBuilder<B>>

Parameters:

path - can be null

Returns:

this builder

path

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

Description copied from interface: GraphQLError.Builder

Sets the path of the message

Specified by:

path in interface GraphQLError.Builder<B extends GraphqlErrorBuilder<B>>

Parameters:

path - can be null

Returns:

this builder

errorType

public B errorType(ErrorClassification errorType)

Description copied from interface: GraphQLError.Builder

Sets the ErrorClassification of the message

Specified by:

errorType in interface GraphQLError.Builder<B extends GraphqlErrorBuilder<B>>

Parameters:

errorType - the error classification to use

Returns:

this builder

extensions

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

Description copied from interface: GraphQLError.Builder

Sets the extensions of the message

Specified by:

extensions in interface GraphQLError.Builder<B extends GraphqlErrorBuilder<B>>

Parameters:

extensions - the extensions to use

Returns:

this builder

build

public GraphQLError build()

Specified by:

build in interface GraphQLError.Builder<B extends GraphqlErrorBuilder<B>>

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