# ProjectDescriptor

interface ProjectDescriptor(source)

A `ProjectDescriptor` declares the configuration required to create and evaluate a org.gradle.api.Project.

A `ProjectDescriptor` is created when you add a project to the build from the settings script, using include. You can access the descriptors using one of the lookup methods on the Settings object.

## Functions

getBuildFile
Link copied to clipboard
abstract fun getBuildFile(): File
Returns the build file for this project.
getBuildFileName
Link copied to clipboard
abstract fun getBuildFileName(): String
Returns the name of the build file for this project.
getChildren
Link copied to clipboard
abstract fun getChildren(): Set<ProjectDescriptor>
Returns the children of this project, if any.
getName
Link copied to clipboard
abstract fun getName(): String
Returns the name of this project.
getParent
Link copied to clipboard
@Nullable
abstract fun getParent(): @Nullable ProjectDescriptor
Returns the parent of this project, if any.
getPath
Link copied to clipboard
abstract fun getPath(): String
Returns the path of this project.
getProjectDir
Link copied to clipboard
abstract fun getProjectDir(): File
Returns the project directory of this project.
setBuildFileName
Link copied to clipboard
abstract fun setBuildFileName(name: String)
Sets the name of the build file.
setName
Link copied to clipboard
abstract fun setName(name: String)
Sets the name of this project.
setProjectDir
Link copied to clipboard
abstract fun setProjectDir(dir: File)
Sets the project directory of this project.