Class GenerateFromJsonSchemaSourcesTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
io.micronaut.jsonschema.gradle.AbstractGenerateFromJsonSchemaSourcesTask
io.micronaut.jsonschema.gradle.GenerateFromJsonSchemaSourcesTask
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>
@DisableCachingByDefault(because="Schema discovery reads live provider metadata such as database state.") public abstract class GenerateFromJsonSchemaSourcesTask extends AbstractGenerateFromJsonSchemaSourcesTask
Opt-in task that discovers JSON Schemas from configured sources and generates Java records.
Since:
2.2.0

  • 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
    GenerateFromJsonSchemaSourcesTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    execute()
    Execute the pipeline.
    void
    generate()
    Execute the pipeline.
    Path
    getGeneratedSourcesDirectory()
     
    abstract org.gradle.api.file.ConfigurableFileCollection
    getJdbcClasspath()
     
    abstract org.gradle.api.file.ConfigurableFileCollection
    getProviderClasspath()
     

    Methods inherited from class AbstractGenerateFromJsonSchemaSourcesTask

    getFailOnMissingSource, getJdbcUrl, getLanguage, getLanguageLevel, getOutputDir, getPassword, getSchemaCacheDir, getSkipOnError, getSources, getTargetPackage, getUsername

    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, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, setImpliesSubProjects

    Methods inherited from class Object

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Constructor Details

    • GenerateFromJsonSchemaSourcesTask

      public GenerateFromJsonSchemaSourcesTask()

  • Method Details

    • getJdbcClasspath

      @Classpath public abstract org.gradle.api.file.ConfigurableFileCollection getJdbcClasspath()
      Returns:
      The optional JDBC driver classpath.

    • getProviderClasspath

      @Classpath public abstract org.gradle.api.file.ConfigurableFileCollection getProviderClasspath()
      Returns:
      The optional provider classpath.

    • execute

      public void execute()
      Execute the pipeline.

    • generate

      public void generate() throws Exception
      Execute the pipeline.
      Throws:
      Exception - If execution fails

    • getGeneratedSourcesDirectory

      @Internal public Path getGeneratedSourcesDirectory()
      Returns:
      The output directory as a path for source-set registration.