配置

API文档:Configuration

AConfiguration代表一组工件及其依赖项。在文档中查找有关声明配置依赖项或管理配置的更多信息ConfigurationContainer

FileCollection 配置是一个包含所有依赖项(另请参阅 参考资料Configuration.getAllDependencies())但不包含工件 的实例。如果您想引用此配置中声明的工件,请使用Configuration.getArtifacts()Configuration.getAllArtifacts()。阅读文档中有关在配置中声明工件的更多信息,ArtifactHandler 请参阅“声明依赖项用户手册”一章以获取更多信息。

特性

财产描述
allArtifacts

此配置的工件包括扩展配置的工件。

allDependencies

获取完整的声明依赖项集,包括由超级配置贡献的依赖项。

artifacts

此配置的工件不包括扩展配置的工件。

buildDependencies

返回一个TaskDependency对象,其中包含构建属于此配置或其超级配置之一的本地依赖项(例如项目依赖项)所需的所有依赖项。

dependencies

获取直接包含在此配置中的声明的依赖项集(忽略超级配置)。

description

此配置的说明。

excludeRules

排除规则适用于解决此配置的任何依赖性。

extendsFrom

此配置扩展自的配置的名称。超级配置的神器在这个配置里也有。

hierarchy

递归获取包含此配置和所有超级配置的有序集。

incoming

此配置的传入依赖项。

resolutionStrategy

此配置使用的解析策略。解决策略提供了有关如何解决此配置的额外详细信息。ResolutionStrategy有关更多信息和示例,请参阅文档。

resolvedConfiguration

解决此配置。这将查找并下载构成此配置的文件,并返回ResolvedConfiguration可用于确定有关解析(包括错误)的信息。

state

配置的状态。

transitive

此配置的传递性。传递配置包含其直接依赖项及其所有依赖项的传递闭包。不传递配置仅包含直接依赖项。默认值是true。

visible

如果这是可见配置,则返回 true。可见配置可以在其所属项目之外使用。默认值是true。

方法

方法描述
copy()

创建此配置的副本,仅包含直接在此配置中的依赖项(没有超级配置的贡献)。新配置将处于 UNRESOLVED 状态,但将保留该配置的所有其他属性(超级配置除外)。 Configuration.getHierarchy()该副本将不包含任何超级配置。

copy(dependencySpec)

接受一个被强制转换为Spec.其他方面的行为方式与Configuration.copy(org.gradle.api.specs.Spec)

copy(dependencySpec)

创建此配置的副本,忽略超级配置(请参阅Configuration.copy()但使用指定的依赖项规范过滤依赖项。

copyRecursive()

创建此配置的副本,其中包含直接在此配置中的依赖项以及从超级配置派生的依赖项。新配置将处于 UNRESOLVED 状态,但将保留该配置的所有其他属性(超级配置除外)。 Configuration.getHierarchy()该副本将不包含任何超级配置。

copyRecursive(dependencySpec)

接受一个被强制转换为Spec.其他方面的行为方式与Configuration.copyRecursive(org.gradle.api.specs.Spec)

copyRecursive(dependencySpec)

使用来自超级配置的依赖项创建此配置的副本(请参阅 参考资料Configuration.copyRecursive()),但使用 dependencySpec 过滤依赖项。

defaultDependencies(action)

如果配置首次参与依赖关系解析时没有定义的依赖关系,则执行给定的操作。 AConfiguration将在以下情况下参与依赖解析:

exclude(excludeProperties)

添加排除规则以排除此配置的所有依赖项的传递依赖项。您还可以为每个依赖项添加排除规则。看ModuleDependency.exclude(java.util.Map)

extendsFrom(superConfigs)

将给定配置添加到此配置所扩展的配置集中。

fileCollection(dependencySpecClosure)

接受一个被强制转换为Spec.其他方面的行为与 相同 Configuration.fileCollection(org.gradle.api.specs.Spec)

fileCollection(dependencies)

延迟解析此配置。当FileCollection第一次访问返回的元素时,就会发生解析。这将查找并下载构成此配置的文件。仅属于指定依赖项的结果文件集包含在 FileCollection 中。

fileCollection(dependencySpec)

延迟解析此配置。当FileCollection第一次访问返回的元素时,就会发生解析。这将查找并下载构成此配置的文件。仅属于由 dependencySpec 指定的依赖项子集的结果文件集包含在 FileCollection 中。

files(dependencySpecClosure)

接受一个被强制转换为Spec.其他方面的行为与 相同 Configuration.files(org.gradle.api.specs.Spec)

files(dependencies)

解决此配置。这将查找并下载构成此配置的文件。但仅返回属于指定依赖项的结果文件集。

files(dependencySpec)

解决此配置。这将查找并下载构成此配置的文件。但仅返回属于 dependencySpec 指定的依赖项子集的结果文件集。

getTaskDependencyFromProjectDependency(useDependedOn, taskName)

返回一个 TaskDependency 对象,其中包含与此配置或其超级配置之一相关的项目依赖项中具有指定名称的所有任务的依赖项。这些其他项目可能是此配置所依赖的项目,也可能是具有类似名称的配置(基于 useDependOn 参数依赖于此配置)的项目。

脚本块

无脚本块

物业详情

PublishArtifactSet allArtifacts(只读)

此配置的工件包括扩展配置的工件。

DependencySet allDependencies(只读)

获取完整的声明依赖项集,包括由超级配置贡献的依赖项。

此方法不解析配置。因此,返回值不包含传递依赖。

PublishArtifactSet artifacts(只读)

此配置的工件不包括扩展配置的工件。

TaskDependency buildDependencies(只读)

返回一个TaskDependency对象,其中包含构建属于此配置或其超级配置之一的本地依赖项(例如项目依赖项)所需的所有依赖项。

DependencySet dependencies(只读)

获取直接包含在此配置中的声明的依赖项集(忽略超级配置)。

此方法不解析配置。因此,返回值不包含传递依赖。

String description

此配置的说明。

Set<ExcludeRule> excludeRules(只读)

排除规则适用于解决此配置的任何依赖性。

Set<Configuration> extendsFrom

此配置扩展自的配置的名称。超级配置的神器在这个配置里也有。

Set<Configuration> hierarchy(只读)

递归获取包含此配置和所有超级配置的有序集。

ResolvableDependencies incoming(只读)

此配置的传入依赖项。

ResolutionStrategy resolutionStrategy(只读)

此配置使用的解析策略。解决策略提供了有关如何解决此配置的额外详细信息。ResolutionStrategy有关更多信息和示例,请参阅文档。

ResolvedConfiguration resolvedConfiguration(只读)

解决此配置。这将查找并下载构成此配置的文件,并返回ResolvedConfiguration可用于确定有关解析(包括错误)的信息。

State state(只读)

配置的状态。

boolean transitive

此配置的传递性。传递配置包含其直接依赖项及其所有依赖项的传递闭包。不传递配置仅包含直接依赖项。默认值是true。

boolean visible

如果这是可见配置,则返回 true。可见配置可以在其所属项目之外使用。默认值是true。

方法详情

创建此配置的副本,仅包含直接在此配置中的依赖项(没有超级配置的贡献)。新配置将处于 UNRESOLVED 状态,但将保留该配置的所有其他属性(超级配置除外)。 Configuration.getHierarchy()该副本将不包含任何超级配置。

此方法仅适用于涉及可解析配置的特定情况,而不是 作为通用复制机制。

Configuration copyClosure依赖规范)

接受一个被强制转换为Spec.其他方面的行为方式与Configuration.copy(org.gradle.api.specs.Spec)

此方法仅适用于涉及可解析配置的特定情况,而不是 作为通用复制机制。

Configuration copy(依赖规范)Spec<? super Dependency>

创建此配置的副本,忽略超级配置(请参阅Configuration.copy()但使用指定的依赖项规范过滤依赖项。

此方法仅适用于涉及可解析配置的特定情况,而不是 作为通用复制机制。

Configuration copyRecursive()

创建此配置的副本,其中包含直接在此配置中的依赖项以及从超级配置派生的依赖项。新配置将处于 UNRESOLVED 状态,但将保留该配置的所有其他属性(超级配置除外)。 Configuration.getHierarchy()该副本将不包含任何超级配置。

此方法仅适用于涉及可解析配置的特定情况,而不是 作为通用复制机制。

Configuration copyRecursiveClosure依赖规范)

接受一个被强制转换为Spec.其他方面的行为方式与Configuration.copyRecursive(org.gradle.api.specs.Spec)

此方法仅适用于涉及可解析配置的特定情况,而不是 作为通用复制机制。

Configuration copyRecursive(依赖规范)Spec<? super Dependency>

使用来自超级配置的依赖项创建此配置的副本(请参阅 参考资料Configuration.copyRecursive()),但使用 dependencySpec 过滤依赖项。

此方法仅适用于涉及可解析配置的特定情况,而不是 作为通用复制机制。

Configuration defaultDependencies(行动)Action<? super DependencySet>

如果配置首次参与依赖关系解析时没有定义的依赖关系,则执行给定的操作。 AConfiguration将在以下情况下参与依赖解析:

此方法对于指定配置的默认依赖项很有用:

configurations { conf }
configurations['conf'].defaultDependencies { dependencies ->
     dependencies.add(owner.project.dependencies.create("org.gradle:my-util:1.0"))
}

即使AConfiguration扩展了另一个非空 ,也被认为是空的Configuration

如果提供了多个操作,则将执行每个操作,直到依赖项集不再为空。其余操作将被忽略。

Configuration exclude(排除属性)Map<String, String>

添加排除规则以排除此配置的所有依赖项的传递依赖项。您还可以为每个依赖项添加排除规则。看ModuleDependency.exclude(java.util.Map)

Configuration extendsFromConfiguration...超级配置)

将给定配置添加到此配置所扩展的配置集中。

FileCollection fileCollectionClosure依赖规范闭包)

接受一个被强制转换为Spec.其他方面的行为与 相同 Configuration.fileCollection(org.gradle.api.specs.Spec)

FileCollection fileCollectionDependency...依赖项)

延迟解析此配置。当FileCollection第一次访问返回的元素时,就会发生解析。这将查找并下载构成此配置的文件。仅属于指定依赖项的结果文件集包含在 FileCollection 中。

FileCollection fileCollection(依赖规范)Spec<? super Dependency>

延迟解析此配置。当FileCollection第一次访问返回的元素时,就会发生解析。这将查找并下载构成此配置的文件。仅属于由 dependencySpec 指定的依赖项子集的结果文件集包含在 FileCollection 中。

Set<File> filesClosure依赖规范闭包)

接受一个被强制转换为Spec.其他方面的行为与 相同 Configuration.files(org.gradle.api.specs.Spec)

Set<File> filesDependency...依赖项)

解决此配置。这将查找并下载构成此配置的文件。但仅返回属于指定依赖项的结果文件集。

Set<File> files(依赖规范)Spec<? super Dependency>

解决此配置。这将查找并下载构成此配置的文件。但仅返回属于 dependencySpec 指定的依赖项子集的结果文件集。

TaskDependency getTaskDependencyFromProjectDependencybooleanuseDependedOn,String任务名称)

返回一个 TaskDependency 对象,其中包含与此配置或其超级配置之一相关的项目依赖项中具有指定名称的所有任务的依赖项。这些其他项目可能是此配置所依赖的项目,也可能是具有类似名称的配置(基于 useDependOn 参数依赖于此配置)的项目。