OutOperationRequest

Added in 4.2.0

interface OutOperationRequest<FileTypeT : FileSystemLocation>

Operations performed by a Task with a single RegularFile or Directory output.

Task is not consuming existing version of the target SingleArtifact.

Summary

Public functions
Unit
<ArtifactTypeT : Artifact.Multiple<FileTypeT> & Artifact.Appendable> toAppendTo(
    type: ArtifactTypeT
)

Initiates an append request to a Artifact.Multiple artifact type.
Unit
<ArtifactTypeT : Artifact.Single<FileTypeT> & Artifact.Replaceable> toCreate(
    type: ArtifactTypeT
)

Initiates a creation request for a single Artifact.Replaceable artifact type.
Unit
<ArtifactTypeT : Artifact.Single<FileTypeT>> toListenTo(
    type: ArtifactTypeT
)

Initiates a reactive request where the Task used in the Artifacts.use method will be executed once the final version of the type artifact has been produced.
OutOperationRequest<FileTypeT>

Sets the output file or directory name for the new artifact.

Public functions

toAppendTo

Added in 7.0.0
fun <ArtifactTypeT : Artifact.Multiple<FileTypeT> & Artifact.Appendable> toAppendTo(
    type: ArtifactTypeT
): Unit

Initiates an append request to a Artifact.Multiple artifact type.

Parameters
type: ArtifactTypeT

The Artifact of FileTypeT identifying the artifact to append to.

The artifact type must be Artifact.Multiple and Artifact.Appendable.

As an example, let's take a Task that outputs a org.gradle.api.file.RegularFile:

    abstract class MyTask: DefaultTask() {
         @get:OutputFile abstract val outputFile: RegularFileProperty

         @TaskAction fun taskAction() {
             ... outputFile.get().asFile.write( ... ) ...
         }
    }

and an ArtifactType defined as follows:

    sealed class ArtifactType<T: FileSystemLocation>(val kind: ArtifactKind) {
         object MULTIPLE_FILE_ARTIFACT:
                 ArtifactType<RegularFile>(FILE), Multiple, Appendable
    }

You can then register the above task as a Provider of org.gradle.api.file.RegularFile for that artifact type:

    val taskProvider= projects.tasks.register(MyTask::class.java, "appendTask")
    artifacts.use(taskProvider)
     .wiredWith(MyTask::outputFile)
     .toAppendTo(ArtifactType.MULTIPLE_FILE_ARTIFACT)

toCreate

Added in 7.0.0
fun <ArtifactTypeT : Artifact.Single<FileTypeT> & Artifact.Replaceable> toCreate(
    type: ArtifactTypeT
): Unit

Initiates a creation request for a single Artifact.Replaceable artifact type.

Parameters
type: ArtifactTypeT

The Artifact of FileTypeT identifying the artifact to replace.

The artifact type must be Artifact.Replaceable

A creation request does not care about the existing producer, since it replaces the existing producer. Therefore, the existing producer task will not execute (unless it produces other outputs). Please note that when such replace requests are made, the Task will replace initial AGP providers.

You cannot replace the Artifact.Multiple artifact type; therefore, you must instead combine it using the TaskBasedOperation.wiredWith API.

For example, let's take a Task that outputs a org.gradle.api.file.RegularFile:

    abstract class MyTask: DefaultTask() {
         @get:OutputFile abstract val outputFile: RegularFileProperty

         @TaskAction fun taskAction() {
             ... write outputFile ...
         }
    }

A SingleArtifact is defined as follows:

    sealed class ArtifactType<T: FileSystemLocation>(val kind: ArtifactKind) {
         object SINGLE_FILE_ARTIFACT:
                 ArtifactType<RegularFile>(FILE), Replaceable
    }

You can register a transform to the collection of org.gradle.api.file.RegularFile:

    val taskProvider= projects.tasks.register(MyTask::class.java, "replaceTask")
    artifacts.use(taskProvider)
     .wiredWith(MyTask::outputFile)
     .toCreate(ArtifactType.SINGLE_FILE_ARTIFACT)

toListenTo

Added in 8.3.1
fun <ArtifactTypeT : Artifact.Single<FileTypeT>> toListenTo(
    type: ArtifactTypeT
): Unit

Initiates a reactive request where the Task used in the Artifacts.use method will be executed once the final version of the type artifact has been produced.

The final version artifact will be injected in the Task.

Remember that an artifact is not always produced, for instance, an artifact related to minification will not be produced unless minification is turned on.

When an artifact is not produced in the current build flow, the Task will NOT be invoked.

For example, let's take a Task that wants to listen to the merged manifest file production :

        abstract class MyTask: DefaultTask() {
             @get:InputFile abstract val mergedManifestFile: RegularFileProperty

             @TaskAction fun taskAction() {
                 ... verify that manifest is correct ...
             }
        }

    You can register the Task that consumes the manifest file as a [org.gradle.api.file.RegularFile]:

    ```kotlin
        val taskProvider= projects.tasks.register(MyTask::class.java, "verifyManifestTask")
        artifacts.use(taskProvider)
         .wiredWith(MyTask::mergedManifestFile)
         .toListenTo(SingleArtifact.MERGED_MANIFEST)

Task will be registered as a finalizer task for the final producer of the type artifact using Gradle's Task.finalizedBy API.

Parameters
type: ArtifactTypeT

the Artifact.Single artifact identifier.

withName

Added in 8.4.0
fun withName(name: String): OutOperationRequest<FileTypeT>

Sets the output file or directory name for the new artifact.

This name will only be used when toAppendTo or toCreate is invoked. Although you can use this method on Directory, it will most likely not influence how the files contained in the resulting Directory are packaged in the APK or Bundle. This method is usually only useful for RegularFile

Some Artifact have a Artifact.name which cannot be changed. When invoking toAppendTo or toCreate after this method will throw an exception if trying to set such a file or directory name when the target's Artifact is not null.

Parameters
name: String

file or directory name
Returns
OutOperationRequest<FileTypeT>

itself