AbstractCodeQualityTask

目录

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

注意：此类是孵化中 (incubating)的功能，并且可能在 Gradle 的未来版本中更改。

代码质量任务的基类。

属性

属性描述
excludes (排除项)

排除模式的集合。

ignoreFailures (忽略失败)
孵化中 (Incubating)

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

includes (包含项)

包含模式的集合。

javaLauncher (Java 启动器)
孵化中 (Incubating)

用于启动 worker 进程的 Java 启动器

maxHeapSize (最大堆大小)
孵化中 (Incubating)

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

minHeapSize (最小堆大小)
孵化中 (Incubating)

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

source (源)

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

方法

方法描述
exclude(excludeSpec)

添加一个排除规范。可以多次调用此方法以追加新的规范。给定的闭包将传递一个 FileTreeElement 作为其参数。闭包应返回 true 或 false。示例

exclude(excludes)

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

exclude(excludes)

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

exclude(excludeSpec)

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

include(includeSpec)

添加一个包含规范。可以多次调用此方法以追加新的规范。给定的闭包将传递一个 FileTreeElement 作为其参数。如果未提供包含项，则将包含此容器中的所有文件。如果提供了包含项，则文件必须至少匹配一个包含模式或规范才能被包含。

include(includes)

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

include(includes)

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

include(includeSpec)

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

source(sources)

为此任务添加一些源。给定的源对象将按照 Project.files(java.lang.Object[]) 进行评估。

脚本块

没有脚本块

属性详情

Set<String> excludes

排除模式的集合。

boolean ignoreFailures

注意：此属性是孵化中 (incubating)的功能，并且可能在 Gradle 的未来版本中更改。

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

默认值
false

Set<String> includes

包含模式的集合。

Property<JavaLauncher> javaLauncher

注意：此属性是孵化中 (incubating)的功能，并且可能在 Gradle 的未来版本中更改。

用于启动 worker 进程的 Java 启动器

Property<String> maxHeapSize

注意：此属性是孵化中 (incubating)的功能，并且可能在 Gradle 的未来版本中更改。

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

Property<String> minHeapSize

注意：此属性是孵化中 (incubating)的功能，并且可能在 Gradle 的未来版本中更改。

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

FileTree source

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

源的 PathSensitivity 配置为 PathSensitivity.ABSOLUTE。如果您的源要求不那么严格，请在您的子类中重写此方法以相应地更改它。

方法详情

SourceTask exclude(Closure excludeSpec)

添加一个排除规范。可以多次调用此方法以追加新的规范。给定的闭包将传递一个 FileTreeElement 作为其参数。闭包应返回 true 或 false。示例

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

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

SourceTask exclude(Iterable<String> excludes)

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

SourceTask exclude(String... excludes)

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

SourceTask exclude(Spec<FileTreeElement> excludeSpec)

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

SourceTask include(Closure includeSpec)

添加一个包含规范。可以多次调用此方法以追加新的规范。给定的闭包将传递一个 FileTreeElement 作为其参数。如果未提供包含项，则将包含此容器中的所有文件。如果提供了包含项，则文件必须至少匹配一个包含模式或规范才能被包含。

SourceTask include(Iterable<String> includes)

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

SourceTask include(String... includes)

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

SourceTask include(Spec<FileTreeElement> includeSpec)

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

SourceTask source(Object... sources)

为此任务添加一些源。给定的源对象将按照 Project.files(java.lang.Object[]) 进行评估。