graphql.execution.instrumentation.fieldvalidation

Class SimpleFieldValidation

java.lang.Object

graphql.execution.instrumentation.fieldvalidation.SimpleFieldValidation

All Implemented Interfaces:

FieldValidation

@PublicApi
public class SimpleFieldValidation
extends java.lang.Object
implements FieldValidation

This very simple field validation will run the supplied function for a given field path and if it returns an error it will be added to the list of problems. Use addRule(graphql.execution.ExecutionPath, java.util.function.BiFunction) to supply the rule callbacks where you implement your specific business logic

Constructor Summary

Constructors

Constructor and Description
SimpleFieldValidation()

Method Summary

Modifier and Type	Method and Description
SimpleFieldValidation	addRule(ExecutionPath fieldPath, java.util.function.BiFunction<FieldAndArguments,FieldValidationEnvironment,java.util.Optional<GraphQLError>> rule) Adds the rule against the field address path.
java.util.List<GraphQLError>	validateFields(FieldValidationEnvironment validationEnvironment) This is called to validate the fields and their arguments

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleFieldValidation

public SimpleFieldValidation()

Method Detail

addRule

public SimpleFieldValidation addRule(ExecutionPath fieldPath,
                                     java.util.function.BiFunction<FieldAndArguments,FieldValidationEnvironment,java.util.Optional<GraphQLError>> rule)

Adds the rule against the field address path. If the rule returns an error, it will be added to the list of errors

Parameters:

fieldPath - the path to the field

rule - the rule function

Returns:

this validator

validateFields

public java.util.List<GraphQLError> validateFields(FieldValidationEnvironment validationEnvironment)

Description copied from interface: FieldValidation

This is called to validate the fields and their arguments

Specified by:

validateFields in interface FieldValidation

Parameters:

validationEnvironment - the validation environment

Returns:

a list of errors. If this is non empty then the query will not execute.