Class ValidationError

java.lang.Object

graphql.validation.ValidationError

All Implemented Interfaces:

GraphQLError, Serializable

@PublicApi
public class ValidationError
extends Object
implements GraphQLError

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ValidationError.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final String	description
private final com.google.common.collect.ImmutableMap<String,Object>	extensions
private final List<SourceLocation>	locations
private final List<String>	queryPath
private final ValidationErrorClassification	validationErrorType

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ValidationError(ValidationError.Builder builder)
	ValidationError(ValidationErrorClassification validationErrorType)	Deprecated.
	ValidationError(ValidationErrorClassification validationErrorType, SourceLocation sourceLocation, String description)	Deprecated.
	ValidationError(ValidationErrorType validationErrorType, SourceLocation sourceLocation, String description, List<String> queryPath)	Deprecated.
	ValidationError(ValidationErrorType validationErrorType, List<SourceLocation> sourceLocations, String description)	Deprecated.
	ValidationError(ValidationErrorType validationErrorType, List<SourceLocation> sourceLocations, String description, List<String> queryPath)	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDescription()
ErrorType	getErrorType()
Map<String,Object>	getExtensions()
List<SourceLocation>	getLocations()
String	getMessage()
List<String>	getQueryPath()
ValidationErrorClassification	getValidationErrorType()
int	hashCode()
static ValidationError.Builder	newValidationError()
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface GraphQLError

getPath, toSpecification

Field Details

locations

private final List<SourceLocation> locations

description

private final String description

validationErrorType

private final ValidationErrorClassification validationErrorType

queryPath

private final List<String> queryPath

extensions

private final com.google.common.collect.ImmutableMap<String,Object> extensions

Constructor Details

ValidationError

@Deprecated
public ValidationError(ValidationErrorClassification validationErrorType)

Deprecated.

ValidationError

@Deprecated
public ValidationError(ValidationErrorClassification validationErrorType,
 SourceLocation sourceLocation,
 String description)

Deprecated.

ValidationError

@Deprecated
public ValidationError(ValidationErrorType validationErrorType,
 SourceLocation sourceLocation,
 String description,
 List<String> queryPath)

Deprecated.

ValidationError

@Deprecated
public ValidationError(ValidationErrorType validationErrorType,
 List<SourceLocation> sourceLocations,
 String description)

Deprecated.

ValidationError

@Deprecated
public ValidationError(ValidationErrorType validationErrorType,
 List<SourceLocation> sourceLocations,
 String description,
 List<String> queryPath)

Deprecated.

ValidationError

private ValidationError(ValidationError.Builder builder)

Method Details

getValidationErrorType

public ValidationErrorClassification getValidationErrorType()

getMessage

public String getMessage()

Specified by:

getMessage in interface GraphQLError

Returns:

a description of the error intended for the developer as a guide to understand and correct the error

getDescription

public String getDescription()

getLocations

public List<SourceLocation> getLocations()

Specified by:

getLocations in interface GraphQLError

Returns:

the location(s) within the GraphQL document at which the error occurred. Each SourceLocation describes the beginning of an associated syntax element

getErrorType

public ErrorType getErrorType()

Specified by:

getErrorType in interface GraphQLError

Returns:

an object classifying this error

getQueryPath

public List<String> getQueryPath()

getExtensions

public Map<String,Object> getExtensions()

Specified by:

getExtensions in interface GraphQLError

Returns:

a map of error extensions or null if there are none

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

newValidationError

public static ValidationError.Builder newValidationError()