Renamed a few things and added per callback envs

bbakerman · bbakerman · commit c92b102f51f2 · 2023-02-11T10:05:46.000+11:00
diff --git a/src/main/java/graphql/schema/visitor/GraphQLSchemaVisitor.java b/src/main/java/graphql/schema/visitor/GraphQLSchemaVisitor.java
@@ -8,21 +8,25 @@
 import graphql.util.TraversalControl;
 
 /**
- * I called it smart because I want to offer more "smarts" above GraphQLTypeVisitor and its "context" uber object
+ * This visitor interface offers more "smarts" above {@link GraphQLTypeVisitor} and aims to be easier to use
+ * with more type safe helpers.
  * <p>
- * You would use it by doing `new GraphQLSmartTypeVisitor() { ...}.toTypeVisitor()`
+ * You would use it places that need a {@link GraphQLTypeVisitor} by doing `new GraphQLSchemaVisitor() { ...}.toTypeVisitor()`
  */
 @PublicSpi
-public interface GraphQLSmartTypeVisitor {
+public interface GraphQLSchemaVisitor {
 
-    default TraversalControl visitGraphQLObjectType(GraphQLObjectType objectType, SmartTypeVisitorEnvironment environment) {
+    interface ObjectVisitorEnvironment extends GraphQLSchemaVisitorEnvironment {
+    }
+
+    default TraversalControl visitGraphQLObjectType(GraphQLObjectType objectType, ObjectVisitorEnvironment environment) {
         return TraversalControl.CONTINUE;
     }
 
     /**
      * This is a class specific for visiting {@link GraphQLFieldDefinition}s
      */
-    interface GraphQLFieldDefinitionVisitorEnvironment extends SmartTypeVisitorEnvironment {
+    interface FieldVisitorEnvironment extends GraphQLSchemaVisitorEnvironment {
 
         GraphQLFieldsContainer getFieldsContainer();
 
@@ -36,7 +40,7 @@ interface GraphQLFieldDefinitionVisitorEnvironment extends SmartTypeVisitorEnvir
      *
      * @return control
      */
-    default TraversalControl visitGraphQLFieldDefinition(GraphQLFieldDefinition fieldDefinition, GraphQLFieldDefinitionVisitorEnvironment environment) {
+    default TraversalControl visitGraphQLFieldDefinition(GraphQLFieldDefinition fieldDefinition, FieldVisitorEnvironment environment) {
         return TraversalControl.CONTINUE;
     }
 
@@ -47,6 +51,6 @@ default TraversalControl visitGraphQLFieldDefinition(GraphQLFieldDefinition fiel
      * @return a type visitor
      */
     default GraphQLTypeVisitor toTypeVisitor() {
-        return new GraphQLSmartTypeVisitorAdapter(this);
+        return new GraphQLSchemaVisitorAdapter(this);
     }
 }
diff --git a/src/main/java/graphql/schema/visitor/GraphQLSchemaVisitorAdapter.java b/src/main/java/graphql/schema/visitor/GraphQLSchemaVisitorAdapter.java
@@ -9,24 +9,38 @@
 import graphql.util.TraversalControl;
 import graphql.util.TraverserContext;
 
+import static graphql.schema.visitor.GraphQLSchemaVisitor.FieldVisitorEnvironment;
+import static graphql.schema.visitor.GraphQLSchemaVisitor.ObjectVisitorEnvironment;
+
 @Internal
-class GraphQLSmartTypeVisitorAdapter extends GraphQLTypeVisitorStub {
+class GraphQLSchemaVisitorAdapter extends GraphQLTypeVisitorStub {
 
-    private final GraphQLSmartTypeVisitor smartTypeVisitor;
+    private final GraphQLSchemaVisitor smartTypeVisitor;
 
-    GraphQLSmartTypeVisitorAdapter(GraphQLSmartTypeVisitor smartTypeVisitor) {
+    GraphQLSchemaVisitorAdapter(GraphQLSchemaVisitor smartTypeVisitor) {
         this.smartTypeVisitor = smartTypeVisitor;
     }
 
+    /* ------------------------------
+     * GraphQLObjectType
+     * ------------------------------  */
+    static class ObjectEnv extends GraphQLSchemaVisitorEnvironmentImpl implements ObjectVisitorEnvironment {
+        public ObjectEnv(TraverserContext<GraphQLSchemaElement> context) {
+            super(context);
+        }
+    }
+
     @Override
     public TraversalControl visitGraphQLObjectType(GraphQLObjectType node, TraverserContext<GraphQLSchemaElement> context) {
-        return smartTypeVisitor.visitGraphQLObjectType(node, new SmartTypeVisitorEnvironmentImpl(context));
+        return smartTypeVisitor.visitGraphQLObjectType(node, new ObjectEnv(context));
     }
 
+    /* ------------------------------
+     * GraphQLFieldDefinition
+     * ------------------------------  */
+    static class FieldEnv extends GraphQLSchemaVisitorEnvironmentImpl implements FieldVisitorEnvironment {
 
-    static class FieldDefinitionEnv extends SmartTypeVisitorEnvironmentImpl implements GraphQLSmartTypeVisitor.GraphQLFieldDefinitionVisitorEnvironment {
-
-        public FieldDefinitionEnv(TraverserContext<GraphQLSchemaElement> context) {
+        public FieldEnv(TraverserContext<GraphQLSchemaElement> context) {
             super(context);
         }
 
@@ -38,6 +52,6 @@ public GraphQLFieldsContainer getFieldsContainer() {
 
     @Override
     public TraversalControl visitGraphQLFieldDefinition(GraphQLFieldDefinition node, TraverserContext<GraphQLSchemaElement> context) {
-        return smartTypeVisitor.visitGraphQLFieldDefinition(node, new FieldDefinitionEnv(context));
+        return smartTypeVisitor.visitGraphQLFieldDefinition(node, new FieldEnv(context));
     }
 }
diff --git a/src/main/java/graphql/schema/visitor/GraphQLSchemaVisitorEnvironment.java b/src/main/java/graphql/schema/visitor/GraphQLSchemaVisitorEnvironment.java
@@ -2,7 +2,7 @@
 
 import graphql.schema.GraphQLCodeRegistry;
 
-public interface SmartTypeVisitorEnvironment {
+public interface GraphQLSchemaVisitorEnvironment {
 
     GraphQLCodeRegistry.Builder getCodeRegistry();
 }
diff --git a/src/main/java/graphql/schema/visitor/GraphQLSchemaVisitorEnvironmentImpl.java b/src/main/java/graphql/schema/visitor/GraphQLSchemaVisitorEnvironmentImpl.java
@@ -6,11 +6,11 @@
 import graphql.util.TraverserContext;
 
 @Internal
-class SmartTypeVisitorEnvironmentImpl implements SmartTypeVisitorEnvironment {
+class GraphQLSchemaVisitorEnvironmentImpl implements GraphQLSchemaVisitorEnvironment {
 
     protected final TraverserContext<GraphQLSchemaElement> context;
 
-    SmartTypeVisitorEnvironmentImpl(TraverserContext<GraphQLSchemaElement> context) {
+    GraphQLSchemaVisitorEnvironmentImpl(TraverserContext<GraphQLSchemaElement> context) {
         this.context = context;
     }
 

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`import graphql.schema.GraphQLCodeRegistry;`
`4`	`4`
`5`		`-public interface SmartTypeVisitorEnvironment {`
	`5`	`+public interface GraphQLSchemaVisitorEnvironment {`
`6`	`6`
`7`	`7`	`GraphQLCodeRegistry.Builder getCodeRegistry();`
`8`	`8`	`}`