Package io.github.besi97.graphql.codegen.model

Class MappingContext

java.lang.Object

io.github.besi97.graphql.codegen.model.MappingContext

All Implemented Interfaces:

GraphQLCodegenConfiguration

public class MappingContext
extends Object
implements GraphQLCodegenConfiguration

A context of a single mapping process. Contains mapping configuration, parsed schema elements and other things used in code generation process

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MappingContext.Builder	Builder of the mapping context

Method Summary

Modifier and Type	Method	Description
static MappingContext.Builder	builder()
Boolean	getAddGeneratedAnnotation()	Specifies whether generated classes should be annotated with @Generated
Boolean	getAddGeneratedAnnotationDate()	Specifies whether the @Generated annotation should include the date attribute.
ApiInterfaceStrategy	getApiInterfaceStrategy()	Specifies the strategy of generating api interfaces.
String	getApiNamePrefix()	Sets the prefix for GraphQL api classes (query, mutation, subscription).
ApiNamePrefixStrategy	getApiNamePrefixStrategy()	Sets prefix strategy for GraphQL api classes (query, mutation, subscription).
String	getApiNameSuffix()	Sets the suffix for GraphQL api classes (query, mutation, subscription).
String	getApiPackageName()	Java package for generated api classes (Query, Mutation, Subscription).
String	getApiReturnListType()	Return type for api methods (query / subscription) that return list values For example: reactor.core.publisher.Flux
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.
Map<String,List<String>>	getCustomAnnotationsMapping()	Can be used to supply custom annotations (serializers) for scalars.
Map<String,String>	getCustomTemplates()	Can be used to supply paths to custom FreeMarker templates for code generation.
File	getCustomTemplatesRoot()	Can be used to specify the root directory for the custom FreeMaker templates
Map<String,String>	getCustomTypesMapping()	Can be used to supply custom mappings for scalars.
Map<String,List<String>>	getDirectiveAnnotationsMapping()	Map GraphQL directives to Java annotations.
ExtendedDocument	getDocument()
Set<String>	getFieldNamesWithResolvers()	Get names of all the fields that require separate resolver class.
Set<String>	getFieldsToExcludeFromGeneration()	Fields that WILL NOT be generated.
Set<String>	getFieldsWithDataFetcherResult()	Fields that require DataFetcherResult.
Set<String>	getFieldsWithoutResolvers()	Fields that DO NOT require Resolvers.
Set<String>	getFieldsWithResolvers()	Fields that require Resolvers.
Boolean	getGenerateAllMethodInProjection()	Enables the generation of the all$ method in the projection classes of the client.
Boolean	getGenerateApis()	Specifies whether api classes should be generated.
Boolean	getGenerateApisWithSuspendFunctions()	Whether signatures of API interface methods should have suspend modifier.
Boolean	getGenerateApisWithThrowsException()	Whether signatures of API interface methods should have throws Exception.
Boolean	getGenerateBuilder()	Specifies whether generated model classes should have builder.
Boolean	getGenerateClient()	Specifies whether client-side classes should be generated for each query, mutation and subscription.
String	getGeneratedAnnotation()	Returns a qualified class name (with package) of the Generated annotation that will be added on top of every generated class.
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.
GeneratedInformation	getGeneratedInformation()
GeneratedLanguage	getGeneratedLanguage()	Generate code with lang
Boolean	getGenerateEqualsAndHashCode()	Specifies whether generated model classes should have equals and hashCode methods defined.
Boolean	getGenerateExtensionFieldsResolvers()	Whether all fields in extensions (extend type and extend interface) should be present in Resolver interface instead of the type class itself.
Boolean	getGenerateImmutableModels()	Specifies whether generated model classes should be immutable.
Boolean	getGenerateJacksonTypeIdResolver()	Specifies whether generated union interfaces should be annotated with a Jackson type id resolver generated in model package.
Boolean	getGenerateModelsForRootTypes()	Specifies whether model classes should be generated for Query/Subscription/Mutation.
Boolean	getGenerateParameterizedFieldsResolvers()	If true, then generate separate `Resolver` interface for parametrized fields.
Boolean	getGenerateToString()	Specifies whether generated model classes should have toString method defined.
Set<String>	getInputsName()
Map<String,Set<String>>	getInterfaceChildren()
Set<String>	getInterfacesName()
String	getModelNamePrefix()	Sets the prefix for GraphQL model classes (type, input, interface, enum, union).
String	getModelNameSuffix()	Sets the suffix for GraphQL model classes (type, input, interface, enum, union).
String	getModelPackageName()	Java package for generated model classes (type, input, interface, enum, union).
String	getModelValidationAnnotation()	Annotation for mandatory (NonNull) fields.
String	getMutationResolverParentInterface()	Interface that will be added as "extend" to all generated api Mutation interfaces.
Set<String>	getOperationsName()
File	getOutputDirectory()
String	getPackageName()	Java package for generated classes.
String	getParametrizedInputSuffix()	The suffix for `ParametrizedInput` classes.
Set<String>	getParametrizedResolverAnnotations()	Annotations that will be added to all parametrized resolver methods.
Map<String,Set<String>>	getParentInterfaceProperties()	Get a list of fields for each interface This method is used only for Kotlin
String	getQueryResolverParentInterface()	Interface that will be added as "extend" to all generated api Query interfaces.
RelayConfig	getRelayConfig()	Relay-related configurations.
String	getRequestSuffix()	The suffix for `Request` classes.
Set<String>	getResolverArgumentAnnotations()	Annotations that will be added to all resolver arguments.
String	getResolverParentInterface()	Interface that will be added as "extend" to all generated TypeResolver interfaces.
Integer	getResponseProjectionMaxDepth()	Limit depth when `all$` invoke which has subProjections
String	getResponseProjectionSuffix()	The suffix for `ResponseProjection` classes.
String	getResponseSuffix()	The suffix for `Response` classes.
String	getSubscriptionResolverParentInterface()	Interface that will be added as "extend" to all generated api Subscription interfaces.
String	getSubscriptionReturnType()	Return type for subscription methods.
String	getTypeResolverPrefix()	Sets the prefix for GraphQL type resolver classes.
String	getTypeResolverSuffix()	Sets the suffix for GraphQL type resolver classes.
Set<String>	getTypesAsInterfaces()	Types that must generated as interfaces.
Set<String>	getTypesUnionsInterfacesNames()
Set<String>	getUnionsNames()
String	getUnknownFieldsPropertyName()	Specifies the name of the property to be included in api classes to support unknown fields during serialization or deserialization
Set<String>	getUseObjectMapperForRequestSerialization()	Fields that require serialization using ObjectMapper.writeValueAsString(Object)
Boolean	getUseOptionalForNullableReturnTypes()	Specifies whether return types of generated API interface should be wrapped into java.util.Optional
Boolean	getUseWrapperForNullableInputTypes()	Specifies whether input types of generated input classes should be wrapped into ArgumentValue.
Boolean	isGenerateModelOpenClasses()
Boolean	isGenerateModelsWithPublicFields()
Boolean	isGenerateNoArgsConstructorOnly()
Boolean	isGenerateSealedInterfaces()
Boolean	isInitializeNullableTypes()
Boolean	isSupportUnknownFields()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.besi97.graphql.codegen.model.GraphQLCodegenConfiguration

getGenerateModelOpenClasses, getGenerateModelsWithPublicFields, getGenerateNoArgsConstructorOnly, getGenerateSealedInterfaces, getInitializeNullableTypes, getSupportUnknownFields

Method Details

getGeneratedLanguage

public GeneratedLanguage getGeneratedLanguage()

Description copied from interface: GraphQLCodegenConfiguration

Generate code with lang

Specified by:

getGeneratedLanguage in interface GraphQLCodegenConfiguration

Returns:

GeneratedLanguage.KOTLIN or GeneratedLanguage.JAVA

isGenerateModelOpenClasses

public Boolean isGenerateModelOpenClasses()

Specified by:

isGenerateModelOpenClasses in interface GraphQLCodegenConfiguration

isInitializeNullableTypes

public Boolean isInitializeNullableTypes()

Specified by:

isInitializeNullableTypes in interface GraphQLCodegenConfiguration

isGenerateSealedInterfaces

public Boolean isGenerateSealedInterfaces()

Specified by:

isGenerateSealedInterfaces in interface GraphQLCodegenConfiguration

getCustomTypesMapping

public Map<String,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
• Price.amount --- java.math.BigDecimal

Specified by:

getCustomTypesMapping in interface GraphQLCodegenConfiguration

Returns:

mappings from GraphqlType to JavaType

getCustomTemplatesRoot

public File getCustomTemplatesRoot()

Description copied from interface: GraphQLCodegenConfiguration

Can be used to specify the root directory for the custom FreeMaker templates

Specified by:

getCustomTemplatesRoot in interface GraphQLCodegenConfiguration

Returns:

the directory source for the root directory

getCustomTemplates

public Map<String,String> getCustomTemplates()

Description copied from interface: GraphQLCodegenConfiguration

Can be used to supply paths to custom FreeMarker templates for code generation.

Specified by:

getCustomTemplates in interface GraphQLCodegenConfiguration

Returns:

a map, where key is a template type and a value is path to a FreeMarker template

getCustomAnnotationsMapping

public Map<String,List<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

getDirectiveAnnotationsMapping

public Map<String,List<String>> getDirectiveAnnotationsMapping()

Description copied from interface: GraphQLCodegenConfiguration

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}})

Specified by:

getDirectiveAnnotationsMapping in interface GraphQLCodegenConfiguration

Returns:

mappings from GraphQL directives to Java annotations.

getGenerateApis

public 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.

getGenerateModelsForRootTypes

public Boolean getGenerateModelsForRootTypes()

Description copied from interface: GraphQLCodegenConfiguration

Specifies whether model classes should be generated for Query/Subscription/Mutation.

Specified by:

getGenerateModelsForRootTypes in interface GraphQLCodegenConfiguration

Returns:

true is model classes (POJOs) should be generated for GraphQL root types.

getApiRootInterfaceStrategy

public ApiRootInterfaceStrategy getApiRootInterfaceStrategy()

Description copied from interface: GraphQLCodegenConfiguration

Specifies the strategy of generating root api interface.

Specified by:

getApiRootInterfaceStrategy in interface GraphQLCodegenConfiguration

Returns:

strategy of generating root api interface.

getApiInterfaceStrategy

public ApiInterfaceStrategy getApiInterfaceStrategy()

Description copied from interface: GraphQLCodegenConfiguration

Specifies the strategy of generating api interfaces.

Specified by:

getApiInterfaceStrategy in interface GraphQLCodegenConfiguration

Returns:

strategy of generating api interfaces.

getPackageName

public 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 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 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 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 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 suffix for GraphQL model classes.

getApiNamePrefixStrategy

public ApiNamePrefixStrategy getApiNamePrefixStrategy()

Description copied from interface: GraphQLCodegenConfiguration

Sets prefix strategy for GraphQL api classes (query, mutation, subscription).

Specified by:

getApiNamePrefixStrategy in interface GraphQLCodegenConfiguration

Returns:

Prefix strategy for GraphQL api classes.

getApiNamePrefix

public String getApiNamePrefix()

Description copied from interface: GraphQLCodegenConfiguration

Sets the prefix for GraphQL api classes (query, mutation, subscription).

Specified by:

getApiNamePrefix in interface GraphQLCodegenConfiguration

Returns:

The prefix for GraphQL api classes.

getApiNameSuffix

public String getApiNameSuffix()

Description copied from interface: GraphQLCodegenConfiguration

Sets the suffix for GraphQL api classes (query, mutation, subscription).

Specified by:

getApiNameSuffix in interface GraphQLCodegenConfiguration

Returns:

The suffix for GraphQL api classes.

getModelValidationAnnotation

public 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

getApiReturnType

public String getApiReturnType()

Description copied from interface: GraphQLCodegenConfiguration

Return type for api methods (query / subscription) For example: reactor.core.publisher.Mono

Specified by:

getApiReturnType in interface GraphQLCodegenConfiguration

Returns:

Return type for api methods (query / subscription)

getApiReturnListType

public String getApiReturnListType()

Description copied from interface: GraphQLCodegenConfiguration

Return type for api methods (query / subscription) that return list values For example: reactor.core.publisher.Flux

Specified by:

getApiReturnListType in interface GraphQLCodegenConfiguration

Returns:

Return type for api methods (query / subscription) that return list values

getSubscriptionReturnType

public 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 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 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.

getGenerateImmutableModels

public Boolean getGenerateImmutableModels()

Description copied from interface: GraphQLCodegenConfiguration

Specifies whether generated model classes should be immutable.

Specified by:

getGenerateImmutableModels in interface GraphQLCodegenConfiguration

Returns:

true if generated model classes should be immutable.

getGenerateToString

public 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.

getGenerateParameterizedFieldsResolvers

public 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.

getTypeResolverPrefix

public String getTypeResolverPrefix()

Description copied from interface: GraphQLCodegenConfiguration

Sets the prefix for GraphQL type resolver classes.

Specified by:

getTypeResolverPrefix in interface GraphQLCodegenConfiguration

Returns:

The prefix for GraphQL type resolver classes.

getTypeResolverSuffix

public String getTypeResolverSuffix()

Description copied from interface: GraphQLCodegenConfiguration

Sets the suffix for GraphQL type resolver classes.

Specified by:

getTypeResolverSuffix in interface GraphQLCodegenConfiguration

Returns:

The suffix for GraphQL type resolver classes.

getGenerateExtensionFieldsResolvers

public 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 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.

getGenerateApisWithThrowsException

public Boolean getGenerateApisWithThrowsException()

Description copied from interface: GraphQLCodegenConfiguration

Whether signatures of API interface methods should have throws Exception.

Specified by:

getGenerateApisWithThrowsException in interface GraphQLCodegenConfiguration

Returns:

true if API interfaces methods signature should contain throws Exception.

getGenerateApisWithSuspendFunctions

public Boolean getGenerateApisWithSuspendFunctions()

Description copied from interface: GraphQLCodegenConfiguration

Whether signatures of API interface methods should have suspend modifier.

Specified by:

getGenerateApisWithSuspendFunctions in interface GraphQLCodegenConfiguration

Returns:

true if API interfaces methods signature should contain suspend modifier.

getAddGeneratedAnnotation

public Boolean getAddGeneratedAnnotation()

Description copied from interface: GraphQLCodegenConfiguration

Specifies whether generated classes should be annotated with @Generated

Specified by:

getAddGeneratedAnnotation in interface GraphQLCodegenConfiguration

Returns:

true if classes should be annotated with @Generated

getAddGeneratedAnnotationDate

public Boolean getAddGeneratedAnnotationDate()

Description copied from interface: GraphQLCodegenConfiguration

Specifies whether the @Generated annotation should include the date attribute.

Specified by:

getAddGeneratedAnnotationDate in interface GraphQLCodegenConfiguration

Returns:

true if the date attribute should be included in the @Generated annotation

getGenerateJacksonTypeIdResolver

public Boolean getGenerateJacksonTypeIdResolver()

Description copied from interface: GraphQLCodegenConfiguration

Specifies whether generated union interfaces should be annotated with a Jackson type id resolver generated in model package.

Specified by:

getGenerateJacksonTypeIdResolver in interface GraphQLCodegenConfiguration

Returns:

true if union interfaces should be annotated with a Jackson type id resolver generated in model package

getRelayConfig

public RelayConfig getRelayConfig()

Description copied from interface: GraphQLCodegenConfiguration

Relay-related configurations.

Specified by:

getRelayConfig in interface GraphQLCodegenConfiguration

Returns:

Relay-related configurations.

getUseOptionalForNullableReturnTypes

public Boolean getUseOptionalForNullableReturnTypes()

Description copied from interface: GraphQLCodegenConfiguration

Specifies whether return types of generated API interface should be wrapped into java.util.Optional

Specified by:

getUseOptionalForNullableReturnTypes in interface GraphQLCodegenConfiguration

Returns:

true if return types should be wrapped into java.util.Optional

getUseWrapperForNullableInputTypes

public Boolean getUseWrapperForNullableInputTypes()

Description copied from interface: GraphQLCodegenConfiguration

Specifies whether input types of generated input classes should be wrapped into ArgumentValue.

Specified by:

getUseWrapperForNullableInputTypes in interface GraphQLCodegenConfiguration

Returns:

true if input types should be wrapped into ArgumentValue

getFieldsWithResolvers

public Set<String> getFieldsWithResolvers()

Description copied from interface: GraphQLCodegenConfiguration

Fields that require Resolvers.

Values 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
• Person.friends
• @customResolver

Specified by:

getFieldsWithResolvers in interface GraphQLCodegenConfiguration

Returns:

Set of types and fields that should have Resolver interfaces.

getFieldsWithoutResolvers

public Set<String> getFieldsWithoutResolvers()

Description copied from interface: GraphQLCodegenConfiguration

Fields that DO NOT require Resolvers.

Values 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
• Person.friends
• @customResolver

Specified by:

getFieldsWithoutResolvers in interface GraphQLCodegenConfiguration

Returns:

Set of types and fields that should NOT have Resolver interfaces.

getFieldsToExcludeFromGeneration

public Set<String> getFieldsToExcludeFromGeneration()

Description copied from interface: GraphQLCodegenConfiguration

Fields that WILL NOT be generated.

Values should be defined here in format: TypeName.fieldName

E.g.:

• Person.friends

Specified by:

getFieldsToExcludeFromGeneration in interface GraphQLCodegenConfiguration

Returns:

Set of types and fields that should NOT be generated.

getFieldsWithDataFetcherResult

public Set<String> getFieldsWithDataFetcherResult()

Description copied from interface: GraphQLCodegenConfiguration

Fields that require DataFetcherResult.

Values should be defined here in format: TypeName, TypeName.fieldName, @directive

E.g.:

• @dataFetcherResult

Specified by:

getFieldsWithDataFetcherResult in interface GraphQLCodegenConfiguration

Returns:

Set of types and fields that should have DataFetcherResult.

getGenerateClient

public Boolean getGenerateClient()

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:

getGenerateClient in interface GraphQLCodegenConfiguration

Returns:

true if client-side classes should be generated (`Request`, `Response` and `ResponseProjection`)

getRequestSuffix

public String getRequestSuffix()

Description copied from interface: GraphQLCodegenConfiguration

The suffix for `Request` classes.

Specified by:

getRequestSuffix in interface GraphQLCodegenConfiguration

Returns:

The suffix for `Request` classes.

getResponseSuffix

public String getResponseSuffix()

Description copied from interface: GraphQLCodegenConfiguration

The suffix for `Response` classes.

Specified by:

getResponseSuffix in interface GraphQLCodegenConfiguration

Returns:

The suffix for `Response` classes.

getResponseProjectionSuffix

public String getResponseProjectionSuffix()

Description copied from interface: GraphQLCodegenConfiguration

The suffix for `ResponseProjection` classes.

Specified by:

getResponseProjectionSuffix in interface GraphQLCodegenConfiguration

Returns:

The suffix for `ResponseProjection` classes.

getParametrizedInputSuffix

public String getParametrizedInputSuffix()

Description copied from interface: GraphQLCodegenConfiguration

The suffix for `ParametrizedInput` classes.

Specified by:

getParametrizedInputSuffix in interface GraphQLCodegenConfiguration

Returns:

The suffix for `ParametrizedInput` classes.

getQueryResolverParentInterface

public String getQueryResolverParentInterface()

Description copied from interface: GraphQLCodegenConfiguration

Interface that will be added as "extend" to all generated api Query interfaces.

Specified by:

getQueryResolverParentInterface in interface GraphQLCodegenConfiguration

Returns:

Parent interface of all GraphQL Query types.

getMutationResolverParentInterface

public String getMutationResolverParentInterface()

Description copied from interface: GraphQLCodegenConfiguration

Interface that will be added as "extend" to all generated api Mutation interfaces.

Specified by:

getMutationResolverParentInterface in interface GraphQLCodegenConfiguration

Returns:

Parent interface of all GraphQL Mutation types.

getSubscriptionResolverParentInterface

public String getSubscriptionResolverParentInterface()

Description copied from interface: GraphQLCodegenConfiguration

Interface that will be added as "extend" to all generated api Subscription interfaces.

Specified by:

getSubscriptionResolverParentInterface in interface GraphQLCodegenConfiguration

Returns:

Parent interface of all GraphQL Subscription types.

getResolverParentInterface

public String getResolverParentInterface()

Description copied from interface: GraphQLCodegenConfiguration

Interface that will be added as "extend" to all generated TypeResolver interfaces.

Specified by:

getResolverParentInterface in interface GraphQLCodegenConfiguration

Returns:

Parent interface of all Resolvers of GraphQL types.

getGenerateAllMethodInProjection

public Boolean getGenerateAllMethodInProjection()

Description copied from interface: GraphQLCodegenConfiguration

Enables the generation of the all$ method in the projection classes of the client.

Specified by:

getGenerateAllMethodInProjection in interface GraphQLCodegenConfiguration

Returns:

whether the generation is enabled.

getResponseProjectionMaxDepth

public Integer getResponseProjectionMaxDepth()

Description copied from interface: GraphQLCodegenConfiguration

Limit depth when `all$` invoke which has subProjections

Specified by:

getResponseProjectionMaxDepth in interface GraphQLCodegenConfiguration

Returns:

limit depth when the projection is constructed automatically

getUseObjectMapperForRequestSerialization

public Set<String> getUseObjectMapperForRequestSerialization()

Description copied from interface: GraphQLCodegenConfiguration

Fields that require serialization using ObjectMapper.writeValueAsString(Object)

Values should be defined here in format: GraphqlObjectName.fieldName or GraphqlTypeName

If just type is specified, then all fields of this type will be serialized using ObjectMapper.

E.g.:

• Person.createdDateTime
• ZonedDateTime

Specified by:

getUseObjectMapperForRequestSerialization in interface GraphQLCodegenConfiguration

Returns:

Set of types and fields that should be serialized using ObjectMapper.writeValueAsString(Object)

getTypesAsInterfaces

public Set<String> getTypesAsInterfaces()

Description copied from interface: GraphQLCodegenConfiguration

Types that must generated as interfaces.

Values should be defined here in format: TypeName, @directive

E.g.:

• Person
• @asInterface

Specified by:

getTypesAsInterfaces in interface GraphQLCodegenConfiguration

Returns:

Set of types that should generated as interfaces.

getResolverArgumentAnnotations

public Set<String> getResolverArgumentAnnotations()

Description copied from interface: GraphQLCodegenConfiguration

Annotations that will be added to all resolver arguments.

E.g.:

• @org.springframework.graphql.data.method.annotation.Argument

Specified by:

getResolverArgumentAnnotations in interface GraphQLCodegenConfiguration

Returns:

Set of annotations that every resolver argument will have.

getParametrizedResolverAnnotations

public Set<String> getParametrizedResolverAnnotations()

Description copied from interface: GraphQLCodegenConfiguration

Annotations that will be added to all parametrized resolver methods.

E.g.:

• @org.springframework.graphql.data.method.annotation.Argument

Specified by:

getParametrizedResolverAnnotations in interface GraphQLCodegenConfiguration

Returns:

Set of annotations that every parametrized resolver method will have.

isSupportUnknownFields

public Boolean isSupportUnknownFields()

Specified by:

isSupportUnknownFields in interface GraphQLCodegenConfiguration

getUnknownFieldsPropertyName

public String getUnknownFieldsPropertyName()

Description copied from interface: GraphQLCodegenConfiguration

Specifies the name of the property to be included in api classes to support unknown fields during serialization or deserialization

Specified by:

getUnknownFieldsPropertyName in interface GraphQLCodegenConfiguration

Returns:

The name of the property to store unknown fields

getGeneratedAnnotation

public String getGeneratedAnnotation()

Description copied from interface: GraphQLCodegenConfiguration

Returns a qualified class name (with package) of the Generated annotation that will be added on top of every generated class.

Specified by:

getGeneratedAnnotation in interface GraphQLCodegenConfiguration

Returns:

The name of the class for @Generated annotation

See Also:

• "jakarta.annotation.Generated"
• "javax.annotation.processing.Generated"
• "javax.annotation.Generated"

isGenerateNoArgsConstructorOnly

public Boolean isGenerateNoArgsConstructorOnly()

Specified by:

isGenerateNoArgsConstructorOnly in interface GraphQLCodegenConfiguration

isGenerateModelsWithPublicFields

public Boolean isGenerateModelsWithPublicFields()

Specified by:

isGenerateModelsWithPublicFields in interface GraphQLCodegenConfiguration

getDocument

public ExtendedDocument getDocument()

getTypesUnionsInterfacesNames

public Set<String> getTypesUnionsInterfacesNames()

getInterfacesName

public Set<String> getInterfacesName()

getUnionsNames

public Set<String> getUnionsNames()

getOperationsName

public Set<String> getOperationsName()

getInputsName

public Set<String> getInputsName()

getInterfaceChildren

public Map<String,Set<String>> getInterfaceChildren()

getGeneratedInformation

public GeneratedInformation getGeneratedInformation()

getOutputDirectory

public File getOutputDirectory()

getParentInterfaceProperties

public Map<String,Set<String>> getParentInterfaceProperties()

Get a list of fields for each interface This method is used only for Kotlin

Returns:

a map of interface name to a list of fields

getFieldNamesWithResolvers

public Set<String> getFieldNamesWithResolvers()

Get names of all the fields that require separate resolver class. This includes fields from type definitions and interface definitions.

Returns:

a flat set of all field names that require resolver.

builder

public static MappingContext.Builder builder()