Module com.graphql_java_generator.graphql_maven_plugin_project.graphql_java_client_runtime

Package com.graphql_java_generator.client.response

Class Error

java.lang.Object

com.graphql_java_generator.client.response.Error

All Implemented Interfaces:

graphql.GraphQLError, Serializable

public class Error
extends Object
implements graphql.GraphQLError

The error POJO, mapped from the GraphQL server response, when an error occurs

Author:

etienne-sf

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface graphql.GraphQLError

graphql.GraphQLError.Builder<B extends graphql.GraphQLError.Builder<B>>

Field Summary

Fields

Modifier and Type	Field	Description
String	description
String	errorType
com.fasterxml.jackson.databind.JsonNode	extensions	The extensions field of errors, stored as is from the incoming GraphQL response.
List<Location>	locations
String	message
List<String>	path
List<String>	queryPath
String	validationErrorType

Constructor Summary

Constructors

Constructor	Description
Error()

Method Summary

Modifier and Type	Method	Description
graphql.ErrorClassification	getErrorType()
Map<String,Object>	getExtensions()
com.fasterxml.jackson.databind.JsonNode	getExtensionsAsJsonNode()
Map<String,com.fasterxml.jackson.databind.JsonNode>	getExtensionsAsMapOfJsonNode()	Returns the extensions as a map.
Map<String,String>	getExtensionsAsMapStringString()	Returns the extensions as a map.
<T> T	getExtensionsField(String key, Class<T> t)	Parse the value for the given _key_, as found in the extensions field of the GraphQL server's response, into the given _t_ class.
List<graphql.language.SourceLocation>	getLocations()
String	getMessage()
void	setExtensions(com.fasterxml.jackson.databind.JsonNode extensions)
String	toString()	Logs this error to the given Logger

Methods inherited from class java.lang.Object

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

Methods inherited from interface graphql.GraphQLError

getPath, toSpecification

Field Details

message

public String message

locations

public List<Location> locations

description

public String description

validationErrorType

public String validationErrorType

queryPath

public List<String> queryPath

errorType

public String errorType

path

public List<String> path

extensions

public com.fasterxml.jackson.databind.JsonNode extensions

The extensions field of errors, stored as is from the incoming GraphQL response. It can be retrieved thanks to one of these methods: getExtensions(), getExtensionsAsJsonNode(), getExtensionsAsMapOfJsonNode(), getExtensionsField(String, Class)

Constructor Details

Error

public Error()

Method Details

toString

public String toString()

Logs this error to the given Logger

Overrides:

toString in class Object

Parameters:

logger -

getExtensionsAsJsonNode

public com.fasterxml.jackson.databind.JsonNode getExtensionsAsJsonNode()

setExtensions

public void setExtensions(com.fasterxml.jackson.databind.JsonNode extensions)

getExtensions

public Map<String,Object> getExtensions()

Specified by:

getExtensions in interface graphql.GraphQLError

getExtensionsAsMapOfJsonNode

public Map<String,com.fasterxml.jackson.databind.JsonNode> getExtensionsAsMapOfJsonNode()

Returns the extensions as a map. The values can't be deserialized, as their type is unknown.

Returns:

getExtensionsAsMapStringString

public Map<String,String> getExtensionsAsMapStringString()

Returns the extensions as a map. The values can't be deserialized, as their type is unknown.

Returns:

getExtensionsField

public <T> T getExtensionsField(String key,
 Class<T> t)
                         throws com.fasterxml.jackson.core.JsonProcessingException

Parse the value for the given _key_, as found in the extensions field of the GraphQL server's response, into the given _t_ class.

Type Parameters:

T -

Parameters:

key -

t -

Returns:

null if the key is not in the extensions map. Otherwise: the value for this _key_, as a _t_ instance

Throws:

com.fasterxml.jackson.core.JsonProcessingException - When there is an error when converting the key's value into the _t_ class

getMessage

public String getMessage()

Specified by:

getMessage in interface graphql.GraphQLError

getLocations

public List<graphql.language.SourceLocation> getLocations()

Specified by:

getLocations in interface graphql.GraphQLError

getErrorType

public graphql.ErrorClassification getErrorType()

Specified by:

getErrorType in interface graphql.GraphQLError