-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
DependencyMetadata.java
104 lines (90 loc) · 2.91 KB
/
DependencyMetadata.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
/*
* Copyright 2017 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;
import org.gradle.api.Action;
import org.gradle.api.attributes.AttributeContainer;
import javax.annotation.Nullable;
/**
* Describes a metadata about a dependency - direct dependency or dependency constraint - declared in a resolved component's metadata.
*
* @param <SELF> type extending this interface
* @since 4.4
*/
public interface DependencyMetadata<SELF extends DependencyMetadata> {
/**
* Returns the group of the module that is targeted by this dependency or dependency constraint.
* The group allows the definition of modules of the same name in different organizations or contexts.
*/
String getGroup();
/**
* Returns the name of the module that is targeted by this dependency or dependency constraint.
*/
String getName();
/**
* Returns the version of the module that is targeted by this dependency or dependency constraint.
* which usually expresses what API level of the module you are compatible with.
*
* @since 4.5
*/
VersionConstraint getVersionConstraint();
/**
* Adjust the version constraints of the dependency or dependency constraint.
*
* @param configureAction modify version details
* @since 4.5
*/
SELF version(Action<? super MutableVersionConstraint> configureAction);
/**
* Returns the reason why this dependency should be selected.
*
* @return the reason, or null if no reason is found in metadata.
*
* @since 4.6
*/
@Nullable
String getReason();
/**
* Adjust the reason why this dependency should be selected.
*
* @param reason modified reason
*
* @since 4.6
*/
SELF because(String reason);
/**
* Returns the attributes of this dependency.
*
* @return the attributes of this dependency
*
* @since 4.8
*/
AttributeContainer getAttributes();
/**
* Adjust the attributes of this dependency
*
* @since 4.8
*/
SELF attributes(Action<? super AttributeContainer> configureAction);
/**
* The module identifier of the component. Returns the same information
* as {@link #getGroup()} and {@link #getName()}.
*
* @return the module identifier
*
* @since 4.9
*/
ModuleIdentifier getModule();
}