Package graphql.schema.diff

Class SchemaDiffSet

java.lang.Object

graphql.schema.diff.SchemaDiffSet

@PublicApi
public class SchemaDiffSet
extends java.lang.Object

Interface used to define 2 schemas that can be diffed by the SchemaDiff operation.

Method Summary

Modifier and Type	Method	Description
static SchemaDiffSet	diffSetFromIntrospection(GraphQLSchema oldSchema, GraphQLSchema newSchema)	Creates an schema diff set out of the result of 2 introspection queries.
static SchemaDiffSet	diffSetFromIntrospection(java.util.Map<java.lang.String,java.lang.Object> introspectionOld, java.util.Map<java.lang.String,java.lang.Object> introspectionNew)	Creates an schema diff set out of the result of 2 introspection queries.
static SchemaDiffSet	diffSetFromSdl(GraphQLSchema oldSchema, GraphQLSchema newSchema)	Creates an schema diff set out of the two SDL definition Strings.
static SchemaDiffSet	diffSetFromSdl(java.lang.String oldSchemaSdl, java.lang.String newSchemaSdl)	Creates an schema diff set out of the two SDL definition Strings.
Document	getNewSchemaDefinitionDoc()
Document	getOldSchemaDefinitionDoc()
boolean	supportsEnforcingDirectives()

Methods inherited from class java.lang.Object

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

Method Detail

getOldSchemaDefinitionDoc

public Document getOldSchemaDefinitionDoc()

Returns:

Returns a IDL document that represents the old schema as part of a SchemaDiff operation.

getNewSchemaDefinitionDoc

public Document getNewSchemaDefinitionDoc()

Returns:

Returns a IDL document that represents the new schema created from the introspection result.

supportsEnforcingDirectives

public boolean supportsEnforcingDirectives()

Returns:

Flag indicating whether this diffset implementation can be used to enforce directives when performing schema diff.

diffSetFromIntrospection

public static SchemaDiffSet diffSetFromIntrospection(java.util.Map<java.lang.String,java.lang.Object> introspectionOld,
                                                     java.util.Map<java.lang.String,java.lang.Object> introspectionNew)

Creates an schema diff set out of the result of 2 introspection queries.

Parameters:

introspectionOld - the older introspection query

introspectionNew - the newer introspection query

Returns:

a diff set representing them which will not support enforcing directives.

diffSetFromIntrospection

public static SchemaDiffSet diffSetFromIntrospection(GraphQLSchema oldSchema,
                                                     GraphQLSchema newSchema)

Creates an schema diff set out of the result of 2 introspection queries.

Parameters:

oldSchema - the older GraphQLSchema object to introspect.

newSchema - the new GraphQLSchema object to introspect.

Returns:

a diff set representing them which will not support enforcing directives.

diffSetFromSdl

public static SchemaDiffSet diffSetFromSdl(java.lang.String oldSchemaSdl,
                                           java.lang.String newSchemaSdl)

Creates an schema diff set out of the two SDL definition Strings.

Parameters:

oldSchemaSdl - the older SDL definition String.

newSchemaSdl - the newer SDL definition String.

Returns:

a diff set representing them which will support enforcing directives.

diffSetFromSdl

public static SchemaDiffSet diffSetFromSdl(GraphQLSchema oldSchema,
                                           GraphQLSchema newSchema)

Creates an schema diff set out of the two SDL definition Strings.

Parameters:

oldSchema - the older SDL definition String.

newSchema - the newer SDL definition String.

Returns:

a diff set representing them which will support enforcing directives.