Package net.ltgt.gradle.jooq.tasks

Class JooqCodegen

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
net.ltgt.gradle.jooq.tasks.JooqCodegen
All Implemented Interfaces:
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>
@UntrackedTask(because="Depends on the database") public abstract class JooqCodegen extends org.gradle.api.DefaultTask

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Named

    org.gradle.api.Named.Namer

  • Field Summary

    Fields inherited from interface org.gradle.api.Task

    TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

  • Constructor Summary

    Constructors
    Constructor
    Description
    JooqCodegen()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.file.ConfigurableFileCollection
    getClasspath()
    The classpath for executing the jOOQ code generator.
    abstract org.gradle.api.file.RegularFileProperty
    getConfigurationFile()
    The jOOQ code generation configuration file.
    abstract org.gradle.api.provider.Property<String>
    getEncoding()
    The encoding of the generated files.
    protected abstract org.gradle.api.file.FileSystemOperations
    getFileSystemOperations()
     
    abstract org.gradle.api.provider.Property<org.gradle.jvm.toolchain.JavaLauncher>
    getJavaLauncher()
    Configures the java executable to be used to run the jOOQ code generator.
    abstract org.gradle.api.file.DirectoryProperty
    getOutputDirectory()
    The directory where jOOQ will generate the code.
    abstract org.gradle.api.provider.Property<String>
    getPassword()
    The password to use to connect to the database.
    abstract org.gradle.api.provider.Property<String>
    getUrl()
    The jdbc url to use to connect to the database.
    abstract org.gradle.api.provider.Property<String>
    getUser()
    The user to use to connect to the database.
    protected abstract org.gradle.workers.WorkerExecutor
    getWorkerExecutor()
     

    Methods inherited from class org.gradle.api.DefaultTask

    compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

    Methods inherited from class org.gradle.api.internal.AbstractTask

    acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Constructor Details

    • JooqCodegen

      public JooqCodegen()

  • Method Details

    • getWorkerExecutor

      @Inject protected abstract org.gradle.workers.WorkerExecutor getWorkerExecutor()

    • getFileSystemOperations

      @Inject protected abstract org.gradle.api.file.FileSystemOperations getFileSystemOperations()

    • getClasspath

      @Classpath public abstract org.gradle.api.file.ConfigurableFileCollection getClasspath()
      The classpath for executing the jOOQ code generator.

      Defaults to the jooqCodegenClasspath configuration, itself extending the jooqCodegen configuration.

    • getUrl

      @Input public abstract org.gradle.api.provider.Property<String> getUrl()
      The jdbc url to use to connect to the database.

      This will override any jdbc.url set in the configuration file.

    • getUser

      @Input @Optional public abstract org.gradle.api.provider.Property<String> getUser()
      The user to use to connect to the database.

      This will override any jdbc.user set in the configuration file.

    • getPassword

      @Input @Optional public abstract org.gradle.api.provider.Property<String> getPassword()
      The password to use to connect to the database.

      This will override any jdbc.password set in the configuration file.

    • getEncoding

      @Input @Optional public abstract org.gradle.api.provider.Property<String> getEncoding()
      The encoding of the generated files.

      This will override any generator.target.encoding set in the configuration file.

      When the java plugin is applied, it defaults to the compileJava task's options.encoding.

      When the kotlin("jvm") plugin is applied, it defaults to UTF-8.

      If not configured, it will default to jOOQ's default encoding, which is UTF-8.

    • getConfigurationFile

      @InputFile @PathSensitive(NONE) public abstract org.gradle.api.file.RegularFileProperty getConfigurationFile()
      The jOOQ code generation configuration file.

      When the java plugin is applied, it defaults to src/jooq-codegen.xml.

    • getOutputDirectory

      @OutputDirectory public abstract org.gradle.api.file.DirectoryProperty getOutputDirectory()
      The directory where jOOQ will generate the code.

      This will override any generator.target.directory set in the configuration file.

      When the java plugin is applied, it defaults to src/main/jooq.

    • getJavaLauncher

      @Optional public abstract org.gradle.api.provider.Property<org.gradle.jvm.toolchain.JavaLauncher> getJavaLauncher()
      Configures the java executable to be used to run the jOOQ code generator.

      If it is the same as the one used to run Gradle, then the jOOQ code generator will run in-process.

      When the java-base plugin is applied, it defaults to using the toolchain configured at the project level.