Package com.graphql_java_generator.gradleplugin

Class GenerateCodeCommonExtension

java.lang.Object
com.graphql_java_generator.gradleplugin.CommonExtension
com.graphql_java_generator.gradleplugin.GenerateCodeCommonExtension
All Implemented Interfaces:
com.graphql_java_generator.plugin.conf.CommonConfiguration, com.graphql_java_generator.plugin.conf.GenerateCodeCommonConfiguration
Direct Known Subclasses:
GenerateClientCodeExtension, GenerateServerCodeExtension
public class GenerateCodeCommonExtension extends CommonExtension 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.

  • 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.0RC) If false, it uses jakarta EE8 imports (that begins by javax.). If true, it uses jakarta EE8 imports (that begins by jakarta.).

  • Constructor Details

    • GenerateCodeCommonExtension

      public GenerateCodeCommonExtension(org.gradle.api.file.ProjectLayout projectLayout)

  • Method Details

    • isCopyRuntimeSources

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

    • setCopyRuntimeSources

      public final void setCopyRuntimeSources(boolean copyRuntimeSources)

    • getCustomScalars

      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

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

    • getPackageName

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

    • setPackageName

      public final void setPackageName(String packageName)

    • getQueryMutationExecutionProtocol

      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)

    • isSeparateUtilityClasses

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

    • setSeparateUtilityClasses

      public final void setSeparateUtilityClasses(boolean separateUtilityClasses)

    • getSourceEncoding

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

    • getSpringBeanSuffix

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

    • setSpringBeanSuffix

      public final void setSpringBeanSuffix(String springBeanSuffix)

    • setSourceEncoding

      public final void setSourceEncoding(String sourceEncoding)

    • getTargetClassFolder

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

    • getTargetResourceFolder

      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

      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

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

    • setUseJakartaEE9

      public final void setUseJakartaEE9(boolean useJakartaEE9)

    • getSchemaPersonalizationFile

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

    • setSchemaPersonalizationFile

      public void setSchemaPersonalizationFile(String schemaPersonalizationFile)