Package software.amazon.smithy.gradle.tasks

Class MergeSpiFilesTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
software.amazon.smithy.gradle.tasks.MergeSpiFilesTask
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="Merging a handful of SPI files is not worth caching") public abstract class MergeSpiFilesTask extends org.gradle.api.DefaultTask
Merges two Service Provider files into a new provider file.

The generated, merged provider file is written to build/generated-resources/ by default.

See Also:

  • 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
    MergeSpiFilesTask(org.gradle.api.file.ProjectLayout projectLayout)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.file.RegularFileProperty
    getExistingFile()
    Existing Service Provider file to merge with generated file.
    abstract org.gradle.api.file.RegularFileProperty
    getGeneratedFile()
    Generated Service Provider file to merge with existing file.
    abstract org.gradle.api.file.DirectoryProperty
    getMetaInfDir()
    Output Directory of the task.
    org.gradle.api.provider.Provider<File>
    getOutputDir()
     
    void
    mergeFiles()
     

    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

    • MergeSpiFilesTask

      @Inject public MergeSpiFilesTask(org.gradle.api.file.ProjectLayout projectLayout)

  • Method Details

    • getGeneratedFile

      @InputFile @PathSensitive(NAME_ONLY) public abstract org.gradle.api.file.RegularFileProperty getGeneratedFile()
      Generated Service Provider file to merge with existing file.

    • getExistingFile

      @InputFile @PathSensitive(NAME_ONLY) public abstract org.gradle.api.file.RegularFileProperty getExistingFile()
      Existing Service Provider file to merge with generated file.

    • getMetaInfDir

      @Internal public abstract org.gradle.api.file.DirectoryProperty getMetaInfDir()
      Output Directory of the task.

      Note: Marked as internal so that it is not checked for caching, although it can be used as an input property.

    • getOutputDir

      @OutputDirectory public org.gradle.api.provider.Provider<File> getOutputDir()

    • mergeFiles

      public void mergeFiles()