add public/internal/spi annotations

andimarek · andimarek · commit e700c9cb0316 · 2017-05-08T07:29:48.000+02:00
diff --git a/src/main/java/graphql/Assert.java b/src/main/java/graphql/Assert.java
@@ -2,6 +2,7 @@
 
 import java.util.Collection;
 
+@Internal
 public class Assert {
 
     public static <T> T assertNotNull(T object, String errorMessage) {
diff --git a/src/main/java/graphql/AssertException.java b/src/main/java/graphql/AssertException.java
@@ -1,6 +1,7 @@
 package graphql;
 
 
+@PublicApi
 public class AssertException extends GraphQLException {
 
     public AssertException(String message) {
diff --git a/src/main/java/graphql/ExceptionWhileDataFetching.java b/src/main/java/graphql/ExceptionWhileDataFetching.java
@@ -5,6 +5,7 @@
 
 import java.util.List;
 
+@PublicApi
 public class ExceptionWhileDataFetching implements GraphQLError {
 
     private final Throwable exception;
diff --git a/src/main/java/graphql/ExecutionResult.java b/src/main/java/graphql/ExecutionResult.java
@@ -4,6 +4,7 @@
 import java.util.List;
 import java.util.Map;
 
+@PublicApi
 public interface ExecutionResult {
 
     <T> T getData();
diff --git a/src/main/java/graphql/ExecutionResultImpl.java b/src/main/java/graphql/ExecutionResultImpl.java
@@ -6,6 +6,7 @@
 import java.util.List;
 import java.util.Map;
 
+@Internal
 public class ExecutionResultImpl implements ExecutionResult {
 
     private final List<GraphQLError> errors = new ArrayList<>();
diff --git a/src/main/java/graphql/GraphQL.java b/src/main/java/graphql/GraphQL.java
@@ -27,6 +27,7 @@
 
 import static graphql.Assert.assertNotNull;
 
+@PublicApi
 public class GraphQL {
 
     private static final Logger log = LoggerFactory.getLogger(GraphQL.class);
@@ -48,6 +49,7 @@ public class GraphQL {
      *
      * @deprecated use the {@link #newGraphQL(GraphQLSchema)} builder instead.  This will be removed in a future version.
      */
+    @Internal
     public GraphQL(GraphQLSchema graphQLSchema) {
         //noinspection deprecation
         this(graphQLSchema, null, null);
@@ -61,6 +63,7 @@ public GraphQL(GraphQLSchema graphQLSchema) {
      *
      * @deprecated use the {@link #newGraphQL(GraphQLSchema)} builder instead.  This will be removed in a future version.
      */
+    @Internal
     public GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy) {
         //noinspection deprecation
         this(graphQLSchema, queryStrategy, null);
@@ -75,6 +78,7 @@ public GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy) {
      *
      * @deprecated use the {@link #newGraphQL(GraphQLSchema)} builder instead.  This will be removed in a future version.
      */
+    @Internal
     public GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy, ExecutionStrategy mutationStrategy) {
         this(graphQLSchema, queryStrategy, mutationStrategy, null, DEFAULT_EXECUTION_ID_PROVIDER, NoOpInstrumentation.INSTANCE);
     }
@@ -89,6 +93,7 @@ public GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy, Exe
      *
      * @deprecated use the {@link #newGraphQL(GraphQLSchema)} builder instead.  This will be removed in a future version.
      */
+    @Internal
     public GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy, ExecutionStrategy mutationStrategy, ExecutionStrategy subscriptionStrategy) {
         this(graphQLSchema, queryStrategy, mutationStrategy, subscriptionStrategy, DEFAULT_EXECUTION_ID_PROVIDER, NoOpInstrumentation.INSTANCE);
     }
@@ -114,6 +119,7 @@ public static Builder newGraphQL(GraphQLSchema graphQLSchema) {
     }
 
 
+    @PublicApi
     public static class Builder {
         private GraphQLSchema graphQLSchema;
         private ExecutionStrategy queryExecutionStrategy = new SimpleExecutionStrategy();
diff --git a/src/main/java/graphql/GraphQLError.java b/src/main/java/graphql/GraphQLError.java
@@ -5,6 +5,7 @@
 
 import java.util.List;
 
+@PublicApi
 public interface GraphQLError {
 
     String getMessage();
diff --git a/src/main/java/graphql/Internal.java b/src/main/java/graphql/Internal.java
@@ -0,0 +1,14 @@
+package graphql;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.CONSTRUCTOR;
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.ElementType.TYPE;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target(value = {CONSTRUCTOR, METHOD, TYPE})
+public @interface Internal {
+}
diff --git a/src/main/java/graphql/PublicApi.java b/src/main/java/graphql/PublicApi.java
@@ -0,0 +1,14 @@
+package graphql;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.CONSTRUCTOR;
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.ElementType.TYPE;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target(value = {CONSTRUCTOR, METHOD, TYPE})
+public @interface PublicApi {
+}
diff --git a/src/main/java/graphql/PublicSpi.java b/src/main/java/graphql/PublicSpi.java
@@ -0,0 +1,14 @@
+package graphql;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.CONSTRUCTOR;
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.ElementType.TYPE;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target(value = {CONSTRUCTOR, METHOD, TYPE})
+public @interface PublicSpi {
+}
diff --git a/src/main/java/graphql/execution/Execution.java b/src/main/java/graphql/execution/Execution.java
@@ -4,6 +4,7 @@
 import graphql.ExecutionResult;
 import graphql.ExecutionResultImpl;
 import graphql.GraphQLException;
+import graphql.Internal;
 import graphql.MutationNotSupportedError;
 import graphql.execution.instrumentation.Instrumentation;
 import graphql.execution.instrumentation.InstrumentationContext;
@@ -26,6 +27,7 @@
 import static graphql.language.OperationDefinition.Operation.QUERY;
 import static graphql.language.OperationDefinition.Operation.SUBSCRIPTION;
 
+@Internal
 public class Execution {
 
     private final FieldCollector fieldCollector = new FieldCollector();
diff --git a/src/main/java/graphql/execution/ExecutionStrategy.java b/src/main/java/graphql/execution/ExecutionStrategy.java
@@ -4,6 +4,7 @@
 import graphql.ExecutionResult;
 import graphql.ExecutionResultImpl;
 import graphql.GraphQLException;
+import graphql.PublicSpi;
 import graphql.TypeResolutionEnvironment;
 import graphql.execution.instrumentation.Instrumentation;
 import graphql.execution.instrumentation.InstrumentationContext;
@@ -35,6 +36,7 @@
 import static graphql.introspection.Introspection.TypeMetaFieldDef;
 import static graphql.introspection.Introspection.TypeNameMetaFieldDef;
 
+@PublicSpi
 public abstract class ExecutionStrategy {
 
     private static final Logger log = LoggerFactory.getLogger(ExecutionStrategy.class);
diff --git a/src/main/java/graphql/execution/ExecutorServiceExecutionStrategy.java b/src/main/java/graphql/execution/ExecutorServiceExecutionStrategy.java
@@ -3,6 +3,7 @@
 import graphql.ExecutionResult;
 import graphql.ExecutionResultImpl;
 import graphql.GraphQLException;
+import graphql.PublicApi;
 import graphql.language.Field;
 
 import java.util.LinkedHashMap;
@@ -27,6 +28,7 @@
  * 
  * See {@code graphql.execution.ExecutorServiceExecutionStrategyTest} for example usage.
  */
+@PublicApi
 public class ExecutorServiceExecutionStrategy extends ExecutionStrategy {
 
     ExecutorService executorService;
diff --git a/src/main/java/graphql/execution/FieldCollector.java b/src/main/java/graphql/execution/FieldCollector.java
@@ -1,6 +1,7 @@
 package graphql.execution;
 
 
+import graphql.Internal;
 import graphql.language.Field;
 import graphql.language.FragmentDefinition;
 import graphql.language.FragmentSpread;
@@ -19,6 +20,7 @@
 
 import static graphql.execution.TypeFromAST.getTypeFromAST;
 
+@Internal
 public class FieldCollector {
 
     private ConditionalNodes conditionalNodes;
diff --git a/src/main/java/graphql/execution/TypeFromAST.java b/src/main/java/graphql/execution/TypeFromAST.java
@@ -1,6 +1,7 @@
 package graphql.execution;
 
 
+import graphql.Internal;
 import graphql.language.ListType;
 import graphql.language.NonNullType;
 import graphql.language.Type;
@@ -10,6 +11,7 @@
 import graphql.schema.GraphQLSchema;
 import graphql.schema.GraphQLType;
 
+@Internal
 public class TypeFromAST {
 
 
diff --git a/src/main/java/graphql/schema/DataFetcher.java b/src/main/java/graphql/schema/DataFetcher.java
@@ -1,6 +1,9 @@
 package graphql.schema;
 
 
+import graphql.PublicSpi;
+
+@PublicSpi
 public interface DataFetcher<T> {
 
     T get(DataFetchingEnvironment environment);
diff --git a/src/main/java/graphql/schema/GraphQLFieldDefinition.java b/src/main/java/graphql/schema/GraphQLFieldDefinition.java
@@ -1,6 +1,8 @@
 package graphql.schema;
 
 
+import graphql.Internal;
+import graphql.PublicApi;
 import graphql.language.FieldDefinition;
 
 import java.util.ArrayList;
@@ -11,6 +13,7 @@
 import static graphql.Assert.assertNotNull;
 import static graphql.Assert.assertValidName;
 
+@PublicApi
 public class GraphQLFieldDefinition {
 
     private final String name;
@@ -22,10 +25,12 @@ public class GraphQLFieldDefinition {
     private final FieldDefinition definition;
 
 
+    @Internal
     public GraphQLFieldDefinition(String name, String description, GraphQLOutputType type, DataFetcher dataFetcher, List<GraphQLArgument> arguments, String deprecationReason) {
         this(name,description,type, dataFetcher,arguments,deprecationReason,null);
     }
 
+    @Internal
     public GraphQLFieldDefinition(String name, String description, GraphQLOutputType type, DataFetcher dataFetcher, List<GraphQLArgument> arguments, String deprecationReason, FieldDefinition definition) {
         assertValidName(name);
         assertNotNull(dataFetcher, "dataFetcher can't be null");
@@ -89,6 +94,7 @@ public static Builder newFieldDefinition() {
         return new Builder();
     }
 
+    @PublicApi
     public static class Builder {
 
         private String name;
diff --git a/src/main/java/graphql/schema/GraphQLInputObjectField.java b/src/main/java/graphql/schema/GraphQLInputObjectField.java
@@ -1,13 +1,16 @@
 package graphql.schema;
 
 
+import graphql.Internal;
+import graphql.PublicApi;
 import graphql.language.InputValueDefinition;
 
 import java.util.Map;
 
 import static graphql.Assert.assertNotNull;
 import static graphql.Assert.assertValidName;
 
+@PublicApi
 public class GraphQLInputObjectField {
 
     private final String name;
@@ -16,14 +19,17 @@ public class GraphQLInputObjectField {
     private final Object defaultValue;
     private final InputValueDefinition definition;
 
+    @Internal
     public GraphQLInputObjectField(String name, GraphQLInputType type) {
         this(name, null, type, null, null);
     }
 
+    @Internal
     public GraphQLInputObjectField(String name, String description, GraphQLInputType type, Object defaultValue) {
         this(name,description,type,defaultValue,null);
     }
 
+    @Internal
     public GraphQLInputObjectField(String name, String description, GraphQLInputType type, Object defaultValue, InputValueDefinition definition) {
         assertValidName(name);
         assertNotNull(type, "type can't be null");
@@ -42,8 +48,7 @@ public String getName() {
         return name;
     }
 
-    public GraphQLInputType getType() {
-        return type;
+    public GraphQLInputType getType() { return type;
     }
 
     public Object getDefaultValue() {
@@ -62,6 +67,7 @@ public static Builder newInputObjectField() {
         return new Builder();
     }
 
+    @PublicApi
     public static class Builder {
         private String name;
         private String description;
diff --git a/src/main/java/graphql/schema/GraphQLInputObjectType.java b/src/main/java/graphql/schema/GraphQLInputObjectType.java
@@ -1,6 +1,8 @@
 package graphql.schema;
 
 import graphql.AssertException;
+import graphql.Internal;
+import graphql.PublicApi;
 import graphql.language.InputObjectTypeDefinition;
 
 import java.util.ArrayList;
@@ -12,16 +14,20 @@
 import static graphql.Assert.assertNotNull;
 import static graphql.Assert.assertValidName;
 
+@PublicApi
 public class GraphQLInputObjectType implements GraphQLType, GraphQLInputType, GraphQLUnmodifiedType, GraphQLNullableType, GraphQLInputFieldsContainer {
 
     private final String name;
     private final String description;
     private final Map<String, GraphQLInputObjectField> fieldMap = new LinkedHashMap<>();
     private final InputObjectTypeDefinition definition;
 
+    @Internal
     public GraphQLInputObjectType(String name, String description, List<GraphQLInputObjectField> fields) {
         this(name,description,fields,null);
     }
+
+    @Internal
     public GraphQLInputObjectType(String name, String description, List<GraphQLInputObjectField> fields, InputObjectTypeDefinition definition) {
         assertValidName(name);
         assertNotNull(fields, "fields can't be null");
@@ -75,6 +81,7 @@ public InputObjectTypeDefinition getDefinition() {
         return definition;
     }
 
+    @PublicApi
     public static class Builder {
         private String name;
         private String description;
diff --git a/src/main/java/graphql/schema/GraphQLInterfaceType.java b/src/main/java/graphql/schema/GraphQLInterfaceType.java
@@ -1,6 +1,8 @@
 package graphql.schema;
 
 import graphql.AssertException;
+import graphql.Internal;
+import graphql.PublicApi;
 import graphql.language.InterfaceTypeDefinition;
 
 import java.util.ArrayList;
@@ -12,6 +14,7 @@
 import static graphql.Assert.assertNotNull;
 import static graphql.Assert.assertValidName;
 
+@PublicApi
 public class GraphQLInterfaceType implements GraphQLType, GraphQLOutputType, GraphQLFieldsContainer, GraphQLCompositeType, GraphQLUnmodifiedType, GraphQLNullableType {
 
     private final String name;
@@ -20,10 +23,12 @@ public class GraphQLInterfaceType implements GraphQLType, GraphQLOutputType, Gra
     private final TypeResolver typeResolver;
     private final InterfaceTypeDefinition definition;
 
+    @Internal
     public GraphQLInterfaceType(String name, String description, List<GraphQLFieldDefinition> fieldDefinitions, TypeResolver typeResolver) {
         this(name, description, fieldDefinitions, typeResolver, null);
     }
 
+    @Internal
     public GraphQLInterfaceType(String name, String description, List<GraphQLFieldDefinition> fieldDefinitions, TypeResolver typeResolver, InterfaceTypeDefinition definition) {
         assertValidName(name);
         assertNotNull(typeResolver, "typeResolver can't null");
@@ -84,6 +89,7 @@ public static Builder newInterface() {
     }
 
 
+    @PublicApi
     public static class Builder {
         private String name;
         private String description;
diff --git a/src/main/java/graphql/schema/GraphQLList.java b/src/main/java/graphql/schema/GraphQLList.java
diff --git a/src/main/java/graphql/schema/GraphQLNonNull.java b/src/main/java/graphql/schema/GraphQLNonNull.java
diff --git a/src/main/java/graphql/schema/GraphQLObjectType.java b/src/main/java/graphql/schema/GraphQLObjectType.java
diff --git a/src/main/java/graphql/schema/GraphQLUnionType.java b/src/main/java/graphql/schema/GraphQLUnionType.java
diff --git a/src/main/java/graphql/schema/SchemaUtil.java b/src/main/java/graphql/schema/SchemaUtil.java
diff --git a/src/main/java/graphql/schema/TypeResolver.java b/src/main/java/graphql/schema/TypeResolver.java
diff --git a/src/main/java/graphql/schema/idl/RuntimeWiring.java b/src/main/java/graphql/schema/idl/RuntimeWiring.java

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@`
`27`	`27`
`28`	`28`	`import static graphql.Assert.assertNotNull;`
`29`	`29`
	`30`	`+@PublicApi`
`30`	`31`	`public class GraphQL {`
`31`	`32`
`32`	`33`	`private static final Logger log = LoggerFactory.getLogger(GraphQL.class);`
`@@ -48,6 +49,7 @@ public class GraphQL {`
`48`	`49`	`*`
`49`	`50`	`* @deprecated use the {@link #newGraphQL(GraphQLSchema)} builder instead. This will be removed in a future version.`
`50`	`51`	`*/`
	`52`	`+ @Internal`
`51`	`53`	`public GraphQL(GraphQLSchema graphQLSchema) {`
`52`	`54`	`//noinspection deprecation`
`53`	`55`	`this(graphQLSchema, null, null);`
`@@ -61,6 +63,7 @@ public GraphQL(GraphQLSchema graphQLSchema) {`
`61`	`63`	`*`
`62`	`64`	`* @deprecated use the {@link #newGraphQL(GraphQLSchema)} builder instead. This will be removed in a future version.`
`63`	`65`	`*/`
	`66`	`+ @Internal`
`64`	`67`	`public GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy) {`
`65`	`68`	`//noinspection deprecation`
`66`	`69`	`this(graphQLSchema, queryStrategy, null);`
`@@ -75,6 +78,7 @@ public GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy) {`
`75`	`78`	`*`
`76`	`79`	`* @deprecated use the {@link #newGraphQL(GraphQLSchema)} builder instead. This will be removed in a future version.`
`77`	`80`	`*/`
	`81`	`+ @Internal`
`78`	`82`	`public GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy, ExecutionStrategy mutationStrategy) {`
`79`	`83`	`this(graphQLSchema, queryStrategy, mutationStrategy, null, DEFAULT_EXECUTION_ID_PROVIDER, NoOpInstrumentation.INSTANCE);`
`80`	`84`	`}`
`@@ -89,6 +93,7 @@ public GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy, Exe`
`89`	`93`	`*`
`90`	`94`	`* @deprecated use the {@link #newGraphQL(GraphQLSchema)} builder instead. This will be removed in a future version.`
`91`	`95`	`*/`
	`96`	`+ @Internal`
`92`	`97`	`public GraphQL(GraphQLSchema graphQLSchema, ExecutionStrategy queryStrategy, ExecutionStrategy mutationStrategy, ExecutionStrategy subscriptionStrategy) {`
`93`	`98`	`this(graphQLSchema, queryStrategy, mutationStrategy, subscriptionStrategy, DEFAULT_EXECUTION_ID_PROVIDER, NoOpInstrumentation.INSTANCE);`
`94`	`99`	`}`
`@@ -114,6 +119,7 @@ public static Builder newGraphQL(GraphQLSchema graphQLSchema) {`
`114`	`119`	`}`
`115`	`120`
`116`	`121`
	`122`	`+ @PublicApi`
`117`	`123`	`public static class Builder {`
`118`	`124`	`private GraphQLSchema graphQLSchema;`
`119`	`125`	`private ExecutionStrategy queryExecutionStrategy = new SimpleExecutionStrategy();`