GraphQLCodegenConfiguration (graphql-java-codegen 1.7.3 API)

All Known Implementing Classes:

MappingConfig
```
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
`java.lang.String`	`getApiPackageName()` Java package for generated api classes (Query, Mutation, Subscription).
`java.util.Map<java.lang.String,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.Set<java.lang.String>`	`getFieldsWithoutResolvers()` Fields that DO NOT require Resolvers should be defined here in format: TypeName.fieldName 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.fieldName 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`	`getGenerateAsyncApi()` If true, then wrap type into `java.util.concurrent.CompletableFuture` or `subscriptionReturnType`
`java.lang.Boolean`	`getGenerateBuilder()` Specifies whether generated model classes should have builder.
`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`	`getGenerateParameterizedFieldsResolvers()` If true, then generate separate `Resolver` interface for parametrized fields.
`java.lang.Boolean`	`getGenerateRequests()` Specifies whether client-side classes should be generated for each query, mutation and subscription.
`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`	`getPackageName()` Java package for generated classes.
`java.lang.String`	`getRequestSuffix()` The suffix for `Request` classes.
`java.lang.String`	`getResponseProjectionSuffix()` The suffix for `ResponseProjection` classes.
`java.lang.String`	`getSubscriptionReturnType()` Return type for subscription methods.

- 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.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
  - getGenerateApis
```
java.lang.Boolean getGenerateApis()
```
    Specifies whether api classes should be generated.
    
    Returns:
    
    true is API interfaces should be generated.
  - 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 prefix for GraphQL model classes.
  - getModelValidationAnnotation
```
java.lang.String getModelValidationAnnotation()
```
    Annotation for mandatory (NonNull) fields. Can be null/empty.
    
    Returns:
    
    Annotation for mandatory (NonNull) fields
  - 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.
  - 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.
  - getGenerateAsyncApi
```
java.lang.Boolean getGenerateAsyncApi()
```
    If true, then wrap type into `java.util.concurrent.CompletableFuture` or `subscriptionReturnType`
    
    Returns:
    
    true if types need to be wrapped into `java.util.concurrent.CompletableFuture` or `subscriptionReturnType`
  - 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.
  - 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.
  - getFieldsWithResolvers
```
java.util.Set<java.lang.String> getFieldsWithResolvers()
```
    Fields that require Resolvers should be defined here in format: TypeName.fieldName If just type is specified, then all fields of this type will have resolvers
    E.g.: "Person.friends" E.g.: "Person"
    
    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.fieldName 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"
    
    Returns:
    
    Set of types and fields that should NOT have Resolver interfaces.
  - getGenerateRequests
```
java.lang.Boolean getGenerateRequests()
```
    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` and `ResponseProjection`)
  - getRequestSuffix
```
java.lang.String getRequestSuffix()
```
    The suffix for `Request` classes.
    
    Returns:
    
    The suffix for `Request` classes.
  - getResponseProjectionSuffix
```
java.lang.String getResponseProjectionSuffix()
```
    The suffix for `ResponseProjection` classes.
    
    Returns:
    
    The suffix for `ResponseProjection` classes.

Interface GraphQLCodegenConfiguration

Method Summary

Method Detail

getCustomTypesMapping

getCustomAnnotationsMapping

getGenerateApis

getPackageName

getApiPackageName

getModelPackageName

getModelNamePrefix

getModelNameSuffix

getModelValidationAnnotation

getSubscriptionReturnType

getGenerateBuilder

getGenerateEqualsAndHashCode

getGenerateToString

getGenerateAsyncApi

getGenerateParameterizedFieldsResolvers

getGenerateExtensionFieldsResolvers

getGenerateDataFetchingEnvironmentArgumentInApis

getFieldsWithResolvers

getFieldsWithoutResolvers

getGenerateRequests

getRequestSuffix

getResponseProjectionSuffix