| API Documentation: | Checkstyle |
|---|
Runs Checkstyle against some source files.
| Property | Description |
classpath | The classpath containing the compiled classes for the source files to be inspected. |
configFile | The Checkstyle configuration file to use. |
excludes | The set of exclude patterns. |
ignoreFailures | Specifies whether the build should break when the verifications performed by this task fail. |
includes | The set of include patterns. |
properties | The properties available for use in the configuration file. These are substituted into the configuration file. |
resultFile | The file to generate the XML results to. |
source | The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist. |
FileCollection classpath
The classpath containing the compiled classes for the source files to be inspected.
- Default with
code-qualityplugin: sourceSet.compileClasspath
File configFile
The Checkstyle configuration file to use.
- Default with
code-qualityplugin: project.checkstyleConfigFile
Specifies whether the build should break when the verifications performed by this task fail.
- Default with
code-qualityplugin: false
The properties available for use in the configuration file. These are substituted into the configuration file.
- Default with
code-qualityplugin: project.checkstyleProperties
File resultFile
The file to generate the XML results to.
- Default with
code-qualityplugin: -
${project.checkstyleResultsDir}/${sourceSet.name}.xml
FileTree source
The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.
- Default with
code-qualityplugin: sourceSet.allJava
| Method | Description |
exclude(excludeSpec) | Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a
|
exclude(excludes) | Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed. |
exclude(excludes) | Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed. |
exclude(excludeSpec) | Adds an exclude spec. This method may be called multiple times to append new specs. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed. |
include(includeSpec) | Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a
|
include(includes) | Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed. |
include(includes) | Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed. |
include(includeSpec) | Adds an include spec. This method may be called multiple times to append new specs. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included. |
source(sources) | Adds some source to this task. The given source objects will be evaluated as for |
SourceTask exclude(Closure excludeSpec)
Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a
FileTreeElement as its parameter.
If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match
any exclude pattern to be processed.
SourceTask exclude(Iterable<String>
Iterable<String>Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
SourceTask exclude(String...
String...Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
SourceTask exclude(Spec<FileTreeElement>
Spec<FileTreeElement>Adds an exclude spec. This method may be called multiple times to append new specs. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
SourceTask include(Closure includeSpec)
Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a
FileTreeElement as its parameter.
If includes are not provided, then all files in this container will be included. If includes are provided, then a
file must match at least one of the include patterns or specs to be included.
SourceTask include(Iterable<String>
Iterable<String>Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.
SourceTask include(String...
String...Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.
SourceTask include(Spec<FileTreeElement>
Spec<FileTreeElement>Adds an include spec. This method may be called multiple times to append new specs. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.
SourceTask source(Object...
Object...Adds some source to this task. The given source objects will be evaluated as for Project.files().