graphql.validation.rules

Class ValidationRules

java.lang.Object

graphql.validation.rules.ValidationRules

@PublicApi
public class ValidationRules
extends java.lang.Object

ValidationRules is a holder of validation rules and you can then pass it field and arguments and narrow down the list of actual rules that apply to those fields and arguments.

It also allows you to run the appropriate rules via the runValidationRules(graphql.schema.DataFetchingEnvironment) method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValidationRules.Builder

Method Summary

Modifier and Type	Method and Description
TargetedValidationRules	buildRulesFor(graphql.schema.GraphQLFieldDefinition fieldDefinition, graphql.schema.GraphQLFieldsContainer fieldsContainer)
java.util.Locale	getLocale()
MessageInterpolator	getMessageInterpolator()
OnValidationErrorStrategy	getOnValidationErrorStrategy()
java.util.List<ValidationRule>	getRules()
java.util.List<ValidationRule>	getRulesFor(graphql.schema.GraphQLArgument fieldArg, graphql.schema.GraphQLFieldDefinition fieldDefinition, graphql.schema.GraphQLFieldsContainer fieldsContainer)
java.util.List<ValidationRule>	getRulesFor(graphql.schema.GraphQLFieldDefinition fieldDefinition, graphql.schema.GraphQLFieldsContainer fieldsContainer)
static ValidationRules.Builder	newValidationRules() A builder of validation rules.
java.util.List<graphql.GraphQLError>	runValidationRules(graphql.schema.DataFetchingEnvironment env) This helper method will run the validation rules that apply to the provided DataFetchingEnvironment

Methods inherited from class java.lang.Object

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

Method Detail

getMessageInterpolator

public MessageInterpolator getMessageInterpolator()

getLocale

public java.util.Locale getLocale()

getRules

public java.util.List<ValidationRule> getRules()

getOnValidationErrorStrategy

public OnValidationErrorStrategy getOnValidationErrorStrategy()

buildRulesFor

public TargetedValidationRules buildRulesFor(graphql.schema.GraphQLFieldDefinition fieldDefinition,
                                             graphql.schema.GraphQLFieldsContainer fieldsContainer)

getRulesFor

public java.util.List<ValidationRule> getRulesFor(graphql.schema.GraphQLArgument fieldArg,
                                                  graphql.schema.GraphQLFieldDefinition fieldDefinition,
                                                  graphql.schema.GraphQLFieldsContainer fieldsContainer)

getRulesFor

public java.util.List<ValidationRule> getRulesFor(graphql.schema.GraphQLFieldDefinition fieldDefinition,
                                                  graphql.schema.GraphQLFieldsContainer fieldsContainer)

runValidationRules

public java.util.List<graphql.GraphQLError> runValidationRules(graphql.schema.DataFetchingEnvironment env)

This helper method will run the validation rules that apply to the provided DataFetchingEnvironment

Parameters:

env - the data fetching environment

Returns:

a list of zero or more input data validation errors

newValidationRules

public static ValidationRules.Builder newValidationRules()

A builder of validation rules. By default the SDL @directive rules from DirectiveConstraints.STANDARD_CONSTRAINTS are included but you can add extra rules or call ValidationRules.Builder.clearRules() to start afresh.

Returns:

a new builder of rules