Package graphql

Interface GraphQLError.Builder<B extends GraphQLError.Builder<B>>

All Known Implementing Classes:

GraphqlErrorBuilder

Enclosing interface:

GraphQLError

public static interface GraphQLError.Builder<B extends GraphQLError.Builder<B>>

A builder of GraphQLErrors

Method Summary

Modifier and Type	Method	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
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
B	path(@Nullable ResultPath path)	Sets the path of the message
B	path(@Nullable java.util.List<java.lang.Object> path)	Sets the path of the message

Method Detail

message

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

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

Parameters:

message - the message

formatArgs - the arguments to use

Returns:

this builder

locations

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

This adds locations to the error

Parameters:

locations - the locations to add

Returns:

this builder

location

B location(@Nullable
           @Nullable SourceLocation location)

This adds a location to the error

Parameters:

location - the locations to add

Returns:

this builder

path

B path(@Nullable
       @Nullable ResultPath path)

Sets the path of the message

Parameters:

path - can be null

Returns:

this builder

path

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

Sets the path of the message

Parameters:

path - can be null

Returns:

this builder

errorType

B errorType(ErrorClassification errorType)

Sets the ErrorClassification of the message

Parameters:

errorType - the error classification to use

Returns:

this builder

extensions

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

Sets the extensions of the message

Parameters:

extensions - the extensions to use

Returns:

this builder

build

GraphQLError build()

Returns:

a newly built GraphqlError