Checkstyle - Gradle DSL Version 2.14.1

# Checkstyle

API Documentation: | `Checkstyle`

Runs Checkstyle against some source files.

### Properties

Property | Description
`checkstyleClasspath` | The class path containing the Checkstyle library to be used.
`classpath` | The class path containing the compiled classes for the source files to be analyzed.
`config` | Incubating The Checkstyle configuration to use. Replaces the `configFile` property.
`configFile` | The Checkstyle configuration file to use.
`configProperties` | The properties available for use in the configuration file. These are substituted into the configuration file.
`excludes` | The set of exclude patterns.
`ignoreFailures` | Whether or not this task will ignore failures and continue running the build.
`includes` | The set of include patterns.
`reports` | The reports to be generated by this task.
`showViolations` | Whether or not rule violations are to be displayed on the console.
`source` | The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.

### Methods

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 `FileTreeElement` as its parameter. The closure should return true or false. Example:
`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 `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.
`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 per `Project.files(java.lang.Object[])`.

### Script blocks

Block | Description
`reports` | Configures the reports to be generated by this task. The contained reports can be configured by name and closures. Example:

### Property details

#### `FileCollection` `checkstyleClasspath`

The class path containing the Checkstyle library to be used.

Default with `checkstyle` plugin:
  `project.configurations.checkstyle`

#### `FileCollection` `classpath`

The class path containing the compiled classes for the source files to be analyzed.

Default with `checkstyle` plugin:
  ``sourceSet`.output`

#### `TextResource` `config`

Note: This property is incubating and may change in a future version of Gradle.

The Checkstyle configuration to use. Replaces the `configFile` property.

Default with `checkstyle` plugin:
  `project.checkstyle.config`

#### `File` `configFile`

The Checkstyle configuration file to use.

Default with `checkstyle` plugin:
  `project.checkstyle.configFile`

#### ``Map`<`String`, `Object`>` `configProperties`

The properties available for use in the configuration file. These are substituted into the configuration file.

Default with `checkstyle` plugin:
  `project.checkstyle.configProperties`

#### ``Set`<`String`>` `excludes`

The set of exclude patterns.

#### `boolean` `ignoreFailures`

Whether or not this task will ignore failures and continue running the build.

Default with `checkstyle` plugin:
  `project.checkstyle.ignoreFailures`

#### ``Set`<`String`>` `includes`

The set of include patterns.

#### `CheckstyleReports` `reports` (read-only)

The reports to be generated by this task.

#### `boolean` `showViolations`

Whether or not rule violations are to be displayed on the console.

Default with `checkstyle` plugin:
  `project.checkstyle.showViolations`

#### `FileTree` `source`

The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.

### Method details

#### `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. The closure should return true or false. Example:

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

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`>` 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.

#### `SourceTask` `exclude`(``String`...` 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.

#### `SourceTask` `exclude`(``Spec`<`FileTreeElement`>` 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.

#### `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`>` 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.

#### `SourceTask` `include`(``String`...` 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.

#### `SourceTask` `include`(``Spec`<`FileTreeElement`>` 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.

#### `SourceTask` `source`(``Object`...` sources)

Adds some source to this task. The given source objects will be evaluated as per `Project.files(java.lang.Object[])`.

### Script block details

#### `reports` { }

Configures the reports to be generated by this task. The contained reports can be configured by name and closures. Example:

    checkstyleTask {
      reports {
        html {
          destination "build/codenarc.html"
        }
      }
    }

Delegates to:
  `CheckstyleReports` from `reports`