MappingContext (graphql-java-codegen 1.7.4 API)

java.lang.Object
- com.kobylynskyi.graphql.codegen.model.MappingContext

All Implemented Interfaces:: GraphQLCodegenConfiguration

public class MappingContext
extends java.lang.Object
implements GraphQLCodegenConfiguration

Constructor Summary

Constructors
Constructor and Description

MappingContext()

Constructors
Constructor and Description
`MappingContext()`

Method Summary

All Methods Instance Methods Concrete 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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MappingContext
```
public MappingContext()
```
- Method Detail
  - getCustomTypesMapping
```
public java.util.Map<java.lang.String,java.lang.String> getCustomTypesMapping()
```
    Description copied from 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
    
    Specified by:
    
    getCustomTypesMapping in interface GraphQLCodegenConfiguration
    
    Returns:
    
    mappings from GraphqlType to JavaType
  - getCustomAnnotationsMapping
```
public java.util.Map<java.lang.String,java.lang.String> getCustomAnnotationsMapping()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    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)
    
    Specified by:
    
    getCustomAnnotationsMapping in interface GraphQLCodegenConfiguration
    
    Returns:
    
    mappings from GraphqlType to JavaAnnotation
  - getGenerateApis
```
public java.lang.Boolean getGenerateApis()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    Specifies whether api classes should be generated.
    
    Specified by:
    
    getGenerateApis in interface GraphQLCodegenConfiguration
    
    Returns:
    
    true is API interfaces should be generated.
  - getPackageName
```
public java.lang.String getPackageName()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    Java package for generated classes.
    
    Specified by:
    
    getPackageName in interface GraphQLCodegenConfiguration
    
    Returns:
    
    Java package for generated classes.
  - getApiPackageName
```
public java.lang.String getApiPackageName()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    Java package for generated api classes (Query, Mutation, Subscription).
    
    Specified by:
    
    getApiPackageName in interface GraphQLCodegenConfiguration
    
    Returns:
    
    Java package for generated api classes.
  - getModelPackageName
```
public java.lang.String getModelPackageName()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    Java package for generated model classes (type, input, interface, enum, union).
    
    Specified by:
    
    getModelPackageName in interface GraphQLCodegenConfiguration
    
    Returns:
    
    Java package for generated model classes.
  - getModelNamePrefix
```
public java.lang.String getModelNamePrefix()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    Sets the prefix for GraphQL model classes (type, input, interface, enum, union).
    
    Specified by:
    
    getModelNamePrefix in interface GraphQLCodegenConfiguration
    
    Returns:
    
    The prefix for GraphQL model classes.
  - getModelNameSuffix
```
public java.lang.String getModelNameSuffix()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    Sets the suffix for GraphQL model classes (type, input, interface, enum, union).
    
    Specified by:
    
    getModelNameSuffix in interface GraphQLCodegenConfiguration
    
    Returns:
    
    The prefix for GraphQL model classes.
  - getModelValidationAnnotation
```
public java.lang.String getModelValidationAnnotation()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    Annotation for mandatory (NonNull) fields. Can be null/empty.
    
    Specified by:
    
    getModelValidationAnnotation in interface GraphQLCodegenConfiguration
    
    Returns:
    
    Annotation for mandatory (NonNull) fields
  - getSubscriptionReturnType
```
public java.lang.String getSubscriptionReturnType()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    Return type for subscription methods. For example: `org.reactivestreams.Publisher`, `io.reactivex.Observable`, etc.
    
    Specified by:
    
    getSubscriptionReturnType in interface GraphQLCodegenConfiguration
    
    Returns:
    
    Return type for subscription methods
  - getGenerateBuilder
```
public java.lang.Boolean getGenerateBuilder()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    Specifies whether generated model classes should have builder.
    
    Specified by:
    
    getGenerateBuilder in interface GraphQLCodegenConfiguration
    
    Returns:
    
    true if generated model classes should have builder.
  - getGenerateEqualsAndHashCode
```
public java.lang.Boolean getGenerateEqualsAndHashCode()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    Specifies whether generated model classes should have equals and hashCode methods defined.
    
    Specified by:
    
    getGenerateEqualsAndHashCode in interface GraphQLCodegenConfiguration
    
    Returns:
    
    true if generated model classes should have equals and hashCode methods defined.
  - getGenerateToString
```
public java.lang.Boolean getGenerateToString()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    Specifies whether generated model classes should have toString method defined.
    
    Specified by:
    
    getGenerateToString in interface GraphQLCodegenConfiguration
    
    Returns:
    
    true if generated model classes should have toString method defined.
  - getGenerateAsyncApi
```
public java.lang.Boolean getGenerateAsyncApi()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    If true, then wrap type into `java.util.concurrent.CompletableFuture` or `subscriptionReturnType`
    
    Specified by:
    
    getGenerateAsyncApi in interface GraphQLCodegenConfiguration
    
    Returns:
    
    true if types need to be wrapped into `java.util.concurrent.CompletableFuture` or `subscriptionReturnType`
  - getGenerateParameterizedFieldsResolvers
```
public java.lang.Boolean getGenerateParameterizedFieldsResolvers()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    If true, then generate separate `Resolver` interface for parametrized fields. If false, then add field to the type definition and ignore field parameters.
    
    Specified by:
    
    getGenerateParameterizedFieldsResolvers in interface GraphQLCodegenConfiguration
    
    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
```
public java.lang.Boolean getGenerateExtensionFieldsResolvers()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    Whether all fields in extensions (extend type and extend interface) should be present in Resolver interface instead of the type class itself.
    
    Specified by:
    
    getGenerateExtensionFieldsResolvers in interface GraphQLCodegenConfiguration
    
    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
```
public java.lang.Boolean getGenerateDataFetchingEnvironmentArgumentInApis()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    If true, then graphql.schema.DataFetchingEnvironment env will be added as a last argument to all methods of root type resolvers and field resolvers.
    
    Specified by:
    
    getGenerateDataFetchingEnvironmentArgumentInApis in interface GraphQLCodegenConfiguration
    
    Returns:
    
    true if graphql.schema.DataFetchingEnvironment env should be added as a last argument in all API interfaces methods.
  - getFieldsWithResolvers
```
public java.util.Set<java.lang.String> getFieldsWithResolvers()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    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"
    
    Specified by:
    
    getFieldsWithResolvers in interface GraphQLCodegenConfiguration
    
    Returns:
    
    Set of types and fields that should have Resolver interfaces.
  - getFieldsWithoutResolvers
```
public java.util.Set<java.lang.String> getFieldsWithoutResolvers()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    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"
    
    Specified by:
    
    getFieldsWithoutResolvers in interface GraphQLCodegenConfiguration
    
    Returns:
    
    Set of types and fields that should NOT have Resolver interfaces.
  - getGenerateRequests
```
public java.lang.Boolean getGenerateRequests()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    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).
    
    Specified by:
    
    getGenerateRequests in interface GraphQLCodegenConfiguration
    
    Returns:
    
    true if client-side classes should be generated (`Request` and `ResponseProjection`)
  - getRequestSuffix
```
public java.lang.String getRequestSuffix()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    The suffix for `Request` classes.
    
    Specified by:
    
    getRequestSuffix in interface GraphQLCodegenConfiguration
    
    Returns:
    
    The suffix for `Request` classes.
  - getResponseProjectionSuffix
```
public java.lang.String getResponseProjectionSuffix()
```
    Description copied from interface: GraphQLCodegenConfiguration
    
    The suffix for `ResponseProjection` classes.
    
    Specified by:
    
    getResponseProjectionSuffix in interface GraphQLCodegenConfiguration
    
    Returns:
    
    The suffix for `ResponseProjection` classes.

Class MappingContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MappingContext

Method Detail

getCustomTypesMapping

getCustomAnnotationsMapping

getGenerateApis

getPackageName

getApiPackageName

getModelPackageName

getModelNamePrefix

getModelNameSuffix

getModelValidationAnnotation

getSubscriptionReturnType

getGenerateBuilder

getGenerateEqualsAndHashCode

getGenerateToString

getGenerateAsyncApi

getGenerateParameterizedFieldsResolvers

getGenerateExtensionFieldsResolvers

getGenerateDataFetchingEnvironmentArgumentInApis

getFieldsWithResolvers

getFieldsWithoutResolvers

getGenerateRequests

getRequestSuffix

getResponseProjectionSuffix