-
Notifications
You must be signed in to change notification settings - Fork 4.5k
/
TransformOutputs.java
135 lines (130 loc) · 5.25 KB
/
TransformOutputs.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/*
* Copyright 2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.api.artifacts.transform;
import org.gradle.api.Incubating;
import org.gradle.internal.HasInternalProtocol;
import java.io.File;
/**
* The outputs of the artifact transform.
*
* <p>
* The registered output {@link File}s will appear in the transformed variant in the order they were registered.
* </p>
*
* @since 5.3
*/
@Incubating
@HasInternalProtocol
public interface TransformOutputs {
/**
* Registers an output directory.
*
* <p>
* For an <strong>absolute path</strong>, the location is registered as an output directory of the {@link TransformAction}.
* The path is required to point to the {@link InputArtifact}, or point inside the input artifact if it is a directory.
* Example:
* </p>
* <pre class='autoTested'>
* import org.gradle.api.artifacts.transform.TransformParameters;
*
* public abstract class MyTransform implements TransformAction<TransformParameters.None> {
* {@literal @}InputArtifact
* public abstract Provider<FileSystemLocation> getInputArtifact();
* {@literal @}Override
* public void transform(TransformOutputs outputs) {
* outputs.dir(getInputArtifact().get().getAsFile());
* outputs.dir(new File(getInputArtifact().get().getAsFile(), "sub-dir"));
* }
* }
* </pre>
*
* <p>
* For a <strong>relative path</strong>, a location for the output directory is provided by Gradle, so that the {@link TransformAction} can produce its outputs at that location.
* The directory is created automatically when calling the method.
* Example:
* </p>
* <pre class='autoTested'>
* import org.gradle.api.artifacts.transform.TransformParameters;
*
* public abstract class MyTransform implements TransformAction<TransformParameters.None> {
* {@literal @}Override
* public void transform(TransformOutputs outputs) {
* File myOutput = outputs.dir("my-output");
* Files.write(myOutput.toPath().resolve("file.txt"), "Generated text");
* }
* }
* </pre>
*
* <p>
* <strong>Note:</strong> it is an error if the registered directory does not exist when the {@link TransformAction#transform(TransformOutputs)} method finishes.
* </p>
*
* @param path path of the output directory
* @return determined location of the output
*/
File dir(Object path);
/**
* Registers an output file.
*
* <p>
* For an absolute path, the location is registered as an output file of the {@link TransformAction}.
* The path is required to point to the {@link InputArtifact} or be inside it if the input artifact is a directory.
* Example:
* </p>
* <pre class='autoTested'>
* import org.gradle.api.artifacts.transform.TransformParameters;
*
* public abstract class MyTransform implements TransformAction<TransformParameters.None> {
* {@literal @}InputArtifact
* public abstract Provider<FileSystemLocation> getInputArtifact();
* {@literal @}Override
* public void transform(TransformOutputs outputs) {
* File input = getInputArtifact().get().getAsFile();
* if (input.isFile()) {
* outputs.file(input);
* } else {
* outputs.file(new File(input, "file-in-input-artifact.txt"));
* }
* }
* }
* </pre>
*
* <p>
* For a relative path, a location for the output file is provided by Gradle, so that the {@link TransformAction} can produce its outputs at that location.
* The parent directory of the provided location is created automatically when calling the method.
* Example:
* </p>
* <pre class='autoTested'>
* import org.gradle.api.artifacts.transform.TransformParameters;
*
* public abstract class MyTransform implements TransformAction<TransformParameters.None> {
* {@literal @}InputArtifact
* public abstract Provider<FileSystemLocation> getInputArtifact();
* {@literal @}Override
* public void transform(TransformOutputs outputs) {
* File myOutput = outputs.file("my-output.transformed");
* Files.write(myOutput.toPath(), "Generated text");
* }
* }
* </pre>
*
* <p>The registered file needs to exist when the {@link TransformAction#transform(TransformOutputs)} method finishes.</p>
*
* @param path path of the output file
* @return determined location of the output
*/
File file(Object path);
}