Interface ProjectLayout
An instance of this type can be injected into a task, plugin or other object by annotating a public constructor or method with javax.inject.Inject. It is also available via Project.getLayout().
 
Note: This interface is not intended for implementation by build script or plugin authors.
- Since:
- 4.1
- 
Method SummaryModifier and TypeMethodDescriptionCreates aRegularFileprovider whose location is calculated from the givenProvider.Creates a read-onlyFileCollectioncontaining the given files, as defined byProject.files(Object...).Returns the build directory for the project.Returns the project directory.Returns the settings directory.
- 
Method Details- 
getProjectDirectoryDirectory getProjectDirectory()Returns the project directory.
- 
getBuildDirectoryDirectoryProperty getBuildDirectory()Returns the build directory for the project.
- 
getSettingsDirectoryReturns the settings directory.The settings directory is the directory containing the settings file. It is shared by all projects in the build. - Since:
- 8.13
 
- 
fileCreates aRegularFileprovider whose location is calculated from the givenProvider.File system locations based on relative paths will be resolved against this layout's reference location, as defined by getProjectDirectory().
- 
dirCreates aDirectoryprovider whose location is calculated from the givenProvider.File system locations based on relative paths will be resolved against this layout's reference location, as defined by getProjectDirectory().- Since:
- 6.0
 
- 
filesCreates a read-only FileCollectioncontaining the given files, as defined byProject.files(Object...).This method can also be used to create an empty collection, but the collection may not be mutated later. - Parameters:
- paths- The paths to the files. May be empty.
- Returns:
- The file collection. Never returns null.
- Since:
- 4.8
 
 
-