GraphQLCodegenConfiguration (graphql-java-codegen 3.1.0 API)

All Known Implementing Classes:

MappingConfig, MappingContext
```
public interface GraphQLCodegenConfiguration
```
Defines all properties that should be parsed in the plugin.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ApiInterfaceStrategy`	`getApiInterfaceStrategy()` Specifies the strategy of generating api interfaces.
`java.lang.String`	`getApiNamePrefix()` Sets the prefix for GraphQL api classes (query, mutation, subscription).
`ApiNamePrefixStrategy`	`getApiNamePrefixStrategy()` Sets prefix strategy for GraphQL api classes (query, mutation, subscription).
`java.lang.String`	`getApiNameSuffix()` Sets the suffix for GraphQL api classes (query, mutation, subscription).
`java.lang.String`	`getApiPackageName()` Java package for generated api classes (Query, Mutation, Subscription).
`java.lang.String`	`getApiReturnListType()` Return type for api methods (query / subscription) that return list values For example: `reactor.core.publisher.Flux`
`java.lang.String`	`getApiReturnType()` Return type for api methods (query / subscription) For example: `reactor.core.publisher.Mono`
`ApiRootInterfaceStrategy`	`getApiRootInterfaceStrategy()` Specifies the strategy of generating root api interface.
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getCustomAnnotationsMapping()` Can be used to supply custom annotations (serializers) for scalars.
`java.util.Map<java.lang.String,java.lang.String>`	`getCustomTypesMapping()` Can be used to supply custom mappings for scalars.
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getDirectiveAnnotationsMapping()` Map GraphQL directives to Java annotations.
`java.util.Set<java.lang.String>`	`getFieldsWithoutResolvers()` 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"
`java.util.Set<java.lang.String>`	`getFieldsWithResolvers()` 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
`java.lang.Boolean`	`getGenerateApis()` Specifies whether api classes should be generated.
`java.lang.Boolean`	`getGenerateBuilder()` Specifies whether generated model classes should have builder.
`java.lang.Boolean`	`getGenerateClient()` Specifies whether client-side classes should be generated for each query, mutation and subscription.
`java.lang.Boolean`	`getGenerateDataFetchingEnvironmentArgumentInApis()` If true, then graphql.schema.DataFetchingEnvironment env will be added as a last argument to all methods of root type resolvers and field resolvers.
`java.lang.Boolean`	`getGenerateEqualsAndHashCode()` Specifies whether generated model classes should have equals and hashCode methods defined.
`java.lang.Boolean`	`getGenerateExtensionFieldsResolvers()` Whether all fields in extensions (`extend type` and `extend interface`) should be present in Resolver interface instead of the type class itself.
`java.lang.Boolean`	`getGenerateImmutableModels()` Specifies whether generated model classes should be immutable.
`java.lang.Boolean`	`getGenerateModelsForRootTypes()` Specifies whether model classes should be generated for Query/Subscription/Mutation.
`java.lang.Boolean`	`getGenerateParameterizedFieldsResolvers()` If true, then generate separate `Resolver` interface for parametrized fields.
`java.lang.Boolean`	`getGenerateToString()` Specifies whether generated model classes should have toString method defined.
`java.lang.String`	`getModelNamePrefix()` Sets the prefix for GraphQL model classes (type, input, interface, enum, union).
`java.lang.String`	`getModelNameSuffix()` Sets the suffix for GraphQL model classes (type, input, interface, enum, union).
`java.lang.String`	`getModelPackageName()` Java package for generated model classes (type, input, interface, enum, union).
`java.lang.String`	`getModelValidationAnnotation()` Annotation for mandatory (NonNull) fields.
`java.lang.String`	`getMutationResolverParentInterface()` Interface that will be added as "extend" to all generated api Mutation interfaces.
`java.lang.String`	`getPackageName()` Java package for generated classes.
`java.lang.String`	`getParametrizedInputSuffix()` The suffix for `ParametrizedInput` classes.
`java.lang.String`	`getQueryResolverParentInterface()` Interface that will be added as "extend" to all generated api Query interfaces.
`RelayConfig`	`getRelayConfig()` Relay-related configurations.
`java.lang.String`	`getRequestSuffix()` The suffix for `Request` classes.
`java.lang.String`	`getResolverParentInterface()` Interface that will be added as "extend" to all generated TypeResolver interfaces.
`java.lang.Integer`	`getResponseProjectionMaxDepth()` Interface that will be limit depth when `all$` invoke which has subProjections
`java.lang.String`	`getResponseProjectionSuffix()` The suffix for `ResponseProjection` classes.
`java.lang.String`	`getResponseSuffix()` The suffix for `Response` classes.
`java.lang.String`	`getSubscriptionResolverParentInterface()` Interface that will be added as "extend" to all generated api Subscription interfaces.
`java.lang.String`	`getSubscriptionReturnType()` Return type for subscription methods.
`java.lang.String`	`getTypeResolverPrefix()` Sets the prefix for GraphQL type resolver classes.
`java.lang.String`	`getTypeResolverSuffix()` Sets the suffix for GraphQL type resolver classes.
`java.lang.Boolean`	`getUseOptionalForNullableReturnTypes()` Specifies whether return types of generated API interface should be wrapped into `java.util.Optional`

- Method Detail
  - getCustomTypesMapping
```
java.util.Map<java.lang.String,java.lang.String> getCustomTypesMapping()
```
    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
    
    Returns:
    
    mappings from GraphqlType to JavaType
  - getCustomAnnotationsMapping
```
java.util.Map<java.lang.String,java.util.List<java.lang.String>> getCustomAnnotationsMapping()
```
    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)
    
    Returns:
    
    mappings from GraphqlType to JavaAnnotation
  - getDirectiveAnnotationsMapping
```
java.util.Map<java.lang.String,java.util.List<java.lang.String>> getDirectiveAnnotationsMapping()
```
    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}})
    
    Returns:
    
    mappings from GraphQL directives to Java annotations.
  - getGenerateApis
```
java.lang.Boolean getGenerateApis()
```
    Specifies whether api classes should be generated.
    
    Returns:
    
    true is API interfaces should be generated.
  - getGenerateModelsForRootTypes
```
java.lang.Boolean getGenerateModelsForRootTypes()
```
    Specifies whether model classes should be generated for Query/Subscription/Mutation.
    
    Returns:
    
    true is model classes (POJOs) should be generated for GraphQL root types.
  - getApiRootInterfaceStrategy
```
ApiRootInterfaceStrategy getApiRootInterfaceStrategy()
```
    Specifies the strategy of generating root api interface.
    
    Returns:
    
    strategy of generating root api interface.
  - getApiInterfaceStrategy
```
ApiInterfaceStrategy getApiInterfaceStrategy()
```
    Specifies the strategy of generating api interfaces.
    
    Returns:
    
    strategy of generating api interfaces.
  - getPackageName
```
java.lang.String getPackageName()
```
    Java package for generated classes.
    
    Returns:
    
    Java package for generated classes.
  - getApiPackageName
```
java.lang.String getApiPackageName()
```
    Java package for generated api classes (Query, Mutation, Subscription).
    
    Returns:
    
    Java package for generated api classes.
  - getModelPackageName
```
java.lang.String getModelPackageName()
```
    Java package for generated model classes (type, input, interface, enum, union).
    
    Returns:
    
    Java package for generated model classes.
  - getModelNamePrefix
```
java.lang.String getModelNamePrefix()
```
    Sets the prefix for GraphQL model classes (type, input, interface, enum, union).
    
    Returns:
    
    The prefix for GraphQL model classes.
  - getModelNameSuffix
```
java.lang.String getModelNameSuffix()
```
    Sets the suffix for GraphQL model classes (type, input, interface, enum, union).
    
    Returns:
    
    The suffix for GraphQL model classes.
  - getApiNamePrefixStrategy
```
ApiNamePrefixStrategy getApiNamePrefixStrategy()
```
    Sets prefix strategy for GraphQL api classes (query, mutation, subscription).
    
    Returns:
    
    Prefix strategy for GraphQL api classes.
  - getApiNamePrefix
```
java.lang.String getApiNamePrefix()
```
    Sets the prefix for GraphQL api classes (query, mutation, subscription).
    
    Returns:
    
    The prefix for GraphQL api classes.
  - getApiNameSuffix
```
java.lang.String getApiNameSuffix()
```
    Sets the suffix for GraphQL api classes (query, mutation, subscription).
    
    Returns:
    
    The suffix for GraphQL api classes.
  - getModelValidationAnnotation
```
java.lang.String getModelValidationAnnotation()
```
    Annotation for mandatory (NonNull) fields. Can be null/empty.
    
    Returns:
    
    Annotation for mandatory (NonNull) fields
  - getApiReturnType
```
java.lang.String getApiReturnType()
```
    Return type for api methods (query / subscription) For example: `reactor.core.publisher.Mono`
    
    Returns:
    
    Return type for api methods (query / subscription)
  - getApiReturnListType
```
java.lang.String getApiReturnListType()
```
    Return type for api methods (query / subscription) that return list values For example: `reactor.core.publisher.Flux`
    
    Returns:
    
    Return type for api methods (query / subscription) that return list values
  - getSubscriptionReturnType
```
java.lang.String getSubscriptionReturnType()
```
    Return type for subscription methods. For example: `org.reactivestreams.Publisher`, `io.reactivex.Observable`, etc.
    
    Returns:
    
    Return type for subscription methods
  - getGenerateBuilder
```
java.lang.Boolean getGenerateBuilder()
```
    Specifies whether generated model classes should have builder.
    
    Returns:
    
    true if generated model classes should have builder.
  - getGenerateEqualsAndHashCode
```
java.lang.Boolean getGenerateEqualsAndHashCode()
```
    Specifies whether generated model classes should have equals and hashCode methods defined.
    
    Returns:
    
    true if generated model classes should have equals and hashCode methods defined.
  - getGenerateImmutableModels
```
java.lang.Boolean getGenerateImmutableModels()
```
    Specifies whether generated model classes should be immutable.
    
    Returns:
    
    true if generated model classes should be immutable.
  - getGenerateToString
```
java.lang.Boolean getGenerateToString()
```
    Specifies whether generated model classes should have toString method defined.
    
    Returns:
    
    true if generated model classes should have toString method defined.
  - getGenerateParameterizedFieldsResolvers
```
java.lang.Boolean getGenerateParameterizedFieldsResolvers()
```
    If true, then generate separate `Resolver` interface for parametrized fields. If false, then add field to the type definition and ignore field parameters.
    
    Returns:
    
    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.
  - getTypeResolverPrefix
```
java.lang.String getTypeResolverPrefix()
```
    Sets the prefix for GraphQL type resolver classes.
    
    Returns:
    
    The prefix for GraphQL type resolver classes.
  - getTypeResolverSuffix
```
java.lang.String getTypeResolverSuffix()
```
    Sets the suffix for GraphQL type resolver classes.
    
    Returns:
    
    The suffix for GraphQL type resolver classes.
  - getGenerateExtensionFieldsResolvers
```
java.lang.Boolean getGenerateExtensionFieldsResolvers()
```
    Whether all fields in extensions (extend type and extend interface) should be present in Resolver interface instead of the type class itself.
    
    Returns:
    
    true if all fields in extensions (extend type and extend interface) should be present in Resolver interface instead of the type class itself.
  - getGenerateDataFetchingEnvironmentArgumentInApis
```
java.lang.Boolean getGenerateDataFetchingEnvironmentArgumentInApis()
```
    If true, then graphql.schema.DataFetchingEnvironment env will be added as a last argument to all methods of root type resolvers and field resolvers.
    
    Returns:
    
    true if graphql.schema.DataFetchingEnvironment env should be added as a last argument in all API interfaces methods.
  - getRelayConfig
```
RelayConfig getRelayConfig()
```
    Relay-related configurations.
    
    Returns:
    
    Relay-related configurations.
  - getFieldsWithResolvers
```
java.util.Set<java.lang.String> getFieldsWithResolvers()
```
    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"
    
    Returns:
    
    Set of types and fields that should have Resolver interfaces.
  - getFieldsWithoutResolvers
```
java.util.Set<java.lang.String> getFieldsWithoutResolvers()
```
    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"
    
    Returns:
    
    Set of types and fields that should NOT have Resolver interfaces.
  - getUseOptionalForNullableReturnTypes
```
java.lang.Boolean getUseOptionalForNullableReturnTypes()
```
    Specifies whether return types of generated API interface should be wrapped into java.util.Optional
    
    Returns:
    
    true if return types should be wrapped into java.util.Optional
  - getGenerateClient
```
java.lang.Boolean getGenerateClient()
```
    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).
    
    Returns:
    
    true if client-side classes should be generated (`Request`, `Response` and `ResponseProjection`)
  - getRequestSuffix
```
java.lang.String getRequestSuffix()
```
    The suffix for `Request` classes.
    
    Returns:
    
    The suffix for `Request` classes.
  - getResponseSuffix
```
java.lang.String getResponseSuffix()
```
    The suffix for `Response` classes.
    
    Returns:
    
    The suffix for `Response` classes.
  - getResponseProjectionSuffix
```
java.lang.String getResponseProjectionSuffix()
```
    The suffix for `ResponseProjection` classes.
    
    Returns:
    
    The suffix for `ResponseProjection` classes.
  - getParametrizedInputSuffix
```
java.lang.String getParametrizedInputSuffix()
```
    The suffix for `ParametrizedInput` classes.
    
    Returns:
    
    The suffix for `ParametrizedInput` classes.
  - getQueryResolverParentInterface
```
java.lang.String getQueryResolverParentInterface()
```
    Interface that will be added as "extend" to all generated api Query interfaces.
    
    Returns:
    
    Parent interface of all GraphQL Query types.
  - getMutationResolverParentInterface
```
java.lang.String getMutationResolverParentInterface()
```
    Interface that will be added as "extend" to all generated api Mutation interfaces.
    
    Returns:
    
    Parent interface of all GraphQL Mutation types.
  - getSubscriptionResolverParentInterface
```
java.lang.String getSubscriptionResolverParentInterface()
```
    Interface that will be added as "extend" to all generated api Subscription interfaces.
    
    Returns:
    
    Parent interface of all GraphQL Subscription types.
  - getResolverParentInterface
```
java.lang.String getResolverParentInterface()
```
    Interface that will be added as "extend" to all generated TypeResolver interfaces.
    
    Returns:
    
    Parent interface of all Resolvers of GraphQL types.
  - getResponseProjectionMaxDepth
```
java.lang.Integer getResponseProjectionMaxDepth()
```
    Interface that will be limit depth when `all$` invoke which has subProjections
    
    Returns:
    
    limit depth when the projection is constructed automatically

Interface GraphQLCodegenConfiguration

Method Summary

Method Detail

getCustomTypesMapping

getCustomAnnotationsMapping

getDirectiveAnnotationsMapping

getGenerateApis

getGenerateModelsForRootTypes

getApiRootInterfaceStrategy

getApiInterfaceStrategy

getPackageName

getApiPackageName

getModelPackageName

getModelNamePrefix

getModelNameSuffix

getApiNamePrefixStrategy

getApiNamePrefix

getApiNameSuffix

getModelValidationAnnotation

getApiReturnType

getApiReturnListType

getSubscriptionReturnType

getGenerateBuilder

getGenerateEqualsAndHashCode

getGenerateImmutableModels

getGenerateToString

getGenerateParameterizedFieldsResolvers

getTypeResolverPrefix

getTypeResolverSuffix

getGenerateExtensionFieldsResolvers

getGenerateDataFetchingEnvironmentArgumentInApis

getRelayConfig

getFieldsWithResolvers

getFieldsWithoutResolvers

getUseOptionalForNullableReturnTypes

getGenerateClient

getRequestSuffix

getResponseSuffix

getResponseProjectionSuffix

getParametrizedInputSuffix

getQueryResolverParentInterface

getMutationResolverParentInterface

getSubscriptionResolverParentInterface

getResolverParentInterface

getResponseProjectionMaxDepth