-
Notifications
You must be signed in to change notification settings - Fork 4.5k
/
InputArtifactDependencies.java
67 lines (63 loc) · 2.47 KB
/
InputArtifactDependencies.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
/*
* 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.api.file.FileCollection;
import org.gradle.api.reflect.InjectionPointQualifier;
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>artifact dependencies</em> of the {@link InputArtifact} of an artifact transform.
*
* <p>
* The order of the files match that of the dependencies in the source artifact view.
* The type of the injected dependencies is {@link org.gradle.api.file.FileCollection}.
* For example, when a project depends on {@code spring-web}, when the project is transformed (i.e. the project is the input artifact),
* the input artifact dependencies are the file collection containing the {@code spring-web} JAR and all its dependencies like e.g. the {@code spring-core} JAR.
* </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 @}InputArtifactDependencies
* public abstract FileCollection getDependencies();
*
* {@literal @}Override
* public void transform(TransformOutputs outputs) {
* FileCollection dependencies = getDependencies();
* // Do something with the dependencies
* }
* }
* </pre>
*
* @since 5.3
*/
@Incubating
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
@InjectionPointQualifier(supportedTypes = FileCollection.class)
public @interface InputArtifactDependencies {
}