Package com.graphql_java_generator.gradleplugin

Class GenerateServerCodeExtension

java.lang.Object

com.graphql_java_generator.gradleplugin.CommonExtension

com.graphql_java_generator.gradleplugin.GenerateCodeCommonExtension

com.graphql_java_generator.gradleplugin.GenerateServerCodeExtension

All Implemented Interfaces:

com.graphql_java_generator.plugin.conf.CommonConfiguration, com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration, com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

Direct Known Subclasses:

GraphQLExtension

public class GenerateServerCodeExtension
extends GenerateCodeCommonExtension
implements com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
String	javaTypeForIDType	The javaTypeForIDType is the java class that is used in the generated code for GraphQL fields that are of the GraphQL ID type.

Fields inherited from class com.graphql_java_generator.gradleplugin.GenerateCodeCommonExtension

targetResourceFolder, targetSourceFolder, useJakartaEE9

Fields inherited from class com.graphql_java_generator.gradleplugin.CommonExtension

project, skipGenerationIfSchemaHasNotChanged

Fields inherited from interface com.graphql_java_generator.plugin.conf.CommonConfiguration

DEFAULT_ADD_RELAY_CONNECTIONS, DEFAULT_MAX_TOKENS, DEFAULT_PACKAGE_NAME, DEFAULT_PREFIX, DEFAULT_SCHEMA_FILE_FOLDER, DEFAULT_SCHEMA_FILE_PATTERN, DEFAULT_SCHEMA_SUB_FOLDER, DEFAULT_SKIP_GENERATION_IF_SCHEMA_HAS_NOT_CHANGED, DEFAULT_SUFFIX

Fields inherited from interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

DEFAULT_COPY_RUNTIME_SOURCES, DEFAULT_QUERY_MUTATION_EXECUTION_PROTOCOL, DEFAULT_SCHEMA_PERSONALIZATION_FILE, DEFAULT_SEPARATE_UTIL_CLASSES, DEFAULT_SOURCE_ENCODING, DEFAULT_SPRING_BEAN_SUFFIX, DEFAULT_TARGET_RESOURCE_FOLDER, DEFAULT_TARGET_SOURCE_FOLDER, DEFAULT_USE_JAKARTA_EE9

Fields inherited from interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

DEFAULT_GENERATE_BATCH_LOADER_ENVIRONMENT, DEFAULT_GENERATE_DATA_LOADER_FOR_LISTS, DEFAULT_GENERATE_JPA_ANNOTATION, DEFAULT_JAVA_TYPE_FOR_ID_TYPE, DEFAULT_SCAN_BASE_PACKAGES

Constructor Summary

Constructors

Constructor	Description
GenerateServerCodeExtension(org.gradle.api.Project project)

Method Summary

Modifier and Type	Method	Description
String	getJavaTypeForIDType()
com.graphql_java_generator.plugin.conf.PluginMode	getMode()	The mode is forced to PluginMode.server
com.graphql_java_generator.plugin.conf.Packaging	getPackaging()
String	getQuotedScanBasePackages()
String	getScanBasePackages()
boolean	isGenerateBatchLoaderEnvironment()
boolean	isGenerateDataLoaderForLists()
boolean	isGenerateJPAAnnotation()
void	setGenerateBatchLoaderEnvironment(boolean generateBatchLoaderEnvironment)
final void	setGenerateDataLoaderForLists(boolean generateDataLoaderForLists)
void	setGenerateJPAAnnotation(boolean generateJPAAnnotation)
void	setJavaTypeForIDType(String javaTypeForIDType)
void	setScanBasePackages(String scanBasePackages)

Methods inherited from class com.graphql_java_generator.gradleplugin.GenerateCodeCommonExtension

getCustomScalars, getPackageName, getQueryMutationExecutionProtocol, getSchemaPersonalizationFile, getSourceEncoding, getSpringBeanSuffix, getTargetClassFolder, getTargetResourceFolder, getTargetSourceFolder, isCopyRuntimeSources, isSeparateUtilityClasses, isUseJakartaEE9, setCopyRuntimeSources, setCustomScalars, setPackageName, setQueryMutationExecutionProtocol, setSchemaPersonalizationFile, setSeparateUtilityClasses, setSourceEncoding, setSpringBeanSuffix, setTargetResourceFolder, setTargetSourceFolder, setUseJakartaEE9

Methods inherited from class com.graphql_java_generator.gradleplugin.CommonExtension

getEnumPrefix, getEnumSuffix, getInputPrefix, getInputSuffix, getInterfacePrefix, getInterfaceSuffix, getMaxTokens, getProjectDir, getSchemaFileFolder, getSchemaFilePattern, getTemplates, getTypePrefix, getTypeSuffix, getUnionPrefix, getUnionSuffix, isAddRelayConnections, isInitialized, isSkipGenerationIfSchemaHasNotChanged, logConfiguration, setAddRelayConnections, setEnumPrefix, setEnumSuffix, setInitialized, setInputPrefix, setInputSuffix, setInterfacePrefix, setInterfaceSuffix, setMaxTokens, setSchemaFileFolder, setSchemaFilePattern, setSkipGenerationIfSchemaHasNotChanged, setTemplates, setTypePrefix, setTypeSuffix, setUnionPrefix, setUnionSuffix

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.graphql_java_generator.plugin.conf.CommonConfiguration

getDefaultTargetSchemaFileName, getEnumPrefix, getEnumSuffix, getInputPrefix, getInputSuffix, getInterfacePrefix, getInterfaceSuffix, getMaxTokens, getProjectDir, getSchemaFileFolder, getSchemaFilePattern, getTargetSchemaSubFolder, getTemplates, getTypePrefix, getTypeSuffix, getUnionPrefix, getUnionSuffix, isAddRelayConnections, isSkipGenerationIfSchemaHasNotChanged, logCommonConfiguration

Methods inherited from interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

getCustomScalars, getPackageName, getQueryMutationExecutionProtocol, getSchemaPersonalizationFile, getSourceEncoding, getSpringAutoConfigurationPackage, getSpringBeanSuffix, getTargetClassFolder, getTargetResourceFolder, getTargetSourceFolder, isCopyRuntimeSources, isGenerateUtilityClasses, isSeparateUtilityClasses, isUseJakartaEE9, logGenerateCodeCommonConfiguration

Methods inherited from interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

isGenerateJacksonAnnotations, logConfiguration, logGenerateServerCodeConfiguration

Field Details

javaTypeForIDType

public String javaTypeForIDType

The javaTypeForIDType is the java class that is used in the generated code for GraphQL fields that are of the GraphQL ID type. The default value is java.util.UUID. Valid values are: java.lang.String, java.lang.Long and java.util.UUID.

This parameter is only valid for the server mode. When generating the client code, the ID is always generated as a String type, as recommended in the GraphQL doc.

In other words: when in server mode and javaTypeForIDType is not set, all GraphQL ID fields are UUID attributes in java. When in server mode and javaTypeForIDType is set to the X type, all GraphQL ID fields are X attributes in java.

Note: you can override this, by using the schema personalization capability. For more information, please have a look at the Schema Personalization doc page.

Constructor Details

GenerateServerCodeExtension

public GenerateServerCodeExtension(org.gradle.api.Project project)

Method Details

isGenerateBatchLoaderEnvironment

public boolean isGenerateBatchLoaderEnvironment()

Specified by:

isGenerateBatchLoaderEnvironment in interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

setGenerateBatchLoaderEnvironment

public void setGenerateBatchLoaderEnvironment(boolean generateBatchLoaderEnvironment)

isGenerateJPAAnnotation

public boolean isGenerateJPAAnnotation()

Specified by:

isGenerateJPAAnnotation in interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

setGenerateJPAAnnotation

public void setGenerateJPAAnnotation(boolean generateJPAAnnotation)

isGenerateDataLoaderForLists

public boolean isGenerateDataLoaderForLists()

Specified by:

isGenerateDataLoaderForLists in interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

setGenerateDataLoaderForLists

public final void setGenerateDataLoaderForLists(boolean generateDataLoaderForLists)

getJavaTypeForIDType

public String getJavaTypeForIDType()

Specified by:

getJavaTypeForIDType in interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

setJavaTypeForIDType

public void setJavaTypeForIDType(String javaTypeForIDType)

getMode

public com.graphql_java_generator.plugin.conf.PluginMode getMode()

The mode is forced to PluginMode.server

Specified by:

getMode in interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

Overrides:

getMode in class GenerateCodeCommonExtension

getPackaging

public com.graphql_java_generator.plugin.conf.Packaging getPackaging()

Specified by:

getPackaging in interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

getQuotedScanBasePackages

public String getQuotedScanBasePackages()

Specified by:

getQuotedScanBasePackages in interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

getScanBasePackages

public String getScanBasePackages()

Specified by:

getScanBasePackages in interface com.graphql_java_generator.plugin.conf.GenerateServerCodeConfiguration

setScanBasePackages

public void setScanBasePackages(String scanBasePackages)