Modified: maven/website/components/plugins-archives/maven-checkstyle-plugin-LATEST/xref/org/apache/maven/plugins/checkstyle/CheckstyleViolationCheckMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-checkstyle-plugin-LATEST/xref/org/apache/maven/plugins/checkstyle/CheckstyleViolationCheckMojo.html (original) +++ maven/website/components/plugins-archives/maven-checkstyle-plugin-LATEST/xref/org/apache/maven/plugins/checkstyle/CheckstyleViolationCheckMojo.html Sat Feb 8 08:48:21 2020 @@ -79,7 +79,7 @@ <a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * It can also be configured to re-use an earlier analysis.</em> <a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> *</em> <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:joa...@erdfelt.net"; target="alexandria_uri">mailto:joa...@erdfelt.net</a>">Joakim Erdfelt</a></em> -<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * @version $Id$</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> *</em> <a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> */</em> <a class="jxr_linenumber" name="L76" href="#L76">76</a> @Mojo( name = <span class="jxr_string">"check"</span>, defaultPhase = LifecyclePhase.VERIFY, requiresDependencyResolution = ResolutionScope.NONE, <a class="jxr_linenumber" name="L77" href="#L77">77</a> threadSafe = <strong class="jxr_keyword">true</strong> ) @@ -164,723 +164,739 @@ <a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> */</em> <a class="jxr_linenumber" name="L157" href="#L157">157</a> @Parameter( property = <span class="jxr_string">"checkstyle.console"</span>, defaultValue = <span class="jxr_string">"true"</span> ) <a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> logViolationsToConsole; -<a class="jxr_linenumber" name="L159" href="#L159">159</a> +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * Specifies the location of the resources to be used for Checkstyle.</em> -<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * @since 2.11</em> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * Output the detected violation count to the console.</em> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * </em> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * @since 3.0.1</em> <a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L165" href="#L165">165</a> @Parameter( defaultValue = <span class="jxr_string">"${project.resources}"</span>, readonly = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">protected</strong> List<Resource> resources; -<a class="jxr_linenumber" name="L167" href="#L167">167</a> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> @Parameter( property = <span class="jxr_string">"checkstyle.logViolationCount"</span>, defaultValue = <span class="jxr_string">"true"</span> ) +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> logViolationCountToConsole; +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * Specifies the location of the test resources to be used for Checkstyle.</em> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * Specifies the location of the resources to be used for Checkstyle.</em> <a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * @since 2.16</em> +<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * @since 2.11</em> <a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L173" href="#L173">173</a> @Parameter( defaultValue = <span class="jxr_string">"${project.testResources}"</span>, readonly = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">protected</strong> List<Resource> testResources; -<a class="jxr_linenumber" name="L175" href="#L175">175</a> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> @Parameter( defaultValue = <span class="jxr_string">"${project.resources}"</span>, readonly = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">protected</strong> List<Resource> resources; +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * Specifies the location of the XML configuration to use.</em> -<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * Potential values are a filesystem path, a URL, or a classpath resource.</em> -<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * This parameter expects that the contents of the location conform to the</em> -<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * xml format (Checkstyle <a</em> -<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * href="<a href="http://checkstyle.sourceforge.net/config.html"; target="alexandria_uri">http://checkstyle.sourceforge.net/config.html</a>#Modules">Checker</em> -<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * module</a>) configuration of rulesets.</em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * Specifies the location of the test resources to be used for Checkstyle.</em> +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * @since 2.16</em> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L181" href="#L181">181</a> @Parameter( defaultValue = <span class="jxr_string">"${project.testResources}"</span>, readonly = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">protected</strong> List<Resource> testResources; +<a class="jxr_linenumber" name="L183" href="#L183">183</a> +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment">/**</em> <a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * This parameter is resolved as resource, URL, then file. If successfully</em> -<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * resolved, the contents of the configuration is copied into the</em> -<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * <code>${project.build.directory}/checkstyle-configuration.xml</code></em> -<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * file before being passed to Checkstyle as a configuration.</em> -<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * There are 2 predefined rulesets.</em> -<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * <ul></em> -<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * <li><code>sun_checks.xml</code>: Sun Checks.</li></em> -<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * <li><code>google_checks.xml</code>: Google Checks.</li></em> -<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * </ul></em> -<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * @since 2.5</em> -<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L199" href="#L199">199</a> @Parameter( property = <span class="jxr_string">"checkstyle.config.location"</span>, defaultValue = DEFAULT_CONFIG_LOCATION ) -<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">private</strong> String configLocation; -<a class="jxr_linenumber" name="L201" href="#L201">201</a> -<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * Specifies the location of the properties file.</em> -<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * This parameter is resolved as URL, File then resource. If successfully</em> -<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * resolved, the contents of the properties location is copied into the</em> -<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> * <code>${project.build.directory}/checkstyle-checker.properties</code></em> -<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> * file before being passed to Checkstyle for loading.</em> -<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * The contents of the <code>propertiesLocation</code> will be made</em> -<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> * available to Checkstyle for specifying values for parameters within the</em> -<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * xml configuration (specified in the <code>configLocation</code></em> -<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * parameter).</em> -<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * @since 2.5</em> -<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L218" href="#L218">218</a> @Parameter( property = <span class="jxr_string">"checkstyle.properties.location"</span> ) -<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">private</strong> String propertiesLocation; -<a class="jxr_linenumber" name="L220" href="#L220">220</a> -<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> * Allows for specifying raw property expansion information.</em> -<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L224" href="#L224">224</a> @Parameter -<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">private</strong> String propertyExpansion; -<a class="jxr_linenumber" name="L226" href="#L226">226</a> -<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> * Specifies the location of the License file (a.k.a. the header file) that</em> -<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> * can be used by Checkstyle to verify that source code has the correct</em> -<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> * license header.</em> -<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> * You need to use <code>${checkstyle.header.file}</code> in your Checkstyle xml</em> -<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> * configuration to reference the name of this header file.</em> -<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> * For instance:</em> -<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> * <pre></em> -<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * &lt;module name="RegexpHeader"&gt;</em> -<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> * &lt;property name="headerFile" value="${checkstyle.header.file}"/&gt;</em> -<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> * &lt;/module&gt;</em> -<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> * </pre></em> -<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment"> * @since 2.0-beta-2</em> -<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L245" href="#L245">245</a> @Parameter( property = <span class="jxr_string">"checkstyle.header.file"</span>, defaultValue = <span class="jxr_string">"LICENSE.txt"</span> ) -<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">private</strong> String headerLocation; -<a class="jxr_linenumber" name="L247" href="#L247">247</a> -<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> * Specifies the cache file used to speed up Checkstyle on successive runs.</em> -<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L251" href="#L251">251</a> @Parameter( defaultValue = <span class="jxr_string">"${project.build.directory}/checkstyle-cachefile"</span> ) -<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">private</strong> String cacheFile; -<a class="jxr_linenumber" name="L253" href="#L253">253</a> -<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * The key to be used in the properties for the suppressions file.</em> -<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * @since 2.1</em> +<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * Specifies the location of the XML configuration to use.</em> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * Potential values are a filesystem path, a URL, or a classpath resource.</em> +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * This parameter expects that the contents of the location conform to the</em> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * xml format (Checkstyle <a</em> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * href="<a href="http://checkstyle.sourceforge.net/config.html"; target="alexandria_uri">http://checkstyle.sourceforge.net/config.html</a>#Modules">Checker</em> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * module</a>) configuration of rulesets.</em> +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * This parameter is resolved as resource, URL, then file. If successfully</em> +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * resolved, the contents of the configuration is copied into the</em> +<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * <code>${project.build.directory}/checkstyle-configuration.xml</code></em> +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * file before being passed to Checkstyle as a configuration.</em> +<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * There are 2 predefined rulesets.</em> +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> * <li><code>sun_checks.xml</code>: Sun Checks.</li></em> +<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * <li><code>google_checks.xml</code>: Google Checks.</li></em> +<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> * @since 2.5</em> +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L207" href="#L207">207</a> @Parameter( property = <span class="jxr_string">"checkstyle.config.location"</span>, defaultValue = DEFAULT_CONFIG_LOCATION ) +<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">private</strong> String configLocation; +<a class="jxr_linenumber" name="L209" href="#L209">209</a> +<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> * Specifies the location of the properties file.</em> +<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * This parameter is resolved as URL, File then resource. If successfully</em> +<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * resolved, the contents of the properties location is copied into the</em> +<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * <code>${project.build.directory}/checkstyle-checker.properties</code></em> +<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * file before being passed to Checkstyle for loading.</em> +<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> * The contents of the <code>propertiesLocation</code> will be made</em> +<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * available to Checkstyle for specifying values for parameters within the</em> +<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> * xml configuration (specified in the <code>configLocation</code></em> +<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> * parameter).</em> +<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> * @since 2.5</em> +<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L226" href="#L226">226</a> @Parameter( property = <span class="jxr_string">"checkstyle.properties.location"</span> ) +<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">private</strong> String propertiesLocation; +<a class="jxr_linenumber" name="L228" href="#L228">228</a> +<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> * Allows for specifying raw property expansion information.</em> +<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L232" href="#L232">232</a> @Parameter +<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">private</strong> String propertyExpansion; +<a class="jxr_linenumber" name="L234" href="#L234">234</a> +<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> * Specifies the location of the License file (a.k.a. the header file) that</em> +<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * can be used by Checkstyle to verify that source code has the correct</em> +<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> * license header.</em> +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> * You need to use <code>${checkstyle.header.file}</code> in your Checkstyle xml</em> +<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> * configuration to reference the name of this header file.</em> +<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> * For instance:</em> +<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> * <pre></em> +<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> * &lt;module name="RegexpHeader"&gt;</em> +<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> * &lt;property name="headerFile" value="${checkstyle.header.file}"/&gt;</em> +<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> * &lt;/module&gt;</em> +<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> * </pre></em> +<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> * @since 2.0-beta-2</em> +<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L253" href="#L253">253</a> @Parameter( property = <span class="jxr_string">"checkstyle.header.file"</span>, defaultValue = <span class="jxr_string">"LICENSE.txt"</span> ) +<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">private</strong> String headerLocation; +<a class="jxr_linenumber" name="L255" href="#L255">255</a> +<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * Specifies the cache file used to speed up Checkstyle on successive runs.</em> <a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L259" href="#L259">259</a> @Parameter( property = <span class="jxr_string">"checkstyle.suppression.expression"</span>, defaultValue = <span class="jxr_string">"checkstyle.suppressions.file"</span> ) -<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">private</strong> String suppressionsFileExpression; +<a class="jxr_linenumber" name="L259" href="#L259">259</a> @Parameter( defaultValue = <span class="jxr_string">"${project.build.directory}/checkstyle-cachefile"</span> ) +<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">private</strong> String cacheFile; <a class="jxr_linenumber" name="L261" href="#L261">261</a> <a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> * Specifies the location of the suppressions XML file to use.</em> -<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> * This parameter is resolved as resource, URL, then file. If successfully</em> -<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> * resolved, the contents of the suppressions XML is copied into the</em> -<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * <code>${project.build.directory}/checkstyle-suppressions.xml</code> file</em> -<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * before being passed to Checkstyle for loading.</em> -<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> * See <code>suppressionsFileExpression</code> for the property that will</em> -<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> * be made available to your Checkstyle configuration.</em> -<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> * @since 2.0-beta-2</em> -<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L276" href="#L276">276</a> @Parameter( property = <span class="jxr_string">"checkstyle.suppressions.location"</span> ) -<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">private</strong> String suppressionsLocation; -<a class="jxr_linenumber" name="L278" href="#L278">278</a> -<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment"> * The file encoding to use when reading the source files. If the property <code>project.build.sourceEncoding</code></em> -<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_javadoccomment"> * is not set, the platform default encoding is used. <strong>Note:</strong> This parameter always overrides the</em> -<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment"> * property <code>charset</code> from Checkstyle's <code>TreeWalker</code> module.</em> -<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> * @since 2.2</em> -<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L286" href="#L286">286</a> @Parameter( property = <span class="jxr_string">"encoding"</span>, defaultValue = <span class="jxr_string">"${project.build.sourceEncoding}"</span> ) -<a class="jxr_linenumber" name="L287" href="#L287">287</a> <strong class="jxr_keyword">private</strong> String encoding; -<a class="jxr_linenumber" name="L288" href="#L288">288</a> -<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> * @since 2.5</em> -<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L292" href="#L292">292</a> @Component( role = CheckstyleExecutor.<strong class="jxr_keyword">class</strong>, hint = <span class="jxr_string">"default"</span> ) -<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/maven/plugins/checkstyle/exec/CheckstyleExecutor.html">CheckstyleExecutor</a> checkstyleExecutor; -<a class="jxr_linenumber" name="L294" href="#L294">294</a> -<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment"> * Output errors to console.</em> -<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L298" href="#L298">298</a> @Parameter( property = <span class="jxr_string">"checkstyle.consoleOutput"</span>, defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L299" href="#L299">299</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> consoleOutput; -<a class="jxr_linenumber" name="L300" href="#L300">300</a> -<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> * The Maven Project Object.</em> -<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L304" href="#L304">304</a> @Parameter ( defaultValue = <span class="jxr_string">"${project}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">protected</strong> MavenProject project; -<a class="jxr_linenumber" name="L306" href="#L306">306</a> -<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment"> * The Plugin Descriptor</em> -<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L310" href="#L310">310</a> @Parameter( defaultValue = <span class="jxr_string">"${plugin}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L311" href="#L311">311</a> <strong class="jxr_keyword">private</strong> PluginDescriptor plugin; -<a class="jxr_linenumber" name="L312" href="#L312">312</a> -<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment"> * If <code>null</code>, the Checkstyle plugin will display violations on stdout.</em> -<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment"> * Otherwise, a text file will be created with the violations.</em> -<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L317" href="#L317">317</a> @Parameter -<a class="jxr_linenumber" name="L318" href="#L318">318</a> <strong class="jxr_keyword">private</strong> File useFile; -<a class="jxr_linenumber" name="L319" href="#L319">319</a> -<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> * Specifies the names filter of the source files to be excluded for</em> -<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> * Checkstyle.</em> -<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L324" href="#L324">324</a> @Parameter( property = <span class="jxr_string">"checkstyle.excludes"</span> ) -<a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong class="jxr_keyword">private</strong> String excludes; -<a class="jxr_linenumber" name="L326" href="#L326">326</a> -<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> * Specifies the names filter of the source files to be used for Checkstyle.</em> -<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L330" href="#L330">330</a> @Parameter( property = <span class="jxr_string">"checkstyle.includes"</span>, defaultValue = JAVA_FILES, required = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">private</strong> String includes; -<a class="jxr_linenumber" name="L332" href="#L332">332</a> -<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> * Specifies the names filter of the files to be excluded for</em> -<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> * Checkstyle when checking resources.</em> -<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> * @since 2.11</em> +<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> * The key to be used in the properties for the suppressions file.</em> +<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> * @since 2.1</em> +<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L267" href="#L267">267</a> @Parameter( property = <span class="jxr_string">"checkstyle.suppression.expression"</span>, defaultValue = <span class="jxr_string">"checkstyle.suppressions.file"</span> ) +<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">private</strong> String suppressionsFileExpression; +<a class="jxr_linenumber" name="L269" href="#L269">269</a> +<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> * Specifies the location of the suppressions XML file to use.</em> +<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> * This parameter is resolved as resource, URL, then file. If successfully</em> +<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment"> * resolved, the contents of the suppressions XML is copied into the</em> +<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment"> * <code>${project.build.directory}/checkstyle-suppressions.xml</code> file</em> +<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment"> * before being passed to Checkstyle for loading.</em> +<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> * See <code>suppressionsFileExpression</code> for the property that will</em> +<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment"> * be made available to your Checkstyle configuration.</em> +<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment"> * @since 2.0-beta-2</em> +<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L284" href="#L284">284</a> @Parameter( property = <span class="jxr_string">"checkstyle.suppressions.location"</span> ) +<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">private</strong> String suppressionsLocation; +<a class="jxr_linenumber" name="L286" href="#L286">286</a> +<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> * The file encoding to use when reading the source files. If the property <code>project.build.sourceEncoding</code></em> +<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> * is not set, the platform default encoding is used. <strong>Note:</strong> This parameter always overrides the</em> +<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> * property <code>charset</code> from Checkstyle's <code>TreeWalker</code> module.</em> +<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment"> * @since 2.2</em> +<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L294" href="#L294">294</a> @Parameter( property = <span class="jxr_string">"encoding"</span>, defaultValue = <span class="jxr_string">"${project.build.sourceEncoding}"</span> ) +<a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">private</strong> String encoding; +<a class="jxr_linenumber" name="L296" href="#L296">296</a> +<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> * @since 2.5</em> +<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L300" href="#L300">300</a> @Component( role = CheckstyleExecutor.<strong class="jxr_keyword">class</strong>, hint = <span class="jxr_string">"default"</span> ) +<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/maven/plugins/checkstyle/exec/CheckstyleExecutor.html">CheckstyleExecutor</a> checkstyleExecutor; +<a class="jxr_linenumber" name="L302" href="#L302">302</a> +<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> * Output errors to console.</em> +<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L306" href="#L306">306</a> @Parameter( property = <span class="jxr_string">"checkstyle.consoleOutput"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L307" href="#L307">307</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> consoleOutput; +<a class="jxr_linenumber" name="L308" href="#L308">308</a> +<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment"> * The Maven Project Object.</em> +<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L312" href="#L312">312</a> @Parameter ( defaultValue = <span class="jxr_string">"${project}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">protected</strong> MavenProject project; +<a class="jxr_linenumber" name="L314" href="#L314">314</a> +<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> * The Plugin Descriptor</em> +<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L318" href="#L318">318</a> @Parameter( defaultValue = <span class="jxr_string">"${plugin}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L319" href="#L319">319</a> <strong class="jxr_keyword">private</strong> PluginDescriptor plugin; +<a class="jxr_linenumber" name="L320" href="#L320">320</a> +<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> * If <code>null</code>, the Checkstyle plugin will display violations on stdout.</em> +<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment"> * Otherwise, a text file will be created with the violations.</em> +<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L325" href="#L325">325</a> @Parameter +<a class="jxr_linenumber" name="L326" href="#L326">326</a> <strong class="jxr_keyword">private</strong> File useFile; +<a class="jxr_linenumber" name="L327" href="#L327">327</a> +<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> * Specifies the names filter of the source files to be excluded for</em> +<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * Checkstyle.</em> +<a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L332" href="#L332">332</a> @Parameter( property = <span class="jxr_string">"checkstyle.excludes"</span> ) +<a class="jxr_linenumber" name="L333" href="#L333">333</a> <strong class="jxr_keyword">private</strong> String excludes; +<a class="jxr_linenumber" name="L334" href="#L334">334</a> +<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> * Specifies the names filter of the source files to be used for Checkstyle.</em> <a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L338" href="#L338">338</a> @Parameter( property = <span class="jxr_string">"checkstyle.resourceExcludes"</span> ) -<a class="jxr_linenumber" name="L339" href="#L339">339</a> <strong class="jxr_keyword">private</strong> String resourceExcludes; +<a class="jxr_linenumber" name="L338" href="#L338">338</a> @Parameter( property = <span class="jxr_string">"checkstyle.includes"</span>, defaultValue = JAVA_FILES, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L339" href="#L339">339</a> <strong class="jxr_keyword">private</strong> String includes; <a class="jxr_linenumber" name="L340" href="#L340">340</a> <a class="jxr_linenumber" name="L341" href="#L341">341</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L342" href="#L342">342</a> <em class="jxr_javadoccomment"> * Specifies the names filter of the files to be used for Checkstyle when checking resources.</em> -<a class="jxr_linenumber" name="L343" href="#L343">343</a> <em class="jxr_javadoccomment"> * @since 2.11</em> -<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L345" href="#L345">345</a> @Parameter( property = <span class="jxr_string">"checkstyle.resourceIncludes"</span>, defaultValue = <span class="jxr_string">"**/*.properties"</span>, required = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L346" href="#L346">346</a> <strong class="jxr_keyword">private</strong> String resourceIncludes; -<a class="jxr_linenumber" name="L347" href="#L347">347</a> -<a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_javadoccomment"> * If this is true, and Checkstyle reported any violations or errors,</em> -<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_javadoccomment"> * the build fails immediately after running Checkstyle, before checking the log</em> -<a class="jxr_linenumber" name="L351" href="#L351">351</a> <em class="jxr_javadoccomment"> * for {@link #logViolationsToConsole}. If you want to use {@link #logViolationsToConsole},</em> -<a class="jxr_linenumber" name="L352" href="#L352">352</a> <em class="jxr_javadoccomment"> * use {@link #failOnViolation} instead of this.</em> -<a class="jxr_linenumber" name="L353" href="#L353">353</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L354" href="#L354">354</a> @Parameter( defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L355" href="#L355">355</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> failsOnError; -<a class="jxr_linenumber" name="L356" href="#L356">356</a> -<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L358" href="#L358">358</a> <em class="jxr_javadoccomment"> * Specifies the location of the test source directory to be used for Checkstyle.</em> -<a class="jxr_linenumber" name="L359" href="#L359">359</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L360" href="#L360">360</a> <em class="jxr_javadoccomment"> * @since 2.2</em> -<a class="jxr_linenumber" name="L361" href="#L361">361</a> <em class="jxr_javadoccomment"> * @deprecated instead use {@link #testSourceDirectories}. For version 3.0.0, this parameter is only defined to</em> -<a class="jxr_linenumber" name="L362" href="#L362">362</a> <em class="jxr_javadoccomment"> * break the build if you use it!</em> -<a class="jxr_linenumber" name="L363" href="#L363">363</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L364" href="#L364">364</a> @Deprecated -<a class="jxr_linenumber" name="L365" href="#L365">365</a> @Parameter -<a class="jxr_linenumber" name="L366" href="#L366">366</a> <strong class="jxr_keyword">private</strong> File testSourceDirectory; -<a class="jxr_linenumber" name="L367" href="#L367">367</a> -<a class="jxr_linenumber" name="L368" href="#L368">368</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment"> * Specifies the location of the test source directories to be used for Checkstyle.</em> -<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment"> * Default value is <code>${project.testCompileSourceRoots}</code>.</em> -<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment"> * @since 2.13</em> -<a class="jxr_linenumber" name="L372" href="#L372">372</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L373" href="#L373">373</a> <em class="jxr_comment">// Compatibility with all Maven 3: default of 'project.testCompileSourceRoots' is done manually because of MNG-5440</em> -<a class="jxr_linenumber" name="L374" href="#L374">374</a> @Parameter -<a class="jxr_linenumber" name="L375" href="#L375">375</a> <strong class="jxr_keyword">private</strong> List<String> testSourceDirectories; -<a class="jxr_linenumber" name="L376" href="#L376">376</a> -<a class="jxr_linenumber" name="L377" href="#L377">377</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L378" href="#L378">378</a> <em class="jxr_javadoccomment"> * Include or not the test source directory to be used for Checkstyle.</em> -<a class="jxr_linenumber" name="L379" href="#L379">379</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L380" href="#L380">380</a> <em class="jxr_javadoccomment"> * @since 2.2</em> -<a class="jxr_linenumber" name="L381" href="#L381">381</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L382" href="#L382">382</a> @Parameter( defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L383" href="#L383">383</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> includeTestSourceDirectory; +<a class="jxr_linenumber" name="L342" href="#L342">342</a> <em class="jxr_javadoccomment"> * Specifies the names filter of the files to be excluded for</em> +<a class="jxr_linenumber" name="L343" href="#L343">343</a> <em class="jxr_javadoccomment"> * Checkstyle when checking resources.</em> +<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_javadoccomment"> * @since 2.11</em> +<a class="jxr_linenumber" name="L345" href="#L345">345</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L346" href="#L346">346</a> @Parameter( property = <span class="jxr_string">"checkstyle.resourceExcludes"</span> ) +<a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong class="jxr_keyword">private</strong> String resourceExcludes; +<a class="jxr_linenumber" name="L348" href="#L348">348</a> +<a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_javadoccomment"> * Specifies the names filter of the files to be used for Checkstyle when checking resources.</em> +<a class="jxr_linenumber" name="L351" href="#L351">351</a> <em class="jxr_javadoccomment"> * @since 2.11</em> +<a class="jxr_linenumber" name="L352" href="#L352">352</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L353" href="#L353">353</a> @Parameter( property = <span class="jxr_string">"checkstyle.resourceIncludes"</span>, defaultValue = <span class="jxr_string">"**/*.properties"</span>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">private</strong> String resourceIncludes; +<a class="jxr_linenumber" name="L355" href="#L355">355</a> +<a class="jxr_linenumber" name="L356" href="#L356">356</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em class="jxr_javadoccomment"> * If this is true, and Checkstyle reported any violations or errors,</em> +<a class="jxr_linenumber" name="L358" href="#L358">358</a> <em class="jxr_javadoccomment"> * the build fails immediately after running Checkstyle, before checking the log</em> +<a class="jxr_linenumber" name="L359" href="#L359">359</a> <em class="jxr_javadoccomment"> * for {@link #logViolationsToConsole}. If you want to use {@link #logViolationsToConsole},</em> +<a class="jxr_linenumber" name="L360" href="#L360">360</a> <em class="jxr_javadoccomment"> * use {@link #failOnViolation} instead of this.</em> +<a class="jxr_linenumber" name="L361" href="#L361">361</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L362" href="#L362">362</a> @Parameter( defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L363" href="#L363">363</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> failsOnError; +<a class="jxr_linenumber" name="L364" href="#L364">364</a> +<a class="jxr_linenumber" name="L365" href="#L365">365</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L366" href="#L366">366</a> <em class="jxr_javadoccomment"> * Specifies the location of the test source directory to be used for Checkstyle.</em> +<a class="jxr_linenumber" name="L367" href="#L367">367</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L368" href="#L368">368</a> <em class="jxr_javadoccomment"> * @since 2.2</em> +<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment"> * @deprecated instead use {@link #testSourceDirectories}. For version 3.0.0, this parameter is only defined to</em> +<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment"> * break the build if you use it!</em> +<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L372" href="#L372">372</a> @Deprecated +<a class="jxr_linenumber" name="L373" href="#L373">373</a> @Parameter +<a class="jxr_linenumber" name="L374" href="#L374">374</a> <strong class="jxr_keyword">private</strong> File testSourceDirectory; +<a class="jxr_linenumber" name="L375" href="#L375">375</a> +<a class="jxr_linenumber" name="L376" href="#L376">376</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L377" href="#L377">377</a> <em class="jxr_javadoccomment"> * Specifies the location of the test source directories to be used for Checkstyle.</em> +<a class="jxr_linenumber" name="L378" href="#L378">378</a> <em class="jxr_javadoccomment"> * Default value is <code>${project.testCompileSourceRoots}</code>.</em> +<a class="jxr_linenumber" name="L379" href="#L379">379</a> <em class="jxr_javadoccomment"> * @since 2.13</em> +<a class="jxr_linenumber" name="L380" href="#L380">380</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L381" href="#L381">381</a> <em class="jxr_comment">// Compatibility with all Maven 3: default of 'project.testCompileSourceRoots' is done manually because of MNG-5440</em> +<a class="jxr_linenumber" name="L382" href="#L382">382</a> @Parameter +<a class="jxr_linenumber" name="L383" href="#L383">383</a> <strong class="jxr_keyword">private</strong> List<String> testSourceDirectories; <a class="jxr_linenumber" name="L384" href="#L384">384</a> <a class="jxr_linenumber" name="L385" href="#L385">385</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_javadoccomment"> * Specifies the location of the source directory to be used for Checkstyle.</em> -<a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_javadoccomment"> * </em> -<a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_javadoccomment"> * @deprecated instead use {@link #sourceDirectories}. For version 3.0.0, this parameter is only defined to break</em> -<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment"> * the build if you use it!</em> -<a class="jxr_linenumber" name="L390" href="#L390">390</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L391" href="#L391">391</a> @Deprecated -<a class="jxr_linenumber" name="L392" href="#L392">392</a> @Parameter -<a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong class="jxr_keyword">private</strong> File sourceDirectory; -<a class="jxr_linenumber" name="L394" href="#L394">394</a> -<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L396" href="#L396">396</a> <em class="jxr_javadoccomment"> * Specifies the location of the source directories to be used for Checkstyle.</em> -<a class="jxr_linenumber" name="L397" href="#L397">397</a> <em class="jxr_javadoccomment"> * Default value is <code>${project.compileSourceRoots}</code>.</em> -<a class="jxr_linenumber" name="L398" href="#L398">398</a> <em class="jxr_javadoccomment"> * @since 2.13</em> -<a class="jxr_linenumber" name="L399" href="#L399">399</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L400" href="#L400">400</a> <em class="jxr_comment">// Compatibility with all Maven 3: default of 'project.compileSourceRoots' is done manually because of MNG-5440</em> -<a class="jxr_linenumber" name="L401" href="#L401">401</a> @Parameter -<a class="jxr_linenumber" name="L402" href="#L402">402</a> <strong class="jxr_keyword">private</strong> List<String> sourceDirectories; -<a class="jxr_linenumber" name="L403" href="#L403">403</a> -<a class="jxr_linenumber" name="L404" href="#L404">404</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_javadoccomment"> * Whether to apply Checkstyle to resource directories.</em> -<a class="jxr_linenumber" name="L406" href="#L406">406</a> <em class="jxr_javadoccomment"> * @since 2.11</em> +<a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_javadoccomment"> * Include or not the test source directory to be used for Checkstyle.</em> +<a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_javadoccomment"> * @since 2.2</em> +<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L390" href="#L390">390</a> @Parameter( defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L391" href="#L391">391</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> includeTestSourceDirectory; +<a class="jxr_linenumber" name="L392" href="#L392">392</a> +<a class="jxr_linenumber" name="L393" href="#L393">393</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L394" href="#L394">394</a> <em class="jxr_javadoccomment"> * Specifies the location of the source directory to be used for Checkstyle.</em> +<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_javadoccomment"> * </em> +<a class="jxr_linenumber" name="L396" href="#L396">396</a> <em class="jxr_javadoccomment"> * @deprecated instead use {@link #sourceDirectories}. For version 3.0.0, this parameter is only defined to break</em> +<a class="jxr_linenumber" name="L397" href="#L397">397</a> <em class="jxr_javadoccomment"> * the build if you use it!</em> +<a class="jxr_linenumber" name="L398" href="#L398">398</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L399" href="#L399">399</a> @Deprecated +<a class="jxr_linenumber" name="L400" href="#L400">400</a> @Parameter +<a class="jxr_linenumber" name="L401" href="#L401">401</a> <strong class="jxr_keyword">private</strong> File sourceDirectory; +<a class="jxr_linenumber" name="L402" href="#L402">402</a> +<a class="jxr_linenumber" name="L403" href="#L403">403</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L404" href="#L404">404</a> <em class="jxr_javadoccomment"> * Specifies the location of the source directories to be used for Checkstyle.</em> +<a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_javadoccomment"> * Default value is <code>${project.compileSourceRoots}</code>.</em> +<a class="jxr_linenumber" name="L406" href="#L406">406</a> <em class="jxr_javadoccomment"> * @since 2.13</em> <a class="jxr_linenumber" name="L407" href="#L407">407</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L408" href="#L408">408</a> @Parameter( property = <span class="jxr_string">"checkstyle.includeResources"</span>, defaultValue = <span class="jxr_string">"true"</span>, required = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L409" href="#L409">409</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> includeResources = <strong class="jxr_keyword">true</strong>; -<a class="jxr_linenumber" name="L410" href="#L410">410</a> -<a class="jxr_linenumber" name="L411" href="#L411">411</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L412" href="#L412">412</a> <em class="jxr_javadoccomment"> * Whether to apply Checkstyle to test resource directories.</em> -<a class="jxr_linenumber" name="L413" href="#L413">413</a> <em class="jxr_javadoccomment"> * @since 2.11</em> -<a class="jxr_linenumber" name="L414" href="#L414">414</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L415" href="#L415">415</a> @Parameter( property = <span class="jxr_string">"checkstyle.includeTestResources"</span>, defaultValue = <span class="jxr_string">"true"</span>, required = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L416" href="#L416">416</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> includeTestResources = <strong class="jxr_keyword">true</strong>; -<a class="jxr_linenumber" name="L417" href="#L417">417</a> -<a class="jxr_linenumber" name="L418" href="#L418">418</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L419" href="#L419">419</a> <em class="jxr_javadoccomment"> * By using this property, you can specify the whole Checkstyle rules</em> -<a class="jxr_linenumber" name="L420" href="#L420">420</a> <em class="jxr_javadoccomment"> * inline directly inside this pom.</em> -<a class="jxr_linenumber" name="L421" href="#L421">421</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L422" href="#L422">422</a> <em class="jxr_javadoccomment"> * <pre></em> -<a class="jxr_linenumber" name="L423" href="#L423">423</a> <em class="jxr_javadoccomment"> * &lt;plugin&gt;</em> -<a class="jxr_linenumber" name="L424" href="#L424">424</a> <em class="jxr_javadoccomment"> * ...</em> -<a class="jxr_linenumber" name="L425" href="#L425">425</a> <em class="jxr_javadoccomment"> * &lt;configuration&gt;</em> -<a class="jxr_linenumber" name="L426" href="#L426">426</a> <em class="jxr_javadoccomment"> * &lt;checkstyleRules&gt;</em> -<a class="jxr_linenumber" name="L427" href="#L427">427</a> <em class="jxr_javadoccomment"> * &lt;module name="Checker"&gt;</em> -<a class="jxr_linenumber" name="L428" href="#L428">428</a> <em class="jxr_javadoccomment"> * &lt;module name="FileTabCharacter"&gt;</em> -<a class="jxr_linenumber" name="L429" href="#L429">429</a> <em class="jxr_javadoccomment"> * &lt;property name="eachLine" value="true" /&gt;</em> -<a class="jxr_linenumber" name="L430" href="#L430">430</a> <em class="jxr_javadoccomment"> * &lt;/module&gt;</em> -<a class="jxr_linenumber" name="L431" href="#L431">431</a> <em class="jxr_javadoccomment"> * &lt;module name="TreeWalker"&gt;</em> -<a class="jxr_linenumber" name="L432" href="#L432">432</a> <em class="jxr_javadoccomment"> * &lt;module name="EmptyBlock"/&gt;</em> -<a class="jxr_linenumber" name="L433" href="#L433">433</a> <em class="jxr_javadoccomment"> * &lt;/module&gt;</em> -<a class="jxr_linenumber" name="L434" href="#L434">434</a> <em class="jxr_javadoccomment"> * &lt;/module&gt;</em> -<a class="jxr_linenumber" name="L435" href="#L435">435</a> <em class="jxr_javadoccomment"> * &lt;/checkstyleRules&gt;</em> -<a class="jxr_linenumber" name="L436" href="#L436">436</a> <em class="jxr_javadoccomment"> * &lt;/configuration&gt;</em> -<a class="jxr_linenumber" name="L437" href="#L437">437</a> <em class="jxr_javadoccomment"> * ...</em> -<a class="jxr_linenumber" name="L438" href="#L438">438</a> <em class="jxr_javadoccomment"> * </pre></em> -<a class="jxr_linenumber" name="L439" href="#L439">439</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L440" href="#L440">440</a> <em class="jxr_javadoccomment"> * @since 2.12</em> -<a class="jxr_linenumber" name="L441" href="#L441">441</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L442" href="#L442">442</a> @Parameter -<a class="jxr_linenumber" name="L443" href="#L443">443</a> <strong class="jxr_keyword">private</strong> PlexusConfiguration checkstyleRules; -<a class="jxr_linenumber" name="L444" href="#L444">444</a> -<a class="jxr_linenumber" name="L445" href="#L445">445</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L446" href="#L446">446</a> <em class="jxr_javadoccomment"> * Dump file for inlined Checkstyle rules. </em> -<a class="jxr_linenumber" name="L447" href="#L447">447</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L448" href="#L448">448</a> @Parameter( property = <span class="jxr_string">"checkstyle.output.rules.file"</span>, -<a class="jxr_linenumber" name="L449" href="#L449">449</a> defaultValue = <span class="jxr_string">"${project.build.directory}/checkstyle-rules.xml"</span> ) -<a class="jxr_linenumber" name="L450" href="#L450">450</a> <strong class="jxr_keyword">private</strong> File rulesFiles; -<a class="jxr_linenumber" name="L451" href="#L451">451</a> -<a class="jxr_linenumber" name="L452" href="#L452">452</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L453" href="#L453">453</a> <em class="jxr_javadoccomment"> * The header to use for the inline configuration.</em> -<a class="jxr_linenumber" name="L454" href="#L454">454</a> <em class="jxr_javadoccomment"> * Only used when you specify {@code checkstyleRules}.</em> +<a class="jxr_linenumber" name="L408" href="#L408">408</a> <em class="jxr_comment">// Compatibility with all Maven 3: default of 'project.compileSourceRoots' is done manually because of MNG-5440</em> +<a class="jxr_linenumber" name="L409" href="#L409">409</a> @Parameter +<a class="jxr_linenumber" name="L410" href="#L410">410</a> <strong class="jxr_keyword">private</strong> List<String> sourceDirectories; +<a class="jxr_linenumber" name="L411" href="#L411">411</a> +<a class="jxr_linenumber" name="L412" href="#L412">412</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L413" href="#L413">413</a> <em class="jxr_javadoccomment"> * Whether to apply Checkstyle to resource directories.</em> +<a class="jxr_linenumber" name="L414" href="#L414">414</a> <em class="jxr_javadoccomment"> * @since 2.11</em> +<a class="jxr_linenumber" name="L415" href="#L415">415</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L416" href="#L416">416</a> @Parameter( property = <span class="jxr_string">"checkstyle.includeResources"</span>, defaultValue = <span class="jxr_string">"true"</span>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L417" href="#L417">417</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> includeResources = <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L418" href="#L418">418</a> +<a class="jxr_linenumber" name="L419" href="#L419">419</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L420" href="#L420">420</a> <em class="jxr_javadoccomment"> * Whether to apply Checkstyle to test resource directories.</em> +<a class="jxr_linenumber" name="L421" href="#L421">421</a> <em class="jxr_javadoccomment"> * @since 2.11</em> +<a class="jxr_linenumber" name="L422" href="#L422">422</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L423" href="#L423">423</a> @Parameter( property = <span class="jxr_string">"checkstyle.includeTestResources"</span>, defaultValue = <span class="jxr_string">"true"</span>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> includeTestResources = <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L425" href="#L425">425</a> +<a class="jxr_linenumber" name="L426" href="#L426">426</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L427" href="#L427">427</a> <em class="jxr_javadoccomment"> * By using this property, you can specify the whole Checkstyle rules</em> +<a class="jxr_linenumber" name="L428" href="#L428">428</a> <em class="jxr_javadoccomment"> * inline directly inside this pom.</em> +<a class="jxr_linenumber" name="L429" href="#L429">429</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L430" href="#L430">430</a> <em class="jxr_javadoccomment"> * <pre></em> +<a class="jxr_linenumber" name="L431" href="#L431">431</a> <em class="jxr_javadoccomment"> * &lt;plugin&gt;</em> +<a class="jxr_linenumber" name="L432" href="#L432">432</a> <em class="jxr_javadoccomment"> * ...</em> +<a class="jxr_linenumber" name="L433" href="#L433">433</a> <em class="jxr_javadoccomment"> * &lt;configuration&gt;</em> +<a class="jxr_linenumber" name="L434" href="#L434">434</a> <em class="jxr_javadoccomment"> * &lt;checkstyleRules&gt;</em> +<a class="jxr_linenumber" name="L435" href="#L435">435</a> <em class="jxr_javadoccomment"> * &lt;module name="Checker"&gt;</em> +<a class="jxr_linenumber" name="L436" href="#L436">436</a> <em class="jxr_javadoccomment"> * &lt;module name="FileTabCharacter"&gt;</em> +<a class="jxr_linenumber" name="L437" href="#L437">437</a> <em class="jxr_javadoccomment"> * &lt;property name="eachLine" value="true" /&gt;</em> +<a class="jxr_linenumber" name="L438" href="#L438">438</a> <em class="jxr_javadoccomment"> * &lt;/module&gt;</em> +<a class="jxr_linenumber" name="L439" href="#L439">439</a> <em class="jxr_javadoccomment"> * &lt;module name="TreeWalker"&gt;</em> +<a class="jxr_linenumber" name="L440" href="#L440">440</a> <em class="jxr_javadoccomment"> * &lt;module name="EmptyBlock"/&gt;</em> +<a class="jxr_linenumber" name="L441" href="#L441">441</a> <em class="jxr_javadoccomment"> * &lt;/module&gt;</em> +<a class="jxr_linenumber" name="L442" href="#L442">442</a> <em class="jxr_javadoccomment"> * &lt;/module&gt;</em> +<a class="jxr_linenumber" name="L443" href="#L443">443</a> <em class="jxr_javadoccomment"> * &lt;/checkstyleRules&gt;</em> +<a class="jxr_linenumber" name="L444" href="#L444">444</a> <em class="jxr_javadoccomment"> * &lt;/configuration&gt;</em> +<a class="jxr_linenumber" name="L445" href="#L445">445</a> <em class="jxr_javadoccomment"> * ...</em> +<a class="jxr_linenumber" name="L446" href="#L446">446</a> <em class="jxr_javadoccomment"> * </pre></em> +<a class="jxr_linenumber" name="L447" href="#L447">447</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L448" href="#L448">448</a> <em class="jxr_javadoccomment"> * @since 2.12</em> +<a class="jxr_linenumber" name="L449" href="#L449">449</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L450" href="#L450">450</a> @Parameter +<a class="jxr_linenumber" name="L451" href="#L451">451</a> <strong class="jxr_keyword">private</strong> PlexusConfiguration checkstyleRules; +<a class="jxr_linenumber" name="L452" href="#L452">452</a> +<a class="jxr_linenumber" name="L453" href="#L453">453</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L454" href="#L454">454</a> <em class="jxr_javadoccomment"> * Dump file for inlined Checkstyle rules. </em> <a class="jxr_linenumber" name="L455" href="#L455">455</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L456" href="#L456">456</a> @Parameter( defaultValue = <span class="jxr_string">"<?xml version=\"1.0\"?>\n"</span> -<a class="jxr_linenumber" name="L457" href="#L457">457</a> + <span class="jxr_string">"<!DOCTYPE module PUBLIC \"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN\"\n"</span> -<a class="jxr_linenumber" name="L458" href="#L458">458</a> + <span class="jxr_string">" \"https://checkstyle.org/dtds/configuration_1_3.dtd\">\n";</span> ) -<a class="jxr_linenumber" name="L459" href="#L459">459</a> <strong class="jxr_keyword">private</strong> String checkstyleRulesHeader; -<a class="jxr_linenumber" name="L460" href="#L460">460</a> -<a class="jxr_linenumber" name="L461" href="#L461">461</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L462" href="#L462">462</a> <em class="jxr_javadoccomment"> * Specifies whether modules with a configured severity of <code>ignore</code> should be omitted during Checkstyle</em> -<a class="jxr_linenumber" name="L463" href="#L463">463</a> <em class="jxr_javadoccomment"> * invocation.</em> -<a class="jxr_linenumber" name="L464" href="#L464">464</a> <em class="jxr_javadoccomment"> * </em> -<a class="jxr_linenumber" name="L465" href="#L465">465</a> <em class="jxr_javadoccomment"> * @since 3.0.0</em> -<a class="jxr_linenumber" name="L466" href="#L466">466</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L467" href="#L467">467</a> @Parameter( defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L468" href="#L468">468</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> omitIgnoredModules; -<a class="jxr_linenumber" name="L469" href="#L469">469</a> -<a class="jxr_linenumber" name="L470" href="#L470">470</a> <strong class="jxr_keyword">private</strong> ByteArrayOutputStream stringOutputStream; -<a class="jxr_linenumber" name="L471" href="#L471">471</a> -<a class="jxr_linenumber" name="L472" href="#L472">472</a> <strong class="jxr_keyword">private</strong> File outputXmlFile; -<a class="jxr_linenumber" name="L473" href="#L473">473</a> -<a class="jxr_linenumber" name="L474" href="#L474">474</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> -<a class="jxr_linenumber" name="L475" href="#L475">475</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() -<a class="jxr_linenumber" name="L476" href="#L476">476</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException -<a class="jxr_linenumber" name="L477" href="#L477">477</a> { -<a class="jxr_linenumber" name="L478" href="#L478">478</a> checkDeprecatedParameterUsage( sourceDirectory, <span class="jxr_string">"sourceDirectory"</span>, <span class="jxr_string">"sourceDirectories"</span> ); -<a class="jxr_linenumber" name="L479" href="#L479">479</a> checkDeprecatedParameterUsage( testSourceDirectory, <span class="jxr_string">"testSourceDirectory"</span>, <span class="jxr_string">"testSourceDirectories"</span> ); -<a class="jxr_linenumber" name="L480" href="#L480">480</a> <strong class="jxr_keyword">if</strong> ( skip ) -<a class="jxr_linenumber" name="L481" href="#L481">481</a> { -<a class="jxr_linenumber" name="L482" href="#L482">482</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L483" href="#L483">483</a> } -<a class="jxr_linenumber" name="L484" href="#L484">484</a> -<a class="jxr_linenumber" name="L485" href="#L485">485</a> outputXmlFile = outputFile; -<a class="jxr_linenumber" name="L486" href="#L486">486</a> -<a class="jxr_linenumber" name="L487" href="#L487">487</a> <strong class="jxr_keyword">if</strong> ( !skipExec ) -<a class="jxr_linenumber" name="L488" href="#L488">488</a> { -<a class="jxr_linenumber" name="L489" href="#L489">489</a> <strong class="jxr_keyword">if</strong> ( checkstyleRules != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L490" href="#L490">490</a> { -<a class="jxr_linenumber" name="L491" href="#L491">491</a> <strong class="jxr_keyword">if</strong> ( !DEFAULT_CONFIG_LOCATION.equals( configLocation ) ) -<a class="jxr_linenumber" name="L492" href="#L492">492</a> { -<a class="jxr_linenumber" name="L493" href="#L493">493</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"If you use inline configuration for rules, don't specify "</span> -<a class="jxr_linenumber" name="L494" href="#L494">494</a> + <span class="jxr_string">"a configLocation"</span> ); -<a class="jxr_linenumber" name="L495" href="#L495">495</a> } -<a class="jxr_linenumber" name="L496" href="#L496">496</a> <strong class="jxr_keyword">if</strong> ( checkstyleRules.getChildCount() > 1 ) -<a class="jxr_linenumber" name="L497" href="#L497">497</a> { -<a class="jxr_linenumber" name="L498" href="#L498">498</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Currently only one root module is supported"</span> ); -<a class="jxr_linenumber" name="L499" href="#L499">499</a> } -<a class="jxr_linenumber" name="L500" href="#L500">500</a> -<a class="jxr_linenumber" name="L501" href="#L501">501</a> PlexusConfiguration checkerModule = checkstyleRules.getChild( 0 ); -<a class="jxr_linenumber" name="L502" href="#L502">502</a> -<a class="jxr_linenumber" name="L503" href="#L503">503</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L504" href="#L504">504</a> { -<a class="jxr_linenumber" name="L505" href="#L505">505</a> FileUtils.forceMkdir( rulesFiles.getParentFile() ); -<a class="jxr_linenumber" name="L506" href="#L506">506</a> FileUtils.fileWrite( rulesFiles, checkstyleRulesHeader + checkerModule.toString() ); +<a class="jxr_linenumber" name="L456" href="#L456">456</a> @Parameter( property = <span class="jxr_string">"checkstyle.output.rules.file"</span>, +<a class="jxr_linenumber" name="L457" href="#L457">457</a> defaultValue = <span class="jxr_string">"${project.build.directory}/checkstyle-rules.xml"</span> ) +<a class="jxr_linenumber" name="L458" href="#L458">458</a> <strong class="jxr_keyword">private</strong> File rulesFiles; +<a class="jxr_linenumber" name="L459" href="#L459">459</a> +<a class="jxr_linenumber" name="L460" href="#L460">460</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L461" href="#L461">461</a> <em class="jxr_javadoccomment"> * The header to use for the inline configuration.</em> +<a class="jxr_linenumber" name="L462" href="#L462">462</a> <em class="jxr_javadoccomment"> * Only used when you specify {@code checkstyleRules}.</em> +<a class="jxr_linenumber" name="L463" href="#L463">463</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L464" href="#L464">464</a> @Parameter( defaultValue = <span class="jxr_string">"<?xml version=\"1.0\"?>\n"</span> +<a class="jxr_linenumber" name="L465" href="#L465">465</a> + <span class="jxr_string">"<!DOCTYPE module PUBLIC \"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN\"\n"</span> +<a class="jxr_linenumber" name="L466" href="#L466">466</a> + <span class="jxr_string">" \"https://checkstyle.org/dtds/configuration_1_3.dtd\">\n";</span> ) +<a class="jxr_linenumber" name="L467" href="#L467">467</a> <strong class="jxr_keyword">private</strong> String checkstyleRulesHeader; +<a class="jxr_linenumber" name="L468" href="#L468">468</a> +<a class="jxr_linenumber" name="L469" href="#L469">469</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L470" href="#L470">470</a> <em class="jxr_javadoccomment"> * Specifies whether modules with a configured severity of <code>ignore</code> should be omitted during Checkstyle</em> +<a class="jxr_linenumber" name="L471" href="#L471">471</a> <em class="jxr_javadoccomment"> * invocation.</em> +<a class="jxr_linenumber" name="L472" href="#L472">472</a> <em class="jxr_javadoccomment"> * </em> +<a class="jxr_linenumber" name="L473" href="#L473">473</a> <em class="jxr_javadoccomment"> * @since 3.0.0</em> +<a class="jxr_linenumber" name="L474" href="#L474">474</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L475" href="#L475">475</a> @Parameter( defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L476" href="#L476">476</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> omitIgnoredModules; +<a class="jxr_linenumber" name="L477" href="#L477">477</a> +<a class="jxr_linenumber" name="L478" href="#L478">478</a> <strong class="jxr_keyword">private</strong> ByteArrayOutputStream stringOutputStream; +<a class="jxr_linenumber" name="L479" href="#L479">479</a> +<a class="jxr_linenumber" name="L480" href="#L480">480</a> <strong class="jxr_keyword">private</strong> File outputXmlFile; +<a class="jxr_linenumber" name="L481" href="#L481">481</a> +<a class="jxr_linenumber" name="L482" href="#L482">482</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> +<a class="jxr_linenumber" name="L483" href="#L483">483</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() +<a class="jxr_linenumber" name="L484" href="#L484">484</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException +<a class="jxr_linenumber" name="L485" href="#L485">485</a> { +<a class="jxr_linenumber" name="L486" href="#L486">486</a> checkDeprecatedParameterUsage( sourceDirectory, <span class="jxr_string">"sourceDirectory"</span>, <span class="jxr_string">"sourceDirectories"</span> ); +<a class="jxr_linenumber" name="L487" href="#L487">487</a> checkDeprecatedParameterUsage( testSourceDirectory, <span class="jxr_string">"testSourceDirectory"</span>, <span class="jxr_string">"testSourceDirectories"</span> ); +<a class="jxr_linenumber" name="L488" href="#L488">488</a> <strong class="jxr_keyword">if</strong> ( skip ) +<a class="jxr_linenumber" name="L489" href="#L489">489</a> { +<a class="jxr_linenumber" name="L490" href="#L490">490</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L491" href="#L491">491</a> } +<a class="jxr_linenumber" name="L492" href="#L492">492</a> +<a class="jxr_linenumber" name="L493" href="#L493">493</a> outputXmlFile = outputFile; +<a class="jxr_linenumber" name="L494" href="#L494">494</a> +<a class="jxr_linenumber" name="L495" href="#L495">495</a> <strong class="jxr_keyword">if</strong> ( !skipExec ) +<a class="jxr_linenumber" name="L496" href="#L496">496</a> { +<a class="jxr_linenumber" name="L497" href="#L497">497</a> <strong class="jxr_keyword">if</strong> ( checkstyleRules != <strong class="jxr_keyword">null</strong> )
[... 754 lines stripped ...]
