Package com.arc_e_tect.gradle.apionly.transcriberj

Class ContractSourcesTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
com.arc_e_tect.gradle.apionly.transcriberj.ContractSourcesTask
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>
Direct Known Subclasses:
GenerateContractSourcesTask, GenerateEmitterSourcesTask
@DisableCachingByDefault(because="An abstract base; each generation task declares its own caching") public abstract class ContractSourcesTask extends org.gradle.api.DefaultTask
What every generation task of a contract derives its output from: the fetched documents, the lockfile and the subscription's settings. The core's task and each emitter's derive the same model from them, so each can run on its own.

The inputs are the documents' content and the lockfile, not only their paths: a new contract version regenerates the output however alike the two documents' files look.

  • 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
    Modifier
    Constructor
    Description
    protected
    ContractSourcesTask()
    Creates the task, with the invalid-request settings at their defaults.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.file.ConfigurableFileCollection
    getAsyncContract()
    The contract's AsyncAPI document, when it has one: empty otherwise.
    abstract org.gradle.api.provider.Property<String>
    getBasePackage()
    The package the core classes are generated into.
    abstract org.gradle.api.file.RegularFileProperty
    getContract()
    The fetched contract document.
    abstract org.gradle.api.provider.Property<String>
    getContractName()
    The contract's name.
    abstract org.gradle.api.provider.ListProperty<String>
    getDerive()
    The kinds of contract case derived.
    abstract org.gradle.api.provider.Property<String>
    getDescriptionBundle()
    The base name of the bundle descriptions resolve through, or absent when the project supplies none.
    abstract org.gradle.api.provider.Property<String>
    getDescriptionPlaceholder()
    The description of what the contract does not describe.
    abstract org.gradle.api.provider.Property<Boolean>
    getGenerateDocs()
    Whether descriptions come from the contract.
    abstract org.gradle.api.provider.Property<String>
    getInvalidRequestStatus()
    The status that means "the request is invalid".
    abstract org.gradle.api.file.RegularFileProperty
    getLockfile()
    The Subscriber's lockfile, which says which version was fetched.
    abstract org.gradle.api.provider.Property<Integer>
    getRecursionDepth()
    How many times a recursive reference is followed.
    abstract org.gradle.api.provider.Property<Boolean>
    getStrictRequests()
    Whether an undeclared additionalProperties forbids unknown members.
    abstract org.gradle.api.provider.ListProperty<String>
    getValidateFormats()
    The formats an invalid-request case is derived for.

    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

    • ContractSourcesTask

      protected ContractSourcesTask()
      Creates the task, with the invalid-request settings at their defaults.

  • Method Details

    • getContract

      @InputFile @PathSensitive(NONE) public abstract org.gradle.api.file.RegularFileProperty getContract()
      The fetched contract document.
      Returns:
      the document

    • getAsyncContract

      @InputFiles @PathSensitive(NONE) public abstract org.gradle.api.file.ConfigurableFileCollection getAsyncContract()
      The contract's AsyncAPI document, when it has one: empty otherwise.
      Returns:
      the document, or nothing

    • getDescriptionBundle

      @Input @Optional public abstract org.gradle.api.provider.Property<String> getDescriptionBundle()
      The base name of the bundle descriptions resolve through, or absent when the project supplies none.
      Returns:
      the bundle's base name

    • getLockfile

      @InputFile @PathSensitive(NONE) public abstract org.gradle.api.file.RegularFileProperty getLockfile()
      The Subscriber's lockfile, which says which version was fetched.
      Returns:
      the lockfile

    • getContractName

      @Input public abstract org.gradle.api.provider.Property<String> getContractName()
      The contract's name.
      Returns:
      the name

    • getBasePackage

      @Input @Optional public abstract org.gradle.api.provider.Property<String> getBasePackage()
      The package the core classes are generated into.
      Returns:
      the package

    • getRecursionDepth

      @Input public abstract org.gradle.api.provider.Property<Integer> getRecursionDepth()
      How many times a recursive reference is followed.
      Returns:
      the depth

    • getGenerateDocs

      @Input public abstract org.gradle.api.provider.Property<Boolean> getGenerateDocs()
      Whether descriptions come from the contract.
      Returns:
      the setting

    • getDescriptionPlaceholder

      @Input public abstract org.gradle.api.provider.Property<String> getDescriptionPlaceholder()
      The description of what the contract does not describe.
      Returns:
      the placeholder

    • getInvalidRequestStatus

      @Input public abstract org.gradle.api.provider.Property<String> getInvalidRequestStatus()
      The status that means "the request is invalid".
      Returns:
      the status

    • getStrictRequests

      @Input public abstract org.gradle.api.provider.Property<Boolean> getStrictRequests()
      Whether an undeclared additionalProperties forbids unknown members.
      Returns:
      the setting

    • getValidateFormats

      @Input public abstract org.gradle.api.provider.ListProperty<String> getValidateFormats()
      The formats an invalid-request case is derived for.
      Returns:
      the format names

    • getDerive

      @Input public abstract org.gradle.api.provider.ListProperty<String> getDerive()
      The kinds of contract case derived.
      Returns:
      the kinds, by their setting names