ProjectLayout

API 文档ProjectLayout

提供对项目几个重要位置的访问。

通过使用 javax.inject.Inject 标注公共构造函数或方法,可以将此类型的实例注入到任务、插件或其他对象中。它也可以通过 Project.getLayout() 获取。

注意:此接口不适用于构建脚本或插件作者实现。

属性

属性描述
buildDirectory

项目的构建目录。

projectDirectory

项目目录。

settingsDirectory
孵化中

设置目录。

方法

方法描述
dir(file)

创建一个 Directory 提供者,其位置由给定的 Provider 计算得出。

file(file)

创建一个 RegularFile 提供者,其位置由给定的 Provider 计算得出。

files(paths)

创建一个只读的 FileCollection,包含给定的文件,其定义方式与 Project.files(java.lang.Object[]) 相同。

脚本块

没有脚本块

属性详情

DirectoryProperty buildDirectory

项目的构建目录。

Directory projectDirectory (只读)

项目目录。

Directory settingsDirectory (只读)

注意:此属性为孵化中特性,可能在 Gradle 的未来版本中发生变化。

设置目录。

设置目录是包含设置文件的目录。它由构建中的所有项目共享。

方法详情

创建一个 Directory 提供者,其位置由给定的 Provider 计算得出。

基于相对路径的文件系统位置将根据此布局的参考位置解析,参考位置由 ProjectLayout.getProjectDirectory() 定义。

创建一个 RegularFile 提供者,其位置由给定的 Provider 计算得出。

基于相对路径的文件系统位置将根据此布局的参考位置解析,参考位置由 ProjectLayout.getProjectDirectory() 定义。

FileCollection files(Object... paths)

创建一个只读的 FileCollection,包含给定的文件,其定义方式与 Project.files(java.lang.Object[]) 相同。

此方法也可用于创建空集合,但该集合之后可能无法修改。