Package org.gradle.tooling.model.gradle
Interface BasicGradleProject
- All Superinterfaces:
Model,ProjectModel
Provides some basic details about a Gradle project.
- Since:
- 1.8
-
Method Summary
Modifier and TypeMethodDescriptionReturns a path to the project for the full build treeDomainObjectSet<? extends BasicGradleProject> Returns the child projects of this project, or the empty set if there are no child projects.getName()Returns the name of this project.@Nullable BasicGradleProjectReturns the parent of this project, ornullif this is the root project.getPath()Returns the path of this project.Returns the project directory for this project.Returns the identifier for this Gradle project.
-
Method Details
-
getProjectIdentifier
ProjectIdentifier getProjectIdentifier()Returns the identifier for this Gradle project.- Specified by:
getProjectIdentifierin interfaceProjectModel- Since:
- 2.13
-
getName
String getName()Returns the name of this project. Note that the name is not a unique identifier for the project.- Returns:
- The name of this project.
-
getPath
String getPath()Returns the path of this project. The path can be used as a unique identifier for the project within a given build.- Returns:
- The path of this project.
-
getProjectDirectory
File getProjectDirectory()Returns the project directory for this project.- Returns:
- The project directory.
-
getParent
@Nullable BasicGradleProject getParent()Returns the parent of this project, ornullif this is the root project.- Returns:
- The parent of this project, or
nullif this is the root project.
-
getChildren
DomainObjectSet<? extends BasicGradleProject> getChildren()Returns the child projects of this project, or the empty set if there are no child projects.- Returns:
- The child projects of this project, or the empty set if there are no child projects.
-
getBuildTreePath
Returns a path to the project for the full build tree- Returns:
- a path to the project for the full build tree
- Throws:
UnsupportedMethodException- When the target Gradle version does not support this method.- Since:
- 8.2
-