Package org.gradle.api.initialization
Interface ProjectDescriptor
public interface ProjectDescriptor
A ProjectDescriptor declares the configuration required to create and evaluate a Project.
 A ProjectDescriptor is created when you add a project to the build from the settings script, using Settings.include(String...). You can access the descriptors using one of
 the lookup methods on the Settings object.
- 
Method SummaryModifier and TypeMethodDescriptionReturns the build file for this project.Returns the name of the build file for this project.Returns the children of this project, if any.getName()Returns the name of this project.Returns the parent of this project, if any.getPath()Returns the path of this project.Returns the project directory of this project.voidsetBuildFileName(String name) Sets the name of the build file.voidSets the name of this project.voidsetProjectDir(File dir) Sets the project directory of this project.
- 
Method Details- 
getNameString getName()Returns the name of this project.- Returns:
- The name of the project. Never returns null.
 
- 
setNameSets the name of this project.- Parameters:
- name- The new name for the project. Should not be null
 
- 
getProjectDirFile getProjectDir()Returns the project directory of this project.- Returns:
- The project directory. Never returns null.
 
- 
setProjectDirSets the project directory of this project.- Parameters:
- dir- The new project directory. Should not be null.
 
- 
getBuildFileNameString getBuildFileName()Returns the name of the build file for this project. This name is interpreted relative to the project directory.- Returns:
- The build file name.
 
- 
setBuildFileNameSets the name of the build file. This name is interpreted relative to the project directory.- Parameters:
- name- The build file name. Should not be null.
 
- 
getBuildFileFile getBuildFile()Returns the build file for this project.- Returns:
- The build file. Never returns null.
 
- 
getParentReturns the parent of this project, if any. Returns null if this project is the root project.- Returns:
- The parent, or null if this is the root project.
 
- 
getChildrenSet<ProjectDescriptor> getChildren()Returns the children of this project, if any.- Returns:
- The children. Returns an empty set if this project does not have any children.
 
- 
getPathString getPath()Returns the path of this project. The path can be used as a unique identifier for this project.- Returns:
- The path. Never returns null.
 
 
-