-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
GradleBuild.java
76 lines (69 loc) · 2.84 KB
/
GradleBuild.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
/*
* Copyright 2013 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.tooling.model.gradle;
import org.gradle.tooling.model.BuildIdentifier;
import org.gradle.tooling.model.BuildModel;
import org.gradle.tooling.model.DomainObjectSet;
import org.gradle.tooling.model.Model;
/**
* Provides information about the structure of a Gradle build.
*
* @since 1.8
*/
public interface GradleBuild extends Model, BuildModel {
/**
* Returns the identifier for this Gradle build.
*
* @since 2.13
*/
@Override
BuildIdentifier getBuildIdentifier();
/**
* Returns the root project for this build.
*
* @return The root project
*/
BasicGradleProject getRootProject();
/**
* Returns the set of all projects for this build.
*
* @return The set of all projects.
*/
DomainObjectSet<? extends BasicGradleProject> getProjects();
/**
* Returns the included builds that were referenced by this build. This is the set of builds that were directly included by this build via its {@link org.gradle.api.initialization.Settings} instance.
*
* <p>Note that this set does not include builds that are added in other ways, such as a `buildSrc` build.
* Also note that a build may be included by multiple builds, so that the inclusions form a graph of builds rather than a tree of builds. There may be cycles in this graph.</p>
*
* <p>In general, it is better to use {@link #getEditableBuilds()} instead of this method.</p>
*
* @since 3.3
*/
DomainObjectSet<? extends GradleBuild> getIncludedBuilds();
/**
* Returns all builds contained in this build that should be imported into an IDE.
*
* <p>This is not always the same the builds returned by {@link #getIncludedBuilds()}. For the root build, the set of importable builds contains all builds that participate in the composite build,
* including those directly included by the root build plus all builds included transitively. For Gradle 7.2 and later, this set also includes any `buildSrc` builds that may be present.
* For all other builds, this set is empty.</p>
*
* <p>Note that this set does not include the root build itself.</p>
*
* @since 4.10
*/
DomainObjectSet<? extends GradleBuild> getEditableBuilds();
}