graphql.validation.rules

Class TargetedValidationRules

java.lang.Object

graphql.validation.rules.TargetedValidationRules

@PublicApi
public class TargetedValidationRules
extends java.lang.Object

TargetedValidationRules is a holder of ValidationRules targeted against a specific type, field and possible argument via ValidationCoordinates. It then allows those rules to be run against the specific fields based on runtime execution during DataFetcher invocations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TargetedValidationRules.Builder

Constructor Summary

Constructors

Constructor and Description
TargetedValidationRules(TargetedValidationRules.Builder builder)

Method Summary

Modifier and Type	Method and Description
boolean	isEmpty()
static TargetedValidationRules.Builder	newValidationRules()
java.util.List<graphql.GraphQLError>	runValidationRules(graphql.schema.DataFetchingEnvironment env, MessageInterpolator interpolator, java.util.Locale defaultLocale) Runs the contained rules that match the currently executing field named by the DataFetchingEnvironment

Methods inherited from class java.lang.Object

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

Constructor Detail

TargetedValidationRules

public TargetedValidationRules(TargetedValidationRules.Builder builder)

Method Detail

newValidationRules

public static TargetedValidationRules.Builder newValidationRules()

isEmpty

public boolean isEmpty()

runValidationRules

public java.util.List<graphql.GraphQLError> runValidationRules(graphql.schema.DataFetchingEnvironment env,
                                                               MessageInterpolator interpolator,
                                                               java.util.Locale defaultLocale)

Runs the contained rules that match the currently executing field named by the DataFetchingEnvironment

Parameters:

env - the field being executed

interpolator - the message interpolator to use

defaultLocale - the default locale in play

Returns:

a list of zero or more input data validation errors