Package com.graphql_java_generator.gradleplugin

Class GenerateCodeCommonTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
com.graphql_java_generator.gradleplugin.CommonTask
com.graphql_java_generator.gradleplugin.GenerateCodeCommonTask
All Implemented Interfaces:
com.graphql_java_generator.plugin.conf.CommonConfiguration, com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration, Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
Direct Known Subclasses:
GenerateClientCodeTask, GenerateServerCodeTask
public class GenerateCodeCommonTask extends CommonTask implements com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

This class is the super class of all Gradle Extensions that generate code, that is the GenerateClientCodeExtension, the GenerateServerCodeExtension and the GraphQLExtension extensions. It contains all parameters that are common to these tasks. The parameters common to all tasks are inherited from the CommonExtension class.

This avoids to redeclare each common parameter in each task, including its comment. When a comment is updated, only one update is necessary, instead of updating it in each.

Note: The attribute have no default values: their default values is read from the GenerateCodeCommonExtension, whose attributes can be either the default value, or a value set in the build script.

  • Field Details

    • targetResourceFolder

      protected File targetResourceFolder
      The folder where the generated resources will be generated

    • targetSourceFolder

      protected File targetSourceFolder
      The folder where the source code for the generated classes will be generated

    • useJakartaEE9

      protected Boolean useJakartaEE9

      (since 2.0RC1) If false, it uses jakarta EE8 imports (that begins by javax.). If true, it uses jakarta EE8 imports (that begins by jakarta.).

      (since 3.0) The parameter is ignored. Its value is always true.

  • Constructor Details

    • GenerateCodeCommonTask

      @Inject public GenerateCodeCommonTask(GenerateCodeCommonExtension extension, org.gradle.api.file.ProjectLayout projectLayout)

  • Method Details

    • isCopyRuntimeSources

      @Input public final boolean isCopyRuntimeSources()
      Specified by:
      isCopyRuntimeSources in interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

    • isGenerateUtilityClasses

      @Internal public boolean isGenerateUtilityClasses()
      Specified by:
      isGenerateUtilityClasses in interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

    • setCopyRuntimeSources

      public final void setCopyRuntimeSources(boolean copyRuntimeSources)

    • getCustomScalars

      @Input public final List<com.graphql_java_generator.plugin.conf.CustomScalarDefinition> getCustomScalars()
      Specified by:
      getCustomScalars in interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

    • setCustomScalars

      public final void setCustomScalars(com.graphql_java_generator.plugin.conf.CustomScalarDefinition[] customScalars)

    • getMode

      @Input @Optional public com.graphql_java_generator.plugin.conf.PluginMode getMode()
      Specified by:
      getMode in interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

    • getPackageName

      @Input public final String getPackageName()
      Specified by:
      getPackageName in interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

    • setPackageName

      public final void setPackageName(String packageName)

    • getQueryMutationExecutionProtocol

      @Input public final com.graphql_java_generator.plugin.conf.QueryMutationExecutionProtocol getQueryMutationExecutionProtocol()
      Specified by:
      getQueryMutationExecutionProtocol in interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

    • setQueryMutationExecutionProtocol

      public final void setQueryMutationExecutionProtocol(com.graphql_java_generator.plugin.conf.QueryMutationExecutionProtocol queryMutationExecutionProtocol)

    • getSchemaPersonalizationFile

      @InputFile @Optional public final File getSchemaPersonalizationFile()
      Specified by:
      getSchemaPersonalizationFile in interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

    • setSchemaPersonalizationFile

      public final void setSchemaPersonalizationFile(String schemaPersonalizationFile)

    • isSeparateUtilityClasses

      @Input public boolean isSeparateUtilityClasses()
      Specified by:
      isSeparateUtilityClasses in interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

    • setSeparateUtilityClasses

      public final void setSeparateUtilityClasses(boolean separateUtilityClasses)

    • getSourceEncoding

      @Input public final String getSourceEncoding()
      Specified by:
      getSourceEncoding in interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

    • setSourceEncoding

      public final void setSourceEncoding(String sourceEncoding)

    • getSpringAutoConfigurationPackage

      @Internal public String getSpringAutoConfigurationPackage()
      Specified by:
      getSpringAutoConfigurationPackage in interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

    • getSpringBeanSuffix

      @Input public final String getSpringBeanSuffix()
      Specified by:
      getSpringBeanSuffix in interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

    • setSpringBeanSuffix

      public final void setSpringBeanSuffix(String springBeanSuffix)

    • getTargetClassFolder

      @OutputDirectory public final File getTargetClassFolder()
      Specified by:
      getTargetClassFolder in interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

    • getTargetResourceFolder

      @OutputDirectory public final File getTargetResourceFolder()
      Specified by:
      getTargetResourceFolder in interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

    • setTargetResourceFolder

      public final void setTargetResourceFolder(String targetResourceFolder)
      Parameters:
      targetResourceFolder - A folder, relative to the project dir (not the the build dir)

    • getTargetSourceFolder

      @OutputDirectory public final File getTargetSourceFolder()
      Specified by:
      getTargetSourceFolder in interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

    • setTargetSourceFolder

      public final void setTargetSourceFolder(String targetSourceFolder)
      Parameters:
      targetSourceFolder - A folder, relative to the project dir (not the the build dir)

    • isUseJakartaEE9

      @Input public boolean isUseJakartaEE9()
      Specified by:
      isUseJakartaEE9 in interface com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration

    • setUseJakartaEE9

      public final void setUseJakartaEE9(boolean useJakartaEE9)

    • getExtension

      protected GenerateCodeCommonExtension getExtension()
      Overrides:
      getExtension in class CommonTask

    • isGenerateJacksonAnnotations

      @Internal public boolean isGenerateJacksonAnnotations()
      Specified by:
      isGenerateJacksonAnnotations in interface com.graphql_java_generator.plugin.conf.CommonConfiguration
      Overrides:
      isGenerateJacksonAnnotations in class CommonTask