Package com.arc_e_tect.gradle.apionly.transcriberj

Class GenerateContractSourcesTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
com.arc_e_tect.gradle.apionly.transcriberj.ContractSourcesTask
com.arc_e_tect.gradle.apionly.transcriberj.GenerateContractSourcesTask
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>
@CacheableTask public abstract class GenerateContractSourcesTask extends ContractSourcesTask
Generates the core of one contract's class tree: the schema classes, the operations and the invalid-request cases, and the endpoint index. Each emitter's output is generated by a task of its own, GenerateEmitterSourcesTask, so that changing one emitter regenerates only that emitter.

It writes its part of the report as fragments, which ReportContractSourcesTask merges with the emitters' into the one report of the subscription.

  • 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
    GenerateContractSourcesTask()
    Creates the task.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    generate()
    Generates the core.
    abstract org.gradle.api.file.RegularFileProperty
    getAsciiDocFragment()
    Where the core's part of the report goes, as AsciiDoc.
    abstract org.gradle.api.file.RegularFileProperty
    getEndpointIndex()
    Where the endpoint index goes.
    abstract org.gradle.api.file.DirectoryProperty
    getOutputDirectory()
    Where the core's sources go.
    abstract org.gradle.api.file.RegularFileProperty
    getReportFragment()
    Where the core's part of the report goes, as JSON.
    abstract org.gradle.api.file.DirectoryProperty
    getResourceDirectory()
    Where the core's resources go.
    abstract org.gradle.api.file.RegularFileProperty
    getValidValuesReport()
    Where the machine-readable report of every generated valid value goes; nothing is written when it is not set.
    protected abstract org.gradle.workers.WorkerExecutor
    getWorkerExecutor()
    Gradle's worker executor.

    Methods inherited from class com.arc_e_tect.gradle.apionly.transcriberj.ContractSourcesTask

    getAsyncContract, getBasePackage, getContract, getContractName, getDerive, getDescriptionBundle, getDescriptionPlaceholder, getGenerateDocs, getInvalidRequestStatus, getLockfile, getRecursionDepth, getStrictRequests, getValidateFormats

    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 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

    • GenerateContractSourcesTask

      public GenerateContractSourcesTask()
      Creates the task.

  • Method Details

    • getOutputDirectory

      @OutputDirectory public abstract org.gradle.api.file.DirectoryProperty getOutputDirectory()
      Where the core's sources go.
      Returns:
      the directory

    • getResourceDirectory

      @OutputDirectory public abstract org.gradle.api.file.DirectoryProperty getResourceDirectory()
      Where the core's resources go.
      Returns:
      the directory

    • getEndpointIndex

      @OutputFile public abstract org.gradle.api.file.RegularFileProperty getEndpointIndex()
      Where the endpoint index goes.
      Returns:
      the index

    • getReportFragment

      @OutputFile public abstract org.gradle.api.file.RegularFileProperty getReportFragment()
      Where the core's part of the report goes, as JSON.
      Returns:
      the fragment

    • getAsciiDocFragment

      @OutputFile public abstract org.gradle.api.file.RegularFileProperty getAsciiDocFragment()
      Where the core's part of the report goes, as AsciiDoc.
      Returns:
      the fragment

    • getValidValuesReport

      @OutputFile @Optional public abstract org.gradle.api.file.RegularFileProperty getValidValuesReport()
      Where the machine-readable report of every generated valid value goes; nothing is written when it is not set.
      Returns:
      the report

    • getWorkerExecutor

      @Inject protected abstract org.gradle.workers.WorkerExecutor getWorkerExecutor()
      Gradle's worker executor.
      Returns:
      the executor

    • generate

      public void generate()
      Generates the core.