-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
ConfigurationVariantDetails.java
74 lines (69 loc) · 2.6 KB
/
ConfigurationVariantDetails.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
/*
* 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.component;
import org.gradle.api.artifacts.ConfigurationVariant;
import org.gradle.internal.HasInternalProtocol;
/**
* The details object used to determine what to do with a
* configuration variant when publishing.
* <p>
* This type also contains Maven specific information used to map the variant to a Maven POM file.
*
* @since 5.3
*/
@HasInternalProtocol
public interface ConfigurationVariantDetails {
/**
* The configuration variant
*/
ConfigurationVariant getConfigurationVariant();
/**
* Marks this configuration variant as being skipped when publishing.
*/
void skip();
/**
* Provides information about the optional status of this added configuration variant.
*
* <ul>
* <li>For the Maven world, this means that dependencies will be declared as {@code optional}.</li>
* <li>For the Ivy world, this means that configuration marked optional will not be extended by the {@code default} configuration.</li>
* </ul>
*/
void mapToOptional();
/**
* Provides information about how to publish to a Maven POM file. If
* nothing is said, Gradle will publish all dependencies from this
* configuration to the <i>compile</i> scope. It is preferable to give
* a mapping in order for consumers to get the right dependencies when
* asking for the API or the runtime of a component published as a POM
* file only.
*
* Note that Gradle will write Maven scopes in the following order:
*
* <ul>
* <li>compile dependencies</li>
* <li>runtime dependencies</li>
* <li>optional compile dependencies</li>
* <li>optional runtime dependencies</li>
* </ul>
*
* The mapping only applies to dependencies: dependency constraints will
* systematically be published as import scope.
* @param scope the Maven scope to use for dependencies found in this configuration variant
*
*/
void mapToMavenScope(String scope);
}