AbstractCodeQualityTask

目录

属性
方法
脚本块
属性详情
方法详情
API 文档AbstractCodeQualityTask
已知子类型
Checkstyle
CodeNarc
Pmd

注意：此类处于孵化阶段，未来的 Gradle 版本中可能会有所更改。

代码质量任务的基类。

属性

属性描述
excludes

排除模式的集合。

ignoreFailures
孵化阶段

指定当此任务执行的验证失败时构建是否应该中断。

includes

包含模式的集合。

javaLauncher
孵化阶段

用于启动工作进程的 Java launcher

maxHeapSize
孵化阶段

工作进程的最大堆大小。如果未指定，将由 Gradle 提供默认最大堆大小。支持类似于命令行选项 -Xmx 的单位，例如 "1g"。

minHeapSize
孵化阶段

工作进程的最小堆大小。如果未指定，则不设置最小堆大小。支持类似于命令行选项 -Xms 的单位，例如 "1g"。

source

应用包含和排除模式后，此任务的源文件。忽略不存在的源文件。

方法

方法描述
exclude(excludeSpec)

添加一个排除 spec。可以多次调用此方法以追加新的 spec。给定的 closure 会将其参数设置为 FileTreeElement。该 closure 应该返回 true 或 false。示例

exclude(excludes)

添加一个 ANT 风格的排除模式。可以多次调用此方法以追加新模式，也可以在一次调用中指定多个模式。如果未提供 excludes，则不排除任何文件。如果提供了 excludes，则文件必须不匹配任何排除模式才能被处理。

exclude(excludes)

添加一个 ANT 风格的排除模式。可以多次调用此方法以追加新模式，也可以在一次调用中指定多个模式。如果未提供 excludes，则不排除任何文件。如果提供了 excludes，则文件必须不匹配任何排除模式才能被处理。

exclude(excludeSpec)

添加一个排除 spec。可以多次调用此方法以追加新的 spec。如果未提供 excludes，则不排除任何文件。如果提供了 excludes，则文件必须不匹配任何排除模式才能被处理。

include(includeSpec)

添加一个包含 spec。可以多次调用此方法以追加新的 spec。给定的 closure 会将其参数设置为 FileTreeElement。如果未提供 includes，则此容器中的所有文件都将被包含。如果提供了 includes，则文件必须匹配至少一个包含模式或 spec 才能被包含。

include(includes)

添加一个 ANT 风格的包含模式。可以多次调用此方法以追加新模式，也可以在一次调用中指定多个模式。如果未提供 includes，则此容器中的所有文件都将被包含。如果提供了 includes，则文件必须匹配至少一个包含模式才能被处理。

include(includes)

添加一个 ANT 风格的包含模式。可以多次调用此方法以追加新模式，也可以在一次调用中指定多个模式。如果未提供 includes，则此容器中的所有文件都将被包含。如果提供了 includes，则文件必须匹配至少一个包含模式才能被处理。

include(includeSpec)

添加一个包含 spec。可以多次调用此方法以追加新的 spec。如果未提供 includes，则此容器中的所有文件都将被包含。如果提供了 includes，则文件必须匹配至少一个包含模式或 spec 才能被包含。

source(sources)

向此任务添加一些源。将根据 Project.files(java.lang.Object[]) 评估给定的源对象。

脚本块

无脚本块

属性详情

Set<String> excludes

排除模式的集合。

boolean ignoreFailures

注意：此属性处于孵化阶段，未来的 Gradle 版本中可能会有所更改。

指定当此任务执行的验证失败时构建是否应该中断。

默认值
false

Set<String> includes

包含模式的集合。

Property<JavaLauncher> javaLauncher

注意：此属性处于孵化阶段，未来的 Gradle 版本中可能会有所更改。

用于启动工作进程的 Java launcher

Property<String> maxHeapSize

注意：此属性处于孵化阶段，未来的 Gradle 版本中可能会有所更改。

工作进程的最大堆大小。如果未指定，将由 Gradle 提供默认最大堆大小。支持类似于命令行选项 -Xmx 的单位，例如 "1g"。

Property<String> minHeapSize

注意：此属性处于孵化阶段，未来的 Gradle 版本中可能会有所更改。

工作进程的最小堆大小。如果未指定，则不设置最小堆大小。支持类似于命令行选项 -Xms 的单位，例如 "1g"。

FileTree source

应用包含和排除模式后，此任务的源文件。忽略不存在的源文件。

源文件的 PathSensitivity 配置为 PathSensitivity.ABSOLUTE。如果你的源文件限制较少，请在子类中覆盖此方法进行相应的更改。

方法详情

SourceTask exclude(Closure excludeSpec)

添加一个排除 spec。可以多次调用此方法以追加新的 spec。给定的 closure 会将其参数设置为 FileTreeElement。该 closure 应该返回 true 或 false。示例

copySpec {
  from 'source'
  into 'destination'
  //an example of excluding files from certain configuration:
  exclude { it.file in configurations.someConf.files }
}

如果未提供 excludes，则不排除任何文件。如果提供了 excludes，则文件必须不匹配任何排除模式才能被处理。

SourceTask exclude(Iterable<String> excludes)

添加一个 ANT 风格的排除模式。可以多次调用此方法以追加新模式，也可以在一次调用中指定多个模式。如果未提供 excludes，则不排除任何文件。如果提供了 excludes，则文件必须不匹配任何排除模式才能被处理。

SourceTask exclude(String... excludes)

添加一个 ANT 风格的排除模式。可以多次调用此方法以追加新模式，也可以在一次调用中指定多个模式。如果未提供 excludes，则不排除任何文件。如果提供了 excludes，则文件必须不匹配任何排除模式才能被处理。

SourceTask exclude(Spec<FileTreeElement> excludeSpec)

添加一个排除 spec。可以多次调用此方法以追加新的 spec。如果未提供 excludes，则不排除任何文件。如果提供了 excludes，则文件必须不匹配任何排除模式才能被处理。

SourceTask include(Closure includeSpec)

添加一个包含 spec。可以多次调用此方法以追加新的 spec。给定的 closure 会将其参数设置为 FileTreeElement。如果未提供 includes，则此容器中的所有文件都将被包含。如果提供了 includes，则文件必须匹配至少一个包含模式或 spec 才能被包含。

SourceTask include(Iterable<String> includes)

添加一个 ANT 风格的包含模式。可以多次调用此方法以追加新模式，也可以在一次调用中指定多个模式。如果未提供 includes，则此容器中的所有文件都将被包含。如果提供了 includes，则文件必须匹配至少一个包含模式才能被处理。

SourceTask include(String... includes)

添加一个 ANT 风格的包含模式。可以多次调用此方法以追加新模式，也可以在一次调用中指定多个模式。如果未提供 includes，则此容器中的所有文件都将被包含。如果提供了 includes，则文件必须匹配至少一个包含模式才能被处理。

SourceTask include(Spec<FileTreeElement> includeSpec)

添加一个包含 spec。可以多次调用此方法以追加新的 spec。如果未提供 includes，则此容器中的所有文件都将被包含。如果提供了 includes，则文件必须匹配至少一个包含模式或 spec 才能被包含。

SourceTask source(Object... sources)

向此任务添加一些源。将根据 Project.files(java.lang.Object[]) 评估给定的源对象。