Package graphql.schema.diff

Class SchemaDiff

  • @PublicSpi
public class SchemaDiff
extends java.lang.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
      static class  SchemaDiff.Options
      Options for controlling the diffing process

    • 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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int diffSchema​(DiffSet diffSet, DifferenceReporter reporter)
      This will perform a difference on the two schemas.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • 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 Detail

      • diffSchema

        public int diffSchema​(DiffSet diffSet,
                      DifferenceReporter reporter)
        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