-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
GradleProject.java
98 lines (85 loc) · 2.68 KB
/
GradleProject.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
/*
* Copyright 2011 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;
import org.gradle.tooling.model.gradle.GradleScript;
import javax.annotation.Nullable;
import java.io.File;
/**
* Represents a Gradle project.
*
* @since 1.0-milestone-5
*/
public interface GradleProject extends HierarchicalElement, BuildableElement, ProjectModel {
/**
* Returns the identifier for this Gradle project.
*
* @since 2.13
*/
@Override
ProjectIdentifier getProjectIdentifier();
/**
* {@inheritDoc}
*/
@Override
DomainObjectSet<? extends GradleTask> getTasks();
/**
* {@inheritDoc}
*/
@Override
GradleProject getParent();
/**
* {@inheritDoc}
*/
@Override
DomainObjectSet<? extends GradleProject> getChildren();
/**
* Returns the path of this project. This is a unique identifier for this project within the build.
*
* @return The path.
*/
String getPath();
/**
* Searches all descendants (children, grand-children, etc.), including self, by given path.
*
* @return Gradle project with matching path or {@code null} if not found.
*/
@Nullable
GradleProject findByPath(String path);
/**
* Returns the build script for this project.
*
* @return The build script.
* @since 1.8
* @throws UnsupportedMethodException For Gradle versions older than 1.8, where this method is not supported.
*/
GradleScript getBuildScript() throws UnsupportedMethodException;
/**
* Returns the build directory for this project.
*
* @return The build directory.
* @since 2.0
* @throws UnsupportedMethodException For Gradle versions older than 2.0, where this method is not supported.
*/
File getBuildDirectory() throws UnsupportedMethodException;
/**
* Returns the project directory for this project.
*
* @return The project directory.
* @since 2.4
* @throws UnsupportedMethodException For Gradle versions older than 2.4, where this method is not supported.
*/
File getProjectDirectory() throws UnsupportedMethodException;
}