-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
RepositoryContentDescriptor.java
126 lines (114 loc) · 4.74 KB
/
RepositoryContentDescriptor.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
/*
* 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.repositories;
import org.gradle.api.Incubating;
import org.gradle.api.attributes.Attribute;
/**
* <p>Descriptor of a repository content, used to avoid reaching to
* an external repository when not needed.</p>
*
* <p>Excludes are applied after includes. This means that by default, everything is included and nothing excluded.
* If includes are added, then if the module doesn't match any of the includes, it's excluded. Then if it does, but
* it also matches one of the excludes, it's also excluded.</p>
*
* @since 5.1
*/
public interface RepositoryContentDescriptor extends InclusiveRepositoryContentDescriptor {
/**
* Declares that an entire group shouldn't be searched for in this repository.
*
* @param group the group name
*/
void excludeGroup(String group);
/**
* Declares that an entire group and its subgroups shouldn't be searched for in this repository.
*
* <p>
* A subgroup is a group that starts with the given prefix and has a dot immediately after the prefix.
* For example, if the prefix is {@code org.gradle}, then {@code org.gradle} is matched as a group,
* and {@code org.gradle.foo} and {@code org.gradle.foo.bar} are matched as subgroups. {@code org.gradlefoo}
* is not matched as a subgroup.
* </p>
*
* @param groupPrefix the group prefix to include
* @since 8.1
*/
@Incubating
void excludeGroupAndSubgroups(String groupPrefix);
/**
* Declares that an entire group shouldn't be searched for in this repository.
*
* @param groupRegex the group name regular expression
*/
void excludeGroupByRegex(String groupRegex);
/**
* Declares that an entire module shouldn't be searched for in this repository.
*
* @param group the group name
* @param moduleName the module name
*/
void excludeModule(String group, String moduleName);
/**
* Declares that an entire module shouldn't be searched for in this repository, using regular expressions.
*
* @param groupRegex the group name regular expression
* @param moduleNameRegex the module name regular expression
*/
void excludeModuleByRegex(String groupRegex, String moduleNameRegex);
/**
* Declares that a specific module version shouldn't be searched for in this repository.
* <p>
* The version notation for a regex will be matched against a single version and does not support range notations.
*
* @param group the group name
* @param moduleName the module name
* @param version the module version
*/
void excludeVersion(String group, String moduleName, String version);
/**
* Declares that a specific module version shouldn't be searched for in this repository, using regular expressions.
* <p>
* The version notation for a regex will be matched against a single version and does not support range notations.
*
* @param groupRegex the group name
* @param moduleNameRegex the module name
* @param versionRegex the module version
*/
void excludeVersionByRegex(String groupRegex, String moduleNameRegex, String versionRegex);
/**
* Declares that this repository should only be used for a specific
* set of configurations. Defaults to any configuration
*
* @param configurationNames the names of the configurations the repository will be used for
*/
void onlyForConfigurations(String... configurationNames);
/**
* Declares that this repository should not be used for a specific
* set of configurations. Defaults to any configuration
*
* @param configurationNames the names of the configurations the repository will not be used for
*/
void notForConfigurations(String... configurationNames);
/**
* Declares that this repository will only be searched if the consumer requires a
* specific attribute.
* @param attribute the attribute
* @param validValues the list of accepted values
* @param <T> the type of the attribute
*/
@SuppressWarnings("unchecked")
<T> void onlyForAttribute(Attribute<T> attribute, T... validValues);
}