AbstractCodeQualityTask

目录

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

注意：此类为孵化中，将来版本的Gradle中可能会有变动。

代码质量任务的基类。

属性

属性描述
excludes

排除模式集。

ignoreFailures
孵化中

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

includes

包含模式集。

javaLauncher
孵化中

用于启动工作进程的Java启动器

maxHeapSize
孵化中

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

minHeapSize
孵化中

工作进程的最小堆大小。如果未指定，则不设置最小堆大小。支持像命令行选项-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

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

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

默认值
false

Set<String> includes

包含模式集。

Property<JavaLauncher> javaLauncher

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

用于启动工作进程的Java启动器

Property<String> maxHeapSize

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

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

Property<String> minHeapSize

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

工作进程的最小堆大小。如果未指定，则不设置最小堆大小。支持像命令行选项-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[])进行评估。