com.kobylynskyi.graphql.codegen.model.GraphQLCodegenConfiguration Maven / Gradle / Ivy
Show all versions of graphql-java-codegen Show documentation
package com.kobylynskyi.graphql.codegen.model;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* Defines all properties that should be parsed in the plugin.
*/
public interface GraphQLCodegenConfiguration {
/**
* Can be used to supply custom mappings for scalars.
*
* Supports:
* * Map of (GraphqlObjectName.fieldName) to (JavaType)
* * Map of (GraphqlType) to (JavaType)
*
* e.g.: DateTime --- String
* e.g.: Price.amount --- java.math.BigDecimal
*
* @return mappings from GraphqlType to JavaType
*/
Map getCustomTypesMapping();
/**
* Can be used to supply custom annotations (serializers) for scalars.
*
* Supports:
* * Map of (GraphqlObjectName.fieldName) to (JavaAnnotation)
* * Map of (GraphqlType) to (JavaAnnotation)
*
* e.g.: EpochMillis --- @com.fasterxml.jackson.databind.annotation.JsonDeserialize(using = com.example.json.EpochMillisScalarDeserializer.class)
*
* @return mappings from GraphqlType to JavaAnnotation
*/
Map> getCustomAnnotationsMapping();
/**
* Map GraphQL directives to Java annotations.
*
* Directive fields can be used in annotations via: {{directiveFieldName}}
*
* Example:
*
* schema: directive @auth (roles: [String])
*
* directiveAnnotationsMapping: auth --- @org.springframework.security.access.annotation.Secured({{roles}})
*
* @return mappings from GraphQL directives to Java annotations.
*/
Map> getDirectiveAnnotationsMapping();
/**
* Specifies whether api classes should be generated.
*
* @return true is API interfaces should be generated.
*/
Boolean getGenerateApis();
/**
* Specifies whether model classes should be generated for Query/Subscription/Mutation.
*
* @return true is model classes (POJOs) should be generated for GraphQL root types.
*/
Boolean getGenerateModelsForRootTypes();
/**
* Specifies the strategy of generating root api interface.
*
* @return strategy of generating root api interface.
*/
ApiRootInterfaceStrategy getApiRootInterfaceStrategy();
/**
* Specifies the strategy of generating api interfaces.
*
* @return strategy of generating api interfaces.
*/
ApiInterfaceStrategy getApiInterfaceStrategy();
/**
* Java package for generated classes.
*
* @return Java package for generated classes.
*/
String getPackageName();
/**
* Java package for generated api classes (Query, Mutation, Subscription).
*
* @return Java package for generated api classes.
*/
String getApiPackageName();
/**
* Java package for generated model classes (type, input, interface, enum, union).
*
* @return Java package for generated model classes.
*/
String getModelPackageName();
/**
* Sets the prefix for GraphQL model classes (type, input, interface, enum, union).
*
* @return The prefix for GraphQL model classes.
*/
String getModelNamePrefix();
/**
* Sets the suffix for GraphQL model classes (type, input, interface, enum, union).
*
* @return The suffix for GraphQL model classes.
*/
String getModelNameSuffix();
/**
* Sets prefix strategy for GraphQL api classes (query, mutation, subscription).
*
* @return Prefix strategy for GraphQL api classes.
*/
ApiNamePrefixStrategy getApiNamePrefixStrategy();
/**
* Sets the prefix for GraphQL api classes (query, mutation, subscription).
*
* @return The prefix for GraphQL api classes.
*/
String getApiNamePrefix();
/**
* Sets the suffix for GraphQL api classes (query, mutation, subscription).
*
* @return The suffix for GraphQL api classes.
*/
String getApiNameSuffix();
/**
* Annotation for mandatory (NonNull) fields. Can be null/empty.
*
* @return Annotation for mandatory (NonNull) fields
*/
String getModelValidationAnnotation();
/**
* Return type for api methods (query / subscription)
* For example: `reactor.core.publisher.Mono`
*
* @return Return type for api methods (query / subscription)
*/
String getApiReturnType();
/**
* Return type for api methods (query / subscription) that return list values
* For example: `reactor.core.publisher.Flux`
*
* @return Return type for api methods (query / subscription) that return list values
*/
String getApiReturnListType();
/**
* Return type for subscription methods.
* For example: `org.reactivestreams.Publisher`, `io.reactivex.Observable`, etc.
*
* @return Return type for subscription methods
*/
String getSubscriptionReturnType();
/**
* Specifies whether generated model classes should have builder.
*
* @return true if generated model classes should have builder.
*/
Boolean getGenerateBuilder();
/**
* Specifies whether generated model classes should have equals and hashCode methods defined.
*
* @return true if generated model classes should have equals and hashCode methods defined.
*/
Boolean getGenerateEqualsAndHashCode();
/**
* Specifies whether generated model classes should be immutable.
*
* @return true if generated model classes should be immutable.
*/
Boolean getGenerateImmutableModels();
/**
* Specifies whether generated model classes should have toString method defined.
*
* @return true if generated model classes should have toString method defined.
*/
Boolean getGenerateToString();
/**
* If true, then generate separate `Resolver` interface for parametrized fields.
* If false, then add field to the type definition and ignore field parameters.
*
* @return true if separate `Resolver` interface for parametrized fields should be generated.
* false if field should be added to the type definition and field parameters should be ignored.
*/
Boolean getGenerateParameterizedFieldsResolvers();
/**
* Sets the prefix for GraphQL type resolver classes.
*
* @return The prefix for GraphQL type resolver classes.
*/
String getTypeResolverPrefix();
/**
* Sets the suffix for GraphQL type resolver classes.
*
* @return The suffix for GraphQL type resolver classes.
*/
String getTypeResolverSuffix();
/**
* Whether all fields in extensions (extend type and extend interface) should be present
* in Resolver interface instead of the type class itself.
*
* @return true if all fields in extensions (extend type and extend interface)
* should be present in Resolver interface instead of the type class itself.
*/
Boolean getGenerateExtensionFieldsResolvers();
/**
* If true, then graphql.schema.DataFetchingEnvironment env will be added as a last argument
* to all methods of root type resolvers and field resolvers.
*
* @return true if graphql.schema.DataFetchingEnvironment env should be added as a last argument
* in all API interfaces methods.
*/
Boolean getGenerateDataFetchingEnvironmentArgumentInApis();
/**
* Relay-related configurations.
*
* @return Relay-related configurations.
*/
RelayConfig getRelayConfig();
/**
* Fields that require Resolvers should be defined here in format: TypeName, TypeName.fieldName, @directive
* If just type is specified, then all fields of this type will have resolvers
*
* E.g.: "Person.friends"
* E.g.: "Person"
* E.g.: "@customResolver"
*
* @return Set of types and fields that should have Resolver interfaces.
*/
Set getFieldsWithResolvers();
/**
* Fields that DO NOT require Resolvers should be defined here in format: TypeName, TypeName.fieldName, @directive
* If just type is specified, then all fields of this type will NOT have resolvers
* Can be used in conjunction with "generateExtensionFieldsResolvers"
*
* E.g.: "Person.friends"
* E.g.: "Person"
* E.g.: "@noResolver"
*
* @return Set of types and fields that should NOT have Resolver interfaces.
*/
Set getFieldsWithoutResolvers();
/**
* Specifies whether return types of generated API interface should be wrapped into java.util.Optional
*
* @return true if return types should be wrapped into java.util.Optional
*/
Boolean getUseOptionalForNullableReturnTypes();
/**
* Specifies whether client-side classes should be generated for each query, mutation and subscription.
* This includes: `Request` class (contains input data) and `ResponseProjection` class (contains response fields).
*
* @return true if client-side classes should be generated (`Request`, `Response` and `ResponseProjection`)
*/
Boolean getGenerateClient();
/**
* The suffix for `Request` classes.
*
* @return The suffix for `Request` classes.
*/
String getRequestSuffix();
/**
* The suffix for `Response` classes.
*
* @return The suffix for `Response` classes.
*/
String getResponseSuffix();
/**
* The suffix for `ResponseProjection` classes.
*
* @return The suffix for `ResponseProjection` classes.
*/
String getResponseProjectionSuffix();
/**
* The suffix for `ParametrizedInput` classes.
*
* @return The suffix for `ParametrizedInput` classes.
*/
String getParametrizedInputSuffix();
/**
* Interface that will be added as "extend" to all generated api Query interfaces.
*
* @return Parent interface of all GraphQL Query types.
*/
String getQueryResolverParentInterface();
/**
* Interface that will be added as "extend" to all generated api Mutation interfaces.
*
* @return Parent interface of all GraphQL Mutation types.
*/
String getMutationResolverParentInterface();
/**
* Interface that will be added as "extend" to all generated api Subscription interfaces.
*
* @return Parent interface of all GraphQL Subscription types.
*/
String getSubscriptionResolverParentInterface();
/**
* Interface that will be added as "extend" to all generated TypeResolver interfaces.
*
* @return Parent interface of all Resolvers of GraphQL types.
*/
String getResolverParentInterface();
/**
* Interface that will be limit depth when `all$` invoke which has subProjections
*
* @return limit depth when the projection is constructed automatically
*/
Integer getResponseProjectionMaxDepth();
/**
* Default impl will be generate for resolvers
*
* @return true if client-side classes should be generated DefaultXXXResolver.java
*/
Boolean getGenerateDefaultResolverImpl();
}