-
Notifications
You must be signed in to change notification settings - Fork 4.5k
/
InputArtifact.java
62 lines (58 loc) · 2.11 KB
/
InputArtifact.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
/*
* Copyright 2018 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.api.file.FileSystemLocation;
import org.gradle.api.provider.Provider;
import org.gradle.api.reflect.InjectionPointQualifier;
import java.io.File;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Attached to a property that should receive the <em>input artifact</em> for an artifact transform.
* This is the artifact that the transform is applied to.
*
* <p>The input artifact can be injected as a {@link Provider}<{@link org.gradle.api.file.FileSystemLocation}>.</p>
*
* <p>Example usage:</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();
* // Do something with the input
* }
* }
* </pre>
*
* @since 5.3
*/
@Incubating
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
@InjectionPointQualifier(supportedTypes = { File.class }, supportedProviderTypes = { FileSystemLocation.class })
public @interface InputArtifact {
}