Package com.arc_e_tect.gradle.apionly.transcriberj

Class ReportContractSourcesTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
com.arc_e_tect.gradle.apionly.transcriberj.ReportContractSourcesTask
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 ReportContractSourcesTask extends org.gradle.api.DefaultTask
Writes the one report of a subscription from the fragments its generation tasks wrote: the text report, as one generation of the core and every emitter would have written it, and an AsciiDoc report, a frame that summarises it and includes each task's AsciiDoc fragment.

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

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.file.ConfigurableFileCollection
    getAsciiDocFragments()
    The AsciiDoc fragments, the core's first, then each emitter's, which the AsciiDoc report includes.
    abstract org.gradle.api.file.RegularFileProperty
    getAsciiDocReport()
    Where the AsciiDoc report goes.
    abstract org.gradle.api.provider.Property<String>
    getContractName()
    The contract's name.
    abstract org.gradle.api.file.RegularFileProperty
    getCoreFragment()
    The core's part of the report, as JSON.
    abstract org.gradle.api.file.ConfigurableFileCollection
    getEmitterFragments()
    Each emitter's part of the report, as JSON, in emitter order.
    abstract org.gradle.api.file.RegularFileProperty
    getLockfile()
    The Subscriber's lockfile, for the version the report names.
    abstract org.gradle.api.file.RegularFileProperty
    getReportFile()
    Where the text report goes.
    void
    report()
    Merges the fragments and writes the report.

    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

    • ReportContractSourcesTask

      public ReportContractSourcesTask()
      Creates the task.

  • Method Details

    • getContractName

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

    • getLockfile

      @InputFile @PathSensitive(NONE) public abstract org.gradle.api.file.RegularFileProperty getLockfile()
      The Subscriber's lockfile, for the version the report names.
      Returns:
      the lockfile

    • getCoreFragment

      @InputFile @PathSensitive(NONE) public abstract org.gradle.api.file.RegularFileProperty getCoreFragment()
      The core's part of the report, as JSON.
      Returns:
      the fragment

    • getEmitterFragments

      @InputFiles @PathSensitive(NONE) public abstract org.gradle.api.file.ConfigurableFileCollection getEmitterFragments()
      Each emitter's part of the report, as JSON, in emitter order.
      Returns:
      the fragments

    • getAsciiDocFragments

      @InputFiles @PathSensitive(RELATIVE) public abstract org.gradle.api.file.ConfigurableFileCollection getAsciiDocFragments()
      The AsciiDoc fragments, the core's first, then each emitter's, which the AsciiDoc report includes.
      Returns:
      the fragments

    • getReportFile

      @OutputFile public abstract org.gradle.api.file.RegularFileProperty getReportFile()
      Where the text report goes.
      Returns:
      the report

    • getAsciiDocReport

      @OutputFile public abstract org.gradle.api.file.RegularFileProperty getAsciiDocReport()
      Where the AsciiDoc report goes.
      Returns:
      the report

    • report

      public void report()
      Merges the fragments and writes the report.