You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2014/03/08 23:39:47 UTC
svn commit: r900631 [5/34] - in
/websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST:
./ apidocs/ apidocs/org/apache/maven/plugin/checkstyle/
apidocs/org/apache/maven/plugin/checkstyle/class-use/
apidocs/org/apache/maven/p...
Modified: websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST/check-mojo.html
==============================================================================
--- websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST/check-mojo.html (original)
+++ websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST/check-mojo.html Sat Mar 8 22:39:44 2014
@@ -1,11 +1,11 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--
- | Generated by Apache Maven Doxia at Feb 22, 2013
+ | Generated by Apache Maven Doxia at 2014-03-08
| Rendered using Apache Maven Stylus Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
- <title>Maven Checkstyle Plugin -
+ <title>Apache Maven Checkstyle Plugin -
checkstyle:check</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@@ -13,7 +13,7 @@
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <meta name="Date-Revision-yyyymmdd" content="20130222" />
+ <meta name="Date-Revision-yyyymmdd" content="20140308" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script>
@@ -42,14 +42,14 @@
>
<a href="../index.html">Plugins</a>
>
- <a href="./">Maven Checkstyle Plugin</a>
+ <a href="./">Apache Maven Checkstyle Plugin</a>
>
checkstyle:check
</div>
<div class="xright">
- Last Published: 2013-02-22
- | Version: 2.10
+ Last Published: 2014-03-08
+ | Version: 2.12
</div>
<div class="clear">
<hr/>
@@ -76,6 +76,9 @@
<h5>Examples</h5>
<ul>
<li class="none">
+ <a href="examples/inline-checker-config.html">Using an Inline Checkstyle Checker Configuration</a>
+ </li>
+ <li class="none">
<a href="examples/custom-checker-config.html">Using a Custom Checkstyle Checker Configuration</a>
</li>
<li class="none">
@@ -170,468 +173,1034 @@
<div id="contentBox">
- <div class="section"><h2>checkstyle:check<a name="checkstyle:check"></a></h2>
- <p><b>Full name</b>:</p>
- <p>org.apache.maven.plugins:maven-checkstyle-plugin:2.10:check</p>
- <p><b>Description</b>:</p>
- <div>Perform a violation check against the last Checkstyle run to see if
-there are any violations. It reads the Checkstyle output file,
-counts the number of violations found and displays it on the
-console.</div>
- <p><b>Attributes</b>:</p>
- <ul>
- <li>Requires a Maven project to be executed.</li>
- <li>Requires dependency resolution of artifacts in scope: <tt>test</tt>.</li>
- <li>The goal is thread-safe and supports parallel builds.</li>
- <li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <tt>verify</tt>.</li>
+ <div class="section">
+<h2>checkstyle:check<a name="checkstyle:check"></a></h2>
+
+<p><b>Full name</b>:</p>
+
+<p>org.apache.maven.plugins:maven-checkstyle-plugin:2.12:check</p>
+
+<p><b>Description</b>:</p>
+
+<div>Performs Checkstyle analysis and outputs violations or a count of
+violations to the console, potentially failing the build. It can
+also be configured to re-use an earlier analysis.</div>
+
+<p><b>Attributes</b>:</p>
+
+<ul>
+
+<li>Requires a Maven project to be executed.</li>
+
+<li>Requires dependency resolution of artifacts in scope: <tt>test</tt>.</li>
+
+<li>The goal is thread-safe and supports parallel builds.</li>
+
+<li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <tt>verify</tt>.</li>
</ul>
- <div class="section"><h3>Required Parameters<a name="Required_Parameters"></a></h3>
- <table class="bodyTable" border="0">
- <tr class="a">
- <th>Name</th>
- <th>Type</th>
- <th>Since</th>
- <th>Description</th>
- </tr>
- <tr class="b">
- <td><b><a href="#includes">includes</a></b></td>
- <td><tt>String</tt></td>
- <td><tt>-</tt></td>
- <td>Specifies the names filter of the source files to be used for
-Checkstyle. <b>Note:</b> default value is
-<tt>**\/*.java</tt>.<br /><b>Default value is</b>: <tt>**\/*.java</tt>.<br /><b>User property is</b>: <tt>checkstyle.includes</tt>.</td>
- </tr>
- <tr class="a">
- <td><b><a href="#sourceDirectory">sourceDirectory</a></b></td>
- <td><tt>File</tt></td>
- <td><tt>-</tt></td>
- <td>Specifies the location of the source directory to be used for
+
+<div class="section">
+<h3>Required Parameters<a name="Required_Parameters"></a></h3>
+
+<table class="bodyTable" border="0">
+
+<tr class="a">
+
+<th>Name</th>
+
+<th>Type</th>
+
+<th>Since</th>
+
+<th>Description</th>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#includeResources">includeResources</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>2.11</tt></td>
+
+<td>Whether to apply Checkstyle to resource directories.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>checkstyle.includeResources</tt>.</td>
+ </tr>
+
+<tr class="a">
+
+<td><b><a href="#includeTestResources">includeTestResources</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>2.11</tt></td>
+
+<td>Whether to apply Checkstyle to test resource directories.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>checkstyle.includeTestResources</tt>.</td>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#includes">includes</a></b></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>-</tt></td>
+
+<td>Specifies the names filter of the source files to be used for
+Checkstyle.<br /><b>Default value is</b>: <tt>**\/*.java</tt>.<br /><b>User property is</b>: <tt>checkstyle.includes</tt>.</td>
+ </tr>
+
+<tr class="a">
+
+<td><b><a href="#resourceIncludes">resourceIncludes</a></b></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>2.11</tt></td>
+
+<td>Specifies the names filter of the files to be used for Checkstyle
+when checking resources.<br /><b>Default value is</b>: <tt>**/*.properties</tt>.<br /><b>User property is</b>: <tt>checkstyle.resourceIncludes</tt>.</td>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#sourceDirectory">sourceDirectory</a></b></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>-</tt></td>
+
+<td>Specifies the location of the source directory to be used for
Checkstyle.<br /><b>Default value is</b>: <tt>${project.build.sourceDirectory}</tt>.<br /></td>
</tr>
</table>
</div>
- <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
- <table class="bodyTable" border="0">
- <tr class="a">
- <th>Name</th>
- <th>Type</th>
- <th>Since</th>
- <th>Description</th>
- </tr>
- <tr class="b">
- <td><b><a href="#cacheFile">cacheFile</a></b></td>
- <td><tt>String</tt></td>
- <td><tt>-</tt></td>
- <td>Specifies the cache file used to speed up Checkstyle on successive
+
+<div class="section">
+<h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
+
+<table class="bodyTable" border="0">
+
+<tr class="a">
+
+<th>Name</th>
+
+<th>Type</th>
+
+<th>Since</th>
+
+<th>Description</th>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#cacheFile">cacheFile</a></b></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>-</tt></td>
+
+<td>Specifies the cache file used to speed up Checkstyle on successive
runs.<br /><b>Default value is</b>: <tt>${project.build.directory}/checkstyle-cachefile</tt>.<br /></td>
</tr>
- <tr class="a">
- <td><b><a href="#configLocation">configLocation</a></b></td>
- <td><tt>String</tt></td>
- <td><tt>2.5</tt></td>
- <td><p>Specifies the location of the XML configuration to use.</p>
+
+<tr class="a">
+
+<td><b><a href="#checkstyleRules">checkstyleRules</a></b></td>
+
+<td><tt>PlexusConfiguration</tt></td>
+
+<td><tt>2.12</tt></td>
+
+<td>By using this property, you can specify the whole checkstyle rules
+inline directly inside this pom.
+
+<div>
+<pre>
+<plugin>
+ ...
+ <configuration>
+ <checkstyleRules>
+ <module name="Checker">
+ <module name="FileTabCharacter">
+ <property name="eachLine" value="true" />
+ </module>
+ <module name="TreeWalker">
+ <module name="EmptyBlock"/>
+ </module>
+ </module>
+ </checkstyleRules>
+ </configuration>
+ ...
+</pre></div><br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#configLocation">configLocation</a></b></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>2.5</tt></td>
+
+<td>
+<p>Specifies the location of the XML configuration to use.</p>
+
<p>Potential values are a filesystem path, a URL, or a classpath
resource. This parameter expects that the contents of the location
conform to the xml format (Checkstyle <a class="externalLink" href="http://checkstyle.sourceforge.net/config.html#Modules">Checker
module</a>) configuration of rulesets.</p>
+
<p>This parameter is resolved as resource, URL, then file. If
successfully resolved, the contents of the configuration is copied
into the
<tt>${project.build.directory}/checkstyle-configuration.xml</tt>
file before being passed to Checkstyle as a configuration.</p>
+
<p>There are 4 predefined rulesets.</p>
+
<ul>
+
<li><tt>config/sun_checks.xml</tt>: Sun Checks.</li>
+
<li><tt>config/turbine_checks.xml</tt>: Turbine Checks.</li>
+
<li><tt>config/avalon_checks.xml</tt>: Avalon Checks.</li>
+
<li><tt>config/maven_checks.xml</tt>: Maven Source Checks.</li>
</ul><br /><b>Default value is</b>: <tt>config/sun_checks.xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.config.location</tt>.</td>
</tr>
- <tr class="b">
- <td><b><a href="#consoleOutput">consoleOutput</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>-</tt></td>
- <td>Output errors to console.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td>
- </tr>
- <tr class="a">
- <td><b><a href="#encoding">encoding</a></b></td>
- <td><tt>String</tt></td>
- <td><tt>2.2</tt></td>
- <td>The file encoding to use when reading the source files. If the
+
+<tr class="a">
+
+<td><b><a href="#consoleOutput">consoleOutput</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>-</tt></td>
+
+<td>Output errors to console.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>checkstyle.consoleOutput</tt>.</td>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#encoding">encoding</a></b></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>2.2</tt></td>
+
+<td>The file encoding to use when reading the source files. If the
property <tt>project.build.sourceEncoding</tt> is not set, the
platform default encoding is used. <b>Note:</b> This
parameter always overrides the property <tt>charset</tt> from
Checkstyle's <tt>TreeWalker</tt> module.<br /><b>Default value is</b>: <tt>${project.build.sourceEncoding}</tt>.<br /><b>User property is</b>: <tt>encoding</tt>.</td>
</tr>
- <tr class="b">
- <td><b><a href="#excludes">excludes</a></b></td>
- <td><tt>String</tt></td>
- <td><tt>-</tt></td>
- <td>Specifies the names filter of the source files to be excluded for
+
+<tr class="a">
+
+<td><b><a href="#excludes">excludes</a></b></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>-</tt></td>
+
+<td>Specifies the names filter of the source files to be excluded for
Checkstyle.<br /><b>User property is</b>: <tt>checkstyle.excludes</tt>.</td>
</tr>
- <tr class="a">
- <td><b><a href="#failOnViolation">failOnViolation</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>-</tt></td>
- <td>Do we fail the build on a violation?<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>checkstyle.failOnViolation</tt>.</td>
- </tr>
- <tr class="b">
- <td><b><a href="#failsOnError">failsOnError</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>-</tt></td>
- <td>Specifies if the build should fail upon a violation.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td>
- </tr>
- <tr class="a">
- <td><b><a href="#headerLocation">headerLocation</a></b></td>
- <td><tt>String</tt></td>
- <td><tt>2.0-beta-2</tt></td>
- <td><p>Specifies the location of the License file (a.k.a. the header
+
+<tr class="b">
+
+<td><b><a href="#failOnViolation">failOnViolation</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>-</tt></td>
+
+<td>Fail the build on a violation. The goal checks for the violations
+after logging them (if <tt>logViolationsToConsole</tt> is
+'true'). Compare this to <tt>failsOnError</tt> which fails the
+build immediately before examining the output log.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>checkstyle.failOnViolation</tt>.</td>
+ </tr>
+
+<tr class="a">
+
+<td><b><a href="#failsOnError">failsOnError</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>-</tt></td>
+
+<td>If this is true, and checkstyle reported any violations or errors,
+the build fails immediately after running checkstyle, before
+checking the log for <tt>logViolationsToConsole</tt>. If you
+want to use <tt>logViolationsToConsole</tt>, use
+<tt>failOnViolation</tt> instead of this.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#headerLocation">headerLocation</a></b></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>2.0-beta-2</tt></td>
+
+<td>
+<p>Specifies the location of the License file (a.k.a. the header
file) that can be used by Checkstyle to verify that source code has
the correct license header.</p>
+
<p>You need to use ${checkstyle.header.file} in your Checkstyle xml
configuration to reference the name of this header file.</p>
+
<p>For instance:</p>
+
<p><tt><module name="RegexpHeader"> <property
name="headerFile" value="${checkstyle.header.file}"/>
</module></tt></p><br /><b>Default value is</b>: <tt>LICENSE.txt</tt>.<br /><b>User property is</b>: <tt>checkstyle.header.file</tt>.</td>
</tr>
- <tr class="b">
- <td><b><a href="#includeTestSourceDirectory">includeTestSourceDirectory</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>2.2</tt></td>
- <td>Include or not the test source directory to be used for Checkstyle.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td>
- </tr>
- <tr class="a">
- <td><b><a href="#logViolationsToConsole">logViolationsToConsole</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>2.3</tt></td>
- <td>Output the detected violations to the console.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>checkstyle.console</tt>.</td>
- </tr>
- <tr class="b">
- <td><b><a href="#maxAllowedViolations">maxAllowedViolations</a></b></td>
- <td><tt>int</tt></td>
- <td><tt>2.3</tt></td>
- <td>The maximum number of allowed violations. The execution fails only
+
+<tr class="a">
+
+<td><b><a href="#includeTestSourceDirectory">includeTestSourceDirectory</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>2.2</tt></td>
+
+<td>Include or not the test source directory to be used for Checkstyle.<br /><b>Default value is</b>: <tt>false</tt>.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#logViolationsToConsole">logViolationsToConsole</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>2.3</tt></td>
+
+<td>Output the detected violations to the console.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>checkstyle.console</tt>.</td>
+ </tr>
+
+<tr class="a">
+
+<td><b><a href="#maxAllowedViolations">maxAllowedViolations</a></b></td>
+
+<td><tt>int</tt></td>
+
+<td><tt>2.3</tt></td>
+
+<td>The maximum number of allowed violations. The execution fails only
if the number of violations is above this limit.<br /><b>Default value is</b>: <tt>0</tt>.<br /><b>User property is</b>: <tt>checkstyle.maxAllowedViolations</tt>.</td>
</tr>
- <tr class="a">
- <td><b><a href="#outputFile">outputFile</a></b></td>
- <td><tt>File</tt></td>
- <td><tt>-</tt></td>
- <td>Specifies the path and filename to save the Checkstyle output. The
+
+<tr class="b">
+
+<td><b><a href="#outputFile">outputFile</a></b></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>-</tt></td>
+
+<td>Specifies the path and filename to save the Checkstyle output. The
format of the output file is determined by the
<tt>outputFileFormat</tt> parameter.<br /><b>Default value is</b>: <tt>${project.build.directory}/checkstyle-result.xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.output.file</tt>.</td>
</tr>
- <tr class="b">
- <td><b><a href="#outputFileFormat">outputFileFormat</a></b></td>
- <td><tt>String</tt></td>
- <td><tt>-</tt></td>
- <td>Specifies the format of the output to be used when writing to the
+
+<tr class="a">
+
+<td><b><a href="#outputFileFormat">outputFileFormat</a></b></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>-</tt></td>
+
+<td>Specifies the format of the output to be used when writing to the
output file. Valid values are "plain" and "xml".<br /><b>Default value is</b>: <tt>xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.output.format</tt>.</td>
</tr>
- <tr class="a">
- <td><b><a href="#propertiesLocation">propertiesLocation</a></b></td>
- <td><tt>String</tt></td>
- <td><tt>2.5</tt></td>
- <td><p>Specifies the location of the properties file.</p>
+
+<tr class="b">
+
+<td><b><a href="#propertiesLocation">propertiesLocation</a></b></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>2.5</tt></td>
+
+<td>
+<p>Specifies the location of the properties file.</p>
+
<p>This parameter is resolved as URL, File then resource. If
successfully resolved, the contents of the properties location is
copied into the
<tt>${project.build.directory}/checkstyle-checker.properties</tt>
file before being passed to Checkstyle for loading.</p>
+
<p>The contents of the <tt>propertiesLocation</tt> will be made
available to Checkstyle for specifying values for parameters within
the xml configuration (specified in the <tt>configLocation</tt>
parameter).</p><br /><b>User property is</b>: <tt>checkstyle.properties.location</tt>.</td>
</tr>
- <tr class="b">
- <td><b><a href="#propertyExpansion">propertyExpansion</a></b></td>
- <td><tt>String</tt></td>
- <td><tt>-</tt></td>
- <td>Allows for specifying raw property expansion information.<br /></td>
- </tr>
- <tr class="a">
- <td><b><a href="#skip">skip</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>2.2</tt></td>
- <td>Skip entire check.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>checkstyle.skip</tt>.</td>
- </tr>
- <tr class="b">
- <td><b><a href="#skipExec">skipExec</a></b></td>
- <td><tt>boolean</tt></td>
- <td><tt>2.5</tt></td>
- <td>Skip checktyle execution will only scan the outputFile.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>checkstyle.skipExec</tt>.</td>
- </tr>
- <tr class="a">
- <td><b><a href="#suppressionsFileExpression">suppressionsFileExpression</a></b></td>
- <td><tt>String</tt></td>
- <td><tt>2.1</tt></td>
- <td>The key to be used in the properties for the suppressions file.<br /><b>Default value is</b>: <tt>checkstyle.suppressions.file</tt>.<br /><b>User property is</b>: <tt>checkstyle.suppression.expression</tt>.</td>
- </tr>
- <tr class="b">
- <td><b><a href="#suppressionsLocation">suppressionsLocation</a></b></td>
- <td><tt>String</tt></td>
- <td><tt>2.0-beta-2</tt></td>
- <td><p>Specifies the location of the suppressions XML file to use.</p>
+
+<tr class="a">
+
+<td><b><a href="#propertyExpansion">propertyExpansion</a></b></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>-</tt></td>
+
+<td>Allows for specifying raw property expansion information.<br /></td>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#resourceExcludes">resourceExcludes</a></b></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>2.11</tt></td>
+
+<td>Specifies the names filter of the files to be excluded for
+Checkstyle when checking resources.<br /><b>User property is</b>: <tt>checkstyle.resourceExcludes</tt>.</td>
+ </tr>
+
+<tr class="a">
+
+<td><b><a href="#rulesFiles">rulesFiles</a></b></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>-</tt></td>
+
+<td>dump file for inlined checkstyle rules<br /><b>Default value is</b>: <tt>${project.build.directory}/checkstyle-rules.xml</tt>.<br /><b>User property is</b>: <tt>checkstyle.output.rules.file</tt>.</td>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#skip">skip</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>2.2</tt></td>
+
+<td>Skip entire check.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>checkstyle.skip</tt>.</td>
+ </tr>
+
+<tr class="a">
+
+<td><b><a href="#skipExec">skipExec</a></b></td>
+
+<td><tt>boolean</tt></td>
+
+<td><tt>2.5</tt></td>
+
+<td>Skip checktyle execution will only scan the outputFile.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>checkstyle.skipExec</tt>.</td>
+ </tr>
+
+<tr class="b">
+
+<td><b><a href="#suppressionsFileExpression">suppressionsFileExpression</a></b></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>2.1</tt></td>
+
+<td>The key to be used in the properties for the suppressions file.<br /><b>Default value is</b>: <tt>checkstyle.suppressions.file</tt>.<br /><b>User property is</b>: <tt>checkstyle.suppression.expression</tt>.</td>
+ </tr>
+
+<tr class="a">
+
+<td><b><a href="#suppressionsLocation">suppressionsLocation</a></b></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>2.0-beta-2</tt></td>
+
+<td>
+<p>Specifies the location of the suppressions XML file to use.</p>
+
<p>This parameter is resolved as resource, URL, then file. If
successfully resolved, the contents of the suppressions XML is
copied into the
<tt>${project.build.directory}/checkstyle-supressions.xml</tt>
file before being passed to Checkstyle for loading.</p>
+
<p>See <tt>suppressionsFileExpression</tt> for the property
that will be made available to your checkstyle configuration.</p><br /><b>User property is</b>: <tt>checkstyle.suppressions.location</tt>.</td>
</tr>
- <tr class="a">
- <td><b><a href="#testSourceDirectory">testSourceDirectory</a></b></td>
- <td><tt>File</tt></td>
- <td><tt>2.2</tt></td>
- <td>Specifies the location of the test source directory to be used for
+
+<tr class="b">
+
+<td><b><a href="#testSourceDirectory">testSourceDirectory</a></b></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>2.2</tt></td>
+
+<td>Specifies the location of the test source directory to be used for
Checkstyle.<br /><b>Default value is</b>: <tt>${project.build.testSourceDirectory}</tt>.<br /></td>
</tr>
- <tr class="b">
- <td><b><a href="#useFile">useFile</a></b></td>
- <td><tt>File</tt></td>
- <td><tt>-</tt></td>
- <td>If <tt>null</tt>, the Checkstyle plugin will display violations
+
+<tr class="a">
+
+<td><b><a href="#useFile">useFile</a></b></td>
+
+<td><tt>File</tt></td>
+
+<td><tt>-</tt></td>
+
+<td>If <tt>null</tt>, the Checkstyle plugin will display violations
on stdout. Otherwise, a text file will be created with the
violations.<br /></td>
</tr>
- <tr class="a">
- <td><b><a href="#violationSeverity">violationSeverity</a></b></td>
- <td><tt>String</tt></td>
- <td><tt>2.2</tt></td>
- <td>The lowest severity level that is considered a violation. Valid
+
+<tr class="b">
+
+<td><b><a href="#violationSeverity">violationSeverity</a></b></td>
+
+<td><tt>String</tt></td>
+
+<td><tt>2.2</tt></td>
+
+<td>The lowest severity level that is considered a violation. Valid
values are "error", "warning" and "info".<br /><b>Default value is</b>: <tt>error</tt>.<br /><b>User property is</b>: <tt>checkstyle.violationSeverity</tt>.</td>
</tr>
</table>
</div>
- <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
- <p><b><a name="cacheFile">cacheFile</a>:</b></p>
- <div>Specifies the cache file used to speed up Checkstyle on successive
+
+<div class="section">
+<h3>Parameter Details<a name="Parameter_Details"></a></h3>
+
+<p><b><a name="cacheFile">cacheFile</a>:</b></p>
+
+<div>Specifies the cache file used to speed up Checkstyle on successive
runs.</div>
- <ul>
- <li><b>Type</b>: <tt>java.lang.String</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Default</b>: <tt>${project.build.directory}/checkstyle-cachefile</tt></li>
- </ul><hr /><p><b><a name="configLocation">configLocation</a>:</b></p>
- <div><p>Specifies the location of the XML configuration to use.</p>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>Default</b>: <tt>${project.build.directory}/checkstyle-cachefile</tt></li>
+ </ul><hr />
+<p><b><a name="checkstyleRules">checkstyleRules</a>:</b></p>
+
+<div>By using this property, you can specify the whole checkstyle rules
+inline directly inside this pom.
+
+<div>
+<pre>
+<plugin>
+ ...
+ <configuration>
+ <checkstyleRules>
+ <module name="Checker">
+ <module name="FileTabCharacter">
+ <property name="eachLine" value="true" />
+ </module>
+ <module name="TreeWalker">
+ <module name="EmptyBlock"/>
+ </module>
+ </module>
+ </checkstyleRules>
+ </configuration>
+ ...
+</pre></div></div>
+
+<ul>
+
+<li><b>Type</b>: <tt>org.codehaus.plexus.configuration.PlexusConfiguration</tt></li>
+
+<li><b>Since</b>: <tt>2.12</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+ </ul><hr />
+<p><b><a name="configLocation">configLocation</a>:</b></p>
+
+<div>
+<p>Specifies the location of the XML configuration to use.</p>
+
<p>Potential values are a filesystem path, a URL, or a classpath
resource. This parameter expects that the contents of the location
conform to the xml format (Checkstyle <a class="externalLink" href="http://checkstyle.sourceforge.net/config.html#Modules">Checker
module</a>) configuration of rulesets.</p>
+
<p>This parameter is resolved as resource, URL, then file. If
successfully resolved, the contents of the configuration is copied
into the
<tt>${project.build.directory}/checkstyle-configuration.xml</tt>
file before being passed to Checkstyle as a configuration.</p>
+
<p>There are 4 predefined rulesets.</p>
+
<ul>
+
<li><tt>config/sun_checks.xml</tt>: Sun Checks.</li>
+
<li><tt>config/turbine_checks.xml</tt>: Turbine Checks.</li>
+
<li><tt>config/avalon_checks.xml</tt>: Avalon Checks.</li>
+
<li><tt>config/maven_checks.xml</tt>: Maven Source Checks.</li>
</ul></div>
- <ul>
- <li><b>Type</b>: <tt>java.lang.String</tt></li>
- <li><b>Since</b>: <tt>2.5</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>checkstyle.config.location</tt></li>
- <li><b>Default</b>: <tt>config/sun_checks.xml</tt></li>
- </ul><hr /><p><b><a name="consoleOutput">consoleOutput</a>:</b></p>
- <div>Output errors to console.</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /><p><b><a name="encoding">encoding</a>:</b></p>
- <div>The file encoding to use when reading the source files. If the
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>2.5</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.config.location</tt></li>
+
+<li><b>Default</b>: <tt>config/sun_checks.xml</tt></li>
+ </ul><hr />
+<p><b><a name="consoleOutput">consoleOutput</a>:</b></p>
+
+<div>Output errors to console.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.consoleOutput</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
+<p><b><a name="encoding">encoding</a>:</b></p>
+
+<div>The file encoding to use when reading the source files. If the
property <tt>project.build.sourceEncoding</tt> is not set, the
platform default encoding is used. <b>Note:</b> This
parameter always overrides the property <tt>charset</tt> from
Checkstyle's <tt>TreeWalker</tt> module.</div>
- <ul>
- <li><b>Type</b>: <tt>java.lang.String</tt></li>
- <li><b>Since</b>: <tt>2.2</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>encoding</tt></li>
- <li><b>Default</b>: <tt>${project.build.sourceEncoding}</tt></li>
- </ul><hr /><p><b><a name="excludes">excludes</a>:</b></p>
- <div>Specifies the names filter of the source files to be excluded for
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>2.2</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>encoding</tt></li>
+
+<li><b>Default</b>: <tt>${project.build.sourceEncoding}</tt></li>
+ </ul><hr />
+<p><b><a name="excludes">excludes</a>:</b></p>
+
+<div>Specifies the names filter of the source files to be excluded for
Checkstyle.</div>
- <ul>
- <li><b>Type</b>: <tt>java.lang.String</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>checkstyle.excludes</tt></li>
- </ul><hr /><p><b><a name="failOnViolation">failOnViolation</a>:</b></p>
- <div>Do we fail the build on a violation?</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>checkstyle.failOnViolation</tt></li>
- <li><b>Default</b>: <tt>true</tt></li>
- </ul><hr /><p><b><a name="failsOnError">failsOnError</a>:</b></p>
- <div>Specifies if the build should fail upon a violation.</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /><p><b><a name="headerLocation">headerLocation</a>:</b></p>
- <div><p>Specifies the location of the License file (a.k.a. the header
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.excludes</tt></li>
+ </ul><hr />
+<p><b><a name="failOnViolation">failOnViolation</a>:</b></p>
+
+<div>Fail the build on a violation. The goal checks for the violations
+after logging them (if <tt>logViolationsToConsole</tt> is
+'true'). Compare this to <tt>failsOnError</tt> which fails the
+build immediately before examining the output log.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.failOnViolation</tt></li>
+
+<li><b>Default</b>: <tt>true</tt></li>
+ </ul><hr />
+<p><b><a name="failsOnError">failsOnError</a>:</b></p>
+
+<div>If this is true, and checkstyle reported any violations or errors,
+the build fails immediately after running checkstyle, before
+checking the log for <tt>logViolationsToConsole</tt>. If you
+want to use <tt>logViolationsToConsole</tt>, use
+<tt>failOnViolation</tt> instead of this.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
+<p><b><a name="headerLocation">headerLocation</a>:</b></p>
+
+<div>
+<p>Specifies the location of the License file (a.k.a. the header
file) that can be used by Checkstyle to verify that source code has
the correct license header.</p>
+
<p>You need to use ${checkstyle.header.file} in your Checkstyle xml
configuration to reference the name of this header file.</p>
+
<p>For instance:</p>
+
<p><tt><module name="RegexpHeader"> <property
name="headerFile" value="${checkstyle.header.file}"/>
</module></tt></p></div>
- <ul>
- <li><b>Type</b>: <tt>java.lang.String</tt></li>
- <li><b>Since</b>: <tt>2.0-beta-2</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>checkstyle.header.file</tt></li>
- <li><b>Default</b>: <tt>LICENSE.txt</tt></li>
- </ul><hr /><p><b><a name="includeTestSourceDirectory">includeTestSourceDirectory</a>:</b></p>
- <div>Include or not the test source directory to be used for Checkstyle.</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Since</b>: <tt>2.2</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /><p><b><a name="includes">includes</a>:</b></p>
- <div>Specifies the names filter of the source files to be used for
-Checkstyle. <b>Note:</b> default value is
-<tt>**\/*.java</tt>.</div>
- <ul>
- <li><b>Type</b>: <tt>java.lang.String</tt></li>
- <li><b>Required</b>: <tt>Yes</tt></li>
- <li><b>User Property</b>: <tt>checkstyle.includes</tt></li>
- <li><b>Default</b>: <tt>**\/*.java</tt></li>
- </ul><hr /><p><b><a name="logViolationsToConsole">logViolationsToConsole</a>:</b></p>
- <div>Output the detected violations to the console.</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Since</b>: <tt>2.3</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>checkstyle.console</tt></li>
- <li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /><p><b><a name="maxAllowedViolations">maxAllowedViolations</a>:</b></p>
- <div>The maximum number of allowed violations. The execution fails only
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>2.0-beta-2</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.header.file</tt></li>
+
+<li><b>Default</b>: <tt>LICENSE.txt</tt></li>
+ </ul><hr />
+<p><b><a name="includeResources">includeResources</a>:</b></p>
+
+<div>Whether to apply Checkstyle to resource directories.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>2.11</tt></li>
+
+<li><b>Required</b>: <tt>Yes</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.includeResources</tt></li>
+
+<li><b>Default</b>: <tt>true</tt></li>
+ </ul><hr />
+<p><b><a name="includeTestResources">includeTestResources</a>:</b></p>
+
+<div>Whether to apply Checkstyle to test resource directories.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>2.11</tt></li>
+
+<li><b>Required</b>: <tt>Yes</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.includeTestResources</tt></li>
+
+<li><b>Default</b>: <tt>true</tt></li>
+ </ul><hr />
+<p><b><a name="includeTestSourceDirectory">includeTestSourceDirectory</a>:</b></p>
+
+<div>Include or not the test source directory to be used for Checkstyle.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>2.2</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
+<p><b><a name="includes">includes</a>:</b></p>
+
+<div>Specifies the names filter of the source files to be used for
+Checkstyle.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Required</b>: <tt>Yes</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.includes</tt></li>
+
+<li><b>Default</b>: <tt>**\/*.java</tt></li>
+ </ul><hr />
+<p><b><a name="logViolationsToConsole">logViolationsToConsole</a>:</b></p>
+
+<div>Output the detected violations to the console.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>2.3</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.console</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
+<p><b><a name="maxAllowedViolations">maxAllowedViolations</a>:</b></p>
+
+<div>The maximum number of allowed violations. The execution fails only
if the number of violations is above this limit.</div>
- <ul>
- <li><b>Type</b>: <tt>int</tt></li>
- <li><b>Since</b>: <tt>2.3</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>checkstyle.maxAllowedViolations</tt></li>
- <li><b>Default</b>: <tt>0</tt></li>
- </ul><hr /><p><b><a name="outputFile">outputFile</a>:</b></p>
- <div>Specifies the path and filename to save the Checkstyle output. The
+
+<ul>
+
+<li><b>Type</b>: <tt>int</tt></li>
+
+<li><b>Since</b>: <tt>2.3</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.maxAllowedViolations</tt></li>
+
+<li><b>Default</b>: <tt>0</tt></li>
+ </ul><hr />
+<p><b><a name="outputFile">outputFile</a>:</b></p>
+
+<div>Specifies the path and filename to save the Checkstyle output. The
format of the output file is determined by the
<tt>outputFileFormat</tt> parameter.</div>
- <ul>
- <li><b>Type</b>: <tt>java.io.File</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>checkstyle.output.file</tt></li>
- <li><b>Default</b>: <tt>${project.build.directory}/checkstyle-result.xml</tt></li>
- </ul><hr /><p><b><a name="outputFileFormat">outputFileFormat</a>:</b></p>
- <div>Specifies the format of the output to be used when writing to the
+
+<ul>
+
+<li><b>Type</b>: <tt>java.io.File</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.output.file</tt></li>
+
+<li><b>Default</b>: <tt>${project.build.directory}/checkstyle-result.xml</tt></li>
+ </ul><hr />
+<p><b><a name="outputFileFormat">outputFileFormat</a>:</b></p>
+
+<div>Specifies the format of the output to be used when writing to the
output file. Valid values are "plain" and "xml".</div>
- <ul>
- <li><b>Type</b>: <tt>java.lang.String</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>checkstyle.output.format</tt></li>
- <li><b>Default</b>: <tt>xml</tt></li>
- </ul><hr /><p><b><a name="propertiesLocation">propertiesLocation</a>:</b></p>
- <div><p>Specifies the location of the properties file.</p>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.output.format</tt></li>
+
+<li><b>Default</b>: <tt>xml</tt></li>
+ </ul><hr />
+<p><b><a name="propertiesLocation">propertiesLocation</a>:</b></p>
+
+<div>
+<p>Specifies the location of the properties file.</p>
+
<p>This parameter is resolved as URL, File then resource. If
successfully resolved, the contents of the properties location is
copied into the
<tt>${project.build.directory}/checkstyle-checker.properties</tt>
file before being passed to Checkstyle for loading.</p>
+
<p>The contents of the <tt>propertiesLocation</tt> will be made
available to Checkstyle for specifying values for parameters within
the xml configuration (specified in the <tt>configLocation</tt>
parameter).</p></div>
- <ul>
- <li><b>Type</b>: <tt>java.lang.String</tt></li>
- <li><b>Since</b>: <tt>2.5</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>checkstyle.properties.location</tt></li>
- </ul><hr /><p><b><a name="propertyExpansion">propertyExpansion</a>:</b></p>
- <div>Allows for specifying raw property expansion information.</div>
- <ul>
- <li><b>Type</b>: <tt>java.lang.String</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- </ul><hr /><p><b><a name="skip">skip</a>:</b></p>
- <div>Skip entire check.</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Since</b>: <tt>2.2</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>checkstyle.skip</tt></li>
- <li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /><p><b><a name="skipExec">skipExec</a>:</b></p>
- <div>Skip checktyle execution will only scan the outputFile.</div>
- <ul>
- <li><b>Type</b>: <tt>boolean</tt></li>
- <li><b>Since</b>: <tt>2.5</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>checkstyle.skipExec</tt></li>
- <li><b>Default</b>: <tt>false</tt></li>
- </ul><hr /><p><b><a name="sourceDirectory">sourceDirectory</a>:</b></p>
- <div>Specifies the location of the source directory to be used for
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>2.5</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.properties.location</tt></li>
+ </ul><hr />
+<p><b><a name="propertyExpansion">propertyExpansion</a>:</b></p>
+
+<div>Allows for specifying raw property expansion information.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+ </ul><hr />
+<p><b><a name="resourceExcludes">resourceExcludes</a>:</b></p>
+
+<div>Specifies the names filter of the files to be excluded for
+Checkstyle when checking resources.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>2.11</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.resourceExcludes</tt></li>
+ </ul><hr />
+<p><b><a name="resourceIncludes">resourceIncludes</a>:</b></p>
+
+<div>Specifies the names filter of the files to be used for Checkstyle
+when checking resources.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>2.11</tt></li>
+
+<li><b>Required</b>: <tt>Yes</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.resourceIncludes</tt></li>
+
+<li><b>Default</b>: <tt>**/*.properties</tt></li>
+ </ul><hr />
+<p><b><a name="rulesFiles">rulesFiles</a>:</b></p>
+
+<div>dump file for inlined checkstyle rules</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.io.File</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.output.rules.file</tt></li>
+
+<li><b>Default</b>: <tt>${project.build.directory}/checkstyle-rules.xml</tt></li>
+ </ul><hr />
+<p><b><a name="skip">skip</a>:</b></p>
+
+<div>Skip entire check.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>2.2</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.skip</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
+<p><b><a name="skipExec">skipExec</a>:</b></p>
+
+<div>Skip checktyle execution will only scan the outputFile.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>boolean</tt></li>
+
+<li><b>Since</b>: <tt>2.5</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.skipExec</tt></li>
+
+<li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr />
+<p><b><a name="sourceDirectory">sourceDirectory</a>:</b></p>
+
+<div>Specifies the location of the source directory to be used for
Checkstyle.</div>
- <ul>
- <li><b>Type</b>: <tt>java.io.File</tt></li>
- <li><b>Required</b>: <tt>Yes</tt></li>
- <li><b>Default</b>: <tt>${project.build.sourceDirectory}</tt></li>
- </ul><hr /><p><b><a name="suppressionsFileExpression">suppressionsFileExpression</a>:</b></p>
- <div>The key to be used in the properties for the suppressions file.</div>
- <ul>
- <li><b>Type</b>: <tt>java.lang.String</tt></li>
- <li><b>Since</b>: <tt>2.1</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>checkstyle.suppression.expression</tt></li>
- <li><b>Default</b>: <tt>checkstyle.suppressions.file</tt></li>
- </ul><hr /><p><b><a name="suppressionsLocation">suppressionsLocation</a>:</b></p>
- <div><p>Specifies the location of the suppressions XML file to use.</p>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.io.File</tt></li>
+
+<li><b>Required</b>: <tt>Yes</tt></li>
+
+<li><b>Default</b>: <tt>${project.build.sourceDirectory}</tt></li>
+ </ul><hr />
+<p><b><a name="suppressionsFileExpression">suppressionsFileExpression</a>:</b></p>
+
+<div>The key to be used in the properties for the suppressions file.</div>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>2.1</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.suppression.expression</tt></li>
+
+<li><b>Default</b>: <tt>checkstyle.suppressions.file</tt></li>
+ </ul><hr />
+<p><b><a name="suppressionsLocation">suppressionsLocation</a>:</b></p>
+
+<div>
+<p>Specifies the location of the suppressions XML file to use.</p>
+
<p>This parameter is resolved as resource, URL, then file. If
successfully resolved, the contents of the suppressions XML is
copied into the
<tt>${project.build.directory}/checkstyle-supressions.xml</tt>
file before being passed to Checkstyle for loading.</p>
+
<p>See <tt>suppressionsFileExpression</tt> for the property
that will be made available to your checkstyle configuration.</p></div>
- <ul>
- <li><b>Type</b>: <tt>java.lang.String</tt></li>
- <li><b>Since</b>: <tt>2.0-beta-2</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>checkstyle.suppressions.location</tt></li>
- </ul><hr /><p><b><a name="testSourceDirectory">testSourceDirectory</a>:</b></p>
- <div>Specifies the location of the test source directory to be used for
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>2.0-beta-2</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.suppressions.location</tt></li>
+ </ul><hr />
+<p><b><a name="testSourceDirectory">testSourceDirectory</a>:</b></p>
+
+<div>Specifies the location of the test source directory to be used for
Checkstyle.</div>
- <ul>
- <li><b>Type</b>: <tt>java.io.File</tt></li>
- <li><b>Since</b>: <tt>2.2</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>Default</b>: <tt>${project.build.testSourceDirectory}</tt></li>
- </ul><hr /><p><b><a name="useFile">useFile</a>:</b></p>
- <div>If <tt>null</tt>, the Checkstyle plugin will display violations
+
+<ul>
+
+<li><b>Type</b>: <tt>java.io.File</tt></li>
+
+<li><b>Since</b>: <tt>2.2</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>Default</b>: <tt>${project.build.testSourceDirectory}</tt></li>
+ </ul><hr />
+<p><b><a name="useFile">useFile</a>:</b></p>
+
+<div>If <tt>null</tt>, the Checkstyle plugin will display violations
on stdout. Otherwise, a text file will be created with the
violations.</div>
- <ul>
- <li><b>Type</b>: <tt>java.io.File</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- </ul><hr /><p><b><a name="violationSeverity">violationSeverity</a>:</b></p>
- <div>The lowest severity level that is considered a violation. Valid
+
+<ul>
+
+<li><b>Type</b>: <tt>java.io.File</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+ </ul><hr />
+<p><b><a name="violationSeverity">violationSeverity</a>:</b></p>
+
+<div>The lowest severity level that is considered a violation. Valid
values are "error", "warning" and "info".</div>
- <ul>
- <li><b>Type</b>: <tt>java.lang.String</tt></li>
- <li><b>Since</b>: <tt>2.2</tt></li>
- <li><b>Required</b>: <tt>No</tt></li>
- <li><b>User Property</b>: <tt>checkstyle.violationSeverity</tt></li>
- <li><b>Default</b>: <tt>error</tt></li>
+
+<ul>
+
+<li><b>Type</b>: <tt>java.lang.String</tt></li>
+
+<li><b>Since</b>: <tt>2.2</tt></li>
+
+<li><b>Required</b>: <tt>No</tt></li>
+
+<li><b>User Property</b>: <tt>checkstyle.violationSeverity</tt></li>
+
+<li><b>Default</b>: <tt>error</tt></li>
</ul>
</div>
</div>
@@ -644,7 +1213,7 @@ values are "error", "warn
</div>
<div id="footer">
<div class="xright">
- © 2005-2013
+ © 2005-2014
The Apache Software Foundation
- <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.