# InAndOutDirectoryOperationRequest

[View Source](https://cs.android.com/search?q=file:com/android/build/api/artifact/OperationRequests.kt+class:com.android.build.api.artifact.InAndOutDirectoryOperationRequest) Added in 4.2.0


```
interface InAndOutDirectoryOperationRequest<TaskT : Task>
```

<br />

*** ** * ** ***

Operations performed by a `https://docs.gradle.org/current/javadoc/org/gradle/api/Task.html` with a single `https://docs.gradle.org/current/javadoc/org/gradle/api/file/Directory.html` output.

`https://docs.gradle.org/current/javadoc/org/gradle/api/Task.html` is consuming existing version of the target `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/SingleArtifact` and producing a new version.

## Summary

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `<ArtifactTypeT : https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/Artifact.Single<https://docs.gradle.org/current/javadoc/org/gradle/api/file/Directory.html> & https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/Artifact.Transformable> https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/InAndOutDirectoryOperationRequest#toTransform(com.android.build.api.artifact.Artifact.Single)( type: ArtifactTypeT )` Initiates a transform request to a single `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/Artifact.Transformable` artifact type. |
| `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/ArtifactTransformationRequest<TaskT>` | `<ArtifactTypeT : https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/Artifact.Single<https://docs.gradle.org/current/javadoc/org/gradle/api/file/Directory.html> & https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/Artifact.ContainsMany & https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/Artifact.Transformable> https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/InAndOutDirectoryOperationRequest#toTransformMany(com.android.build.api.artifact.Artifact.Single)( type: ArtifactTypeT )` Initiates a transform request to a single `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/Artifact.Transformable` artifact type that can contain more than one artifact. |

## Public functions

### toTransform

Added in 7.0.0

```
fun <ArtifactTypeT : Artifact.Single<Directory> & Artifact.Transformable> toTransform(
    type: ArtifactTypeT
): Unit
```

Initiates a transform request to a single `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/Artifact.Transformable` artifact type.

| Parameters |
|---|---|
| `type: ArtifactTypeT` | The `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/Artifact` identifying the artifact to transform. The `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/Artifact`'s `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/Artifact#kind()` must be `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/Artifact#DIRECTORY()` The artifact type must be `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/Artifact.Single` and `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/Artifact.Transformable`. Let's take a `https://docs.gradle.org/current/javadoc/org/gradle/api/Task.html` transforming an input `https://docs.gradle.org/current/javadoc/org/gradle/api/file/Directory.html` into an output: ``` abstract class MyTask: DefaultTask() { @get:InputFiles abstract val inputDir: DirectoryProperty @get:OutputDirectory abstract val outputDir: DirectoryProperty @TaskAction fun taskAction() { ... read inputFile and write outputFile ... } } ``` An ArtifactType defined as follows: ``` sealed class ArtifactType<T: FileSystemLocation>(val kind: ArtifactKind) { object SINGLE_DIR_ARTIFACT: ArtifactType<Directory>(DIRECTORY), Single, Transformable } ``` You can register a transform to the collection of `https://docs.gradle.org/current/javadoc/org/gradle/api/file/RegularFile.html`. ``` val taskProvider= projects.tasks.register(MyTask::class.java, "transformTask") artifacts.use(taskProvider) .wiredWithDirectories( MyTask::inputDir, MyTask::outputDir) .toTransform(ArtifactType.SINGLE_DIR_ARTIFACT) ``` |

### toTransformMany

Added in 8.4.0

```
fun <ArtifactTypeT : Artifact.Single<Directory> & Artifact.ContainsMany & Artifact.Transformable> toTransformMany(
    type: ArtifactTypeT
): ArtifactTransformationRequest<TaskT>
```

Initiates a transform request to a single `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/Artifact.Transformable` artifact type that can contain more than one artifact.

| Parameters |
|---|---|
| `type: ArtifactTypeT` | The `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/Artifact` of the `https://docs.gradle.org/current/javadoc/org/gradle/api/file/Directory.html` identifying the artifact to transform. |

| Returns |
|---|---|
| `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/ArtifactTransformationRequest<TaskT>` | `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/ArtifactTransformationRequest` that will allow processing of individual artifacts located in the input directory. The artifact type must be `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/Artifact.Single`, `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/Artifact.Transformable`, and `https://developer.android.com/reference/tools/gradle-api/9.6/com/android/build/api/artifact/Artifact.ContainsMany`. For example, let's take a `https://docs.gradle.org/current/javadoc/org/gradle/api/Task.html` to transform a list of `https://docs.gradle.org/current/javadoc/org/gradle/api/file/RegularFile.html` as inputs into a single output: ``` abstract class MyTask: DefaultTask() { @get:InputFiles abstract val inputFolder: DirectoryProperty @get:OutputFile abstract val outputFolder: DirectoryProperty @Internal abstract Property<ArtifactTransformationRequest<MyTask>> getTransformationRequest() @TaskAction fun taskAction() { transformationRequest.get().submit( ... submit a work item for each input file ... ) } } ``` - You then register the task as follows: ``` val taskProvider= projects.tasks.register(MyTask::class.java, "combineTask") val transformationRequest = artifacts.use(taskProvider) .wiredWithDirectories( MyTask::inputFolder, MyTask::outputFolder) .toTransformMany(SingleArtifact.APK) taskProvider.configure { task -> task.getTransformationRequest().set(transformationRequest) } ``` |