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

  • 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(since="2023-10-04") 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