Package graphql.schema.diff

Class SchemaDiff

java.lang.Object

graphql.schema.diff.SchemaDiff

@PublicSpi
public class SchemaDiff
extends Object

The SchemaDiff is called with a DiffSet and will report the differences in the graphql schema APIs by raising events to a DifferenceReporter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	SchemaDiff.CountingReporter
static class	SchemaDiff.Options	Options for controlling the diffing process

Field Summary

Fields

Modifier and Type	Field	Description
private final SchemaDiff.Options	options
private static final Set<String>	SYSTEM_SCALARS

Constructor Summary

Constructors

Constructor	Description
SchemaDiff()	Constructs a differ using default options
SchemaDiff(SchemaDiff.Options options)	Constructs a differ with the specified options

Method Summary

Modifier and Type	Method	Description
private static String	capitalize(String name)
private void	checkDirectives(DiffCtx ctx, TypeDefinition oldDef, TypeDefinition newDef)
(package private) void	checkDirectives(DiffCtx ctx, TypeDefinition old, List<Directive> oldDirectives, List<Directive> newDirectives)
private void	checkEnumType(DiffCtx ctx, EnumTypeDefinition oldDef, EnumTypeDefinition newDef)
private void	checkField(DiffCtx ctx, TypeDefinition old, FieldDefinition oldField, FieldDefinition newField)
private void	checkFieldAdditions(DiffCtx ctx, TypeDefinition newDef, Map<String,FieldDefinition> oldFields, Map<String,FieldDefinition> newFields)
private void	checkFieldArg(DiffCtx ctx, TypeDefinition oldDef, FieldDefinition oldField, InputValueDefinition oldArg, InputValueDefinition newArg)
private void	checkFieldArguments(DiffCtx ctx, TypeDefinition oldDef, FieldDefinition oldField, List<InputValueDefinition> oldInputValueDefinitions, List<InputValueDefinition> newInputValueDefinitions)
private void	checkFieldRemovals(DiffCtx ctx, TypeDefinition oldDef, Map<String,FieldDefinition> oldFields, Map<String,FieldDefinition> newFields)
private void	checkFields(DiffCtx ctx, TypeDefinition oldDef, Map<String,FieldDefinition> oldFields, TypeDefinition newDef, Map<String,FieldDefinition> newFields)
private void	checkImplements(DiffCtx ctx, ObjectTypeDefinition old, List<Type> oldImplements, List<Type> newImplements)
private void	checkInputFields(DiffCtx ctx, TypeDefinition old, List<InputValueDefinition> oldIVD, List<InputValueDefinition> newIVD)
private void	checkInputObjectType(DiffCtx ctx, InputObjectTypeDefinition oldDef, InputObjectTypeDefinition newDef)
private void	checkInterfaceType(DiffCtx ctx, InterfaceTypeDefinition oldDef, InterfaceTypeDefinition newDef)
private void	checkObjectType(DiffCtx ctx, ObjectTypeDefinition oldDef, ObjectTypeDefinition newDef)
private void	checkOperation(DiffCtx ctx, String opName, Optional<SchemaDefinition> oldSchemaDef, Optional<SchemaDefinition> newSchemaDef)
private void	checkScalarType(DiffCtx ctx, ScalarTypeDefinition oldDef, ScalarTypeDefinition newDef)
private void	checkType(DiffCtx ctx, Type oldType, Type newType)
(package private) DiffCategory	checkTypeWithNonNullAndListOnInputOrArg(Type oldType, Type newType)
(package private) DiffCategory	checkTypeWithNonNullAndListOnObjectOrInterface(Type oldType, Type newType)
private void	checkUnionType(DiffCtx ctx, UnionTypeDefinition oldDef, UnionTypeDefinition newDef)
int	diffSchema(DiffSet diffSet, DifferenceReporter reporter)	Deprecated.
int	diffSchema(SchemaDiffSet schemaDiffSet, DifferenceReporter reporter)	This will perform a difference on the two schemas.
private void	diffSchemaImpl(Document oldDoc, Document newDoc, DifferenceReporter reporter)
private Optional<OperationTypeDefinition>	getOpDef(String opName, SchemaDefinition schemaDef)
private Optional<SchemaDefinition>	getSchemaDef(Document document)
(package private) static String	getTypeName(Type type)
private boolean	isDeprecated(DirectivesContainer<?> node)
private boolean	isReservedType(String typeName)
private boolean	isSystemScalar(String typeName)
private String	mkDotName(String... objectNames)
private <T> Map<String,T>	sortedMap(List<T> listOfNamedThings, Function<T,String> nameFunc)
private Optional<OperationTypeDefinition>	synthOperationTypeDefinition(Function<Type,Optional<ObjectTypeDefinition>> typeRetriever, String opName)

Methods inherited from class java.lang.Object

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

Field Details

options

private final SchemaDiff.Options options

SYSTEM_SCALARS

private static final Set<String> SYSTEM_SCALARS

Constructor Details

SchemaDiff

public SchemaDiff()

Constructs a differ using default options

SchemaDiff

public SchemaDiff(SchemaDiff.Options options)

Constructs a differ with the specified options

Parameters:

options - the controlling options

Method Details

diffSchema

@Deprecated
public int diffSchema(DiffSet diffSet,
 DifferenceReporter reporter)

Deprecated.

This will perform a difference on the two schemas. The reporter callback interface will be called when differences are encountered.

Parameters:

diffSet - the two schemas to compare for difference

reporter - the place to report difference events to

Returns:

the number of API breaking changes

diffSchema

public int diffSchema(SchemaDiffSet schemaDiffSet,
 DifferenceReporter reporter)

This will perform a difference on the two schemas. The reporter callback interface will be called when differences are encountered.

Parameters:

schemaDiffSet - the two schemas to compare for difference

reporter - the place to report difference events to

Returns:

the number of API breaking changes

diffSchemaImpl

private void diffSchemaImpl(Document oldDoc,
 Document newDoc,
 DifferenceReporter reporter)

checkOperation

private void checkOperation(DiffCtx ctx,
 String opName,
 Optional<SchemaDefinition> oldSchemaDef,
 Optional<SchemaDefinition> newSchemaDef)

checkType

private void checkType(DiffCtx ctx,
 Type oldType,
 Type newType)

isDeprecated

private boolean isDeprecated(DirectivesContainer<?> node)

isReservedType

private boolean isReservedType(String typeName)

isSystemScalar

private boolean isSystemScalar(String typeName)

checkObjectType

private void checkObjectType(DiffCtx ctx,
 ObjectTypeDefinition oldDef,
 ObjectTypeDefinition newDef)

checkInterfaceType

private void checkInterfaceType(DiffCtx ctx,
 InterfaceTypeDefinition oldDef,
 InterfaceTypeDefinition newDef)

checkUnionType

private void checkUnionType(DiffCtx ctx,
 UnionTypeDefinition oldDef,
 UnionTypeDefinition newDef)

checkInputObjectType

private void checkInputObjectType(DiffCtx ctx,
 InputObjectTypeDefinition oldDef,
 InputObjectTypeDefinition newDef)

checkInputFields

private void checkInputFields(DiffCtx ctx,
 TypeDefinition old,
 List<InputValueDefinition> oldIVD,
 List<InputValueDefinition> newIVD)

checkEnumType

private void checkEnumType(DiffCtx ctx,
 EnumTypeDefinition oldDef,
 EnumTypeDefinition newDef)

checkScalarType

private void checkScalarType(DiffCtx ctx,
 ScalarTypeDefinition oldDef,
 ScalarTypeDefinition newDef)

checkImplements

private void checkImplements(DiffCtx ctx,
 ObjectTypeDefinition old,
 List<Type> oldImplements,
 List<Type> newImplements)

checkFields

private void checkFields(DiffCtx ctx,
 TypeDefinition oldDef,
 Map<String,FieldDefinition> oldFields,
 TypeDefinition newDef,
 Map<String,FieldDefinition> newFields)

checkFieldRemovals

private void checkFieldRemovals(DiffCtx ctx,
 TypeDefinition oldDef,
 Map<String,FieldDefinition> oldFields,
 Map<String,FieldDefinition> newFields)

checkFieldAdditions

private void checkFieldAdditions(DiffCtx ctx,
 TypeDefinition newDef,
 Map<String,FieldDefinition> oldFields,
 Map<String,FieldDefinition> newFields)

checkField

private void checkField(DiffCtx ctx,
 TypeDefinition old,
 FieldDefinition oldField,
 FieldDefinition newField)

checkFieldArguments

private void checkFieldArguments(DiffCtx ctx,
 TypeDefinition oldDef,
 FieldDefinition oldField,
 List<InputValueDefinition> oldInputValueDefinitions,
 List<InputValueDefinition> newInputValueDefinitions)

checkFieldArg

private void checkFieldArg(DiffCtx ctx,
 TypeDefinition oldDef,
 FieldDefinition oldField,
 InputValueDefinition oldArg,
 InputValueDefinition newArg)

checkDirectives

private void checkDirectives(DiffCtx ctx,
 TypeDefinition oldDef,
 TypeDefinition newDef)

checkDirectives

void checkDirectives(DiffCtx ctx,
 TypeDefinition old,
 List<Directive> oldDirectives,
 List<Directive> newDirectives)

checkTypeWithNonNullAndListOnInputOrArg

DiffCategory checkTypeWithNonNullAndListOnInputOrArg(Type oldType,
 Type newType)

checkTypeWithNonNullAndListOnObjectOrInterface

DiffCategory checkTypeWithNonNullAndListOnObjectOrInterface(Type oldType,
 Type newType)

getTypeName

static String getTypeName(Type type)

getSchemaDef

private Optional<SchemaDefinition> getSchemaDef(Document document)

getOpDef

private Optional<OperationTypeDefinition> getOpDef(String opName,
 SchemaDefinition schemaDef)

synthOperationTypeDefinition

private Optional<OperationTypeDefinition> synthOperationTypeDefinition(Function<Type,Optional<ObjectTypeDefinition>> typeRetriever,
 String opName)

sortedMap

private <T> Map<String,T> sortedMap(List<T> listOfNamedThings,
 Function<T,String> nameFunc)

capitalize

private static String capitalize(String name)

mkDotName

private String mkDotName(String... objectNames)