Modified: websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugin/pmd/PmdReport.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugin/pmd/PmdReport.html (original) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugin/pmd/PmdReport.html Mon May 1 07:24:19 2017 @@ -140,7 +140,7 @@ <a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> *</em> <a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * @since 3.0</em> <a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L135" href="#L135">135</a> @Parameter( property = <span class="jxr_string">"pmd.typeResolution"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L135" href="#L135">135</a> @Parameter( property = <span class="jxr_string">"pmd.typeResolution"</span>, defaultValue = <span class="jxr_string">"true"</span> ) <a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> typeResolution; <a class="jxr_linenumber" name="L137" href="#L137">137</a> <a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment">/**</em> @@ -190,508 +190,537 @@ <a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skipPmdError; <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"> * {@inheritDoc}</em> -<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">public</strong> String getName( Locale locale ) -<a class="jxr_linenumber" name="L188" href="#L188">188</a> { -<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">return</strong> getBundle( locale ).getString( <span class="jxr_string">"report.pmd.name"</span> ); -<a class="jxr_linenumber" name="L190" href="#L190">190</a> } -<a class="jxr_linenumber" name="L191" href="#L191">191</a> -<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> -<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">public</strong> String getDescription( Locale locale ) -<a class="jxr_linenumber" name="L196" href="#L196">196</a> { -<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">return</strong> getBundle( locale ).getString( <span class="jxr_string">"report.pmd.description"</span> ); -<a class="jxr_linenumber" name="L198" href="#L198">198</a> } -<a class="jxr_linenumber" name="L199" href="#L199">199</a> -<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRulesets( String[] rules ) -<a class="jxr_linenumber" name="L201" href="#L201">201</a> { -<a class="jxr_linenumber" name="L202" href="#L202">202</a> rulesets = rules; -<a class="jxr_linenumber" name="L203" href="#L203">203</a> } -<a class="jxr_linenumber" name="L204" href="#L204">204</a> -<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> -<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L208" href="#L208">208</a> @Override -<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> executeReport( Locale locale ) -<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">throws</strong> MavenReportException +<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> * Enables the analysis cache, which speeds up PMD. This</em> +<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * requires a cache file, that contains the results of the last</em> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * PMD run. Thus the cache is only effective, if this file is</em> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * not cleaned between runs.</em> +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * @since 3.8</em> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> @Parameter( property = <span class="jxr_string">"pmd.analysisCache"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> analysisCache; +<a class="jxr_linenumber" name="L194" href="#L194">194</a> +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * The location of the analysis cache, if it is enabled.</em> +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * This file contains the results of the last PMD run and must not be cleaned</em> +<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * between consecutive PMD runs. Otherwise the cache is not in use.</em> +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * If the file doesn't exist, PMD executes as if there is no cache enabled and</em> +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * all files are analyzed. Otherwise only changed files will be analyzed again.</em> +<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * @since 3.8</em> +<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L204" href="#L204">204</a> @Parameter( property = <span class="jxr_string">"pmd.analysisCacheLocation"</span>, defaultValue = <span class="jxr_string">"${project.build.directory}/pmd/pmd.cache"</span> ) +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">private</strong> String analysisCacheLocation; +<a class="jxr_linenumber" name="L206" href="#L206">206</a> +<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">public</strong> String getName( Locale locale ) <a class="jxr_linenumber" name="L211" href="#L211">211</a> { -<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L213" href="#L213">213</a> { -<a class="jxr_linenumber" name="L214" href="#L214">214</a> execute( locale ); -<a class="jxr_linenumber" name="L215" href="#L215">215</a> } -<a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">finally</strong> -<a class="jxr_linenumber" name="L217" href="#L217">217</a> { -<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">if</strong> ( getSink() != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L219" href="#L219">219</a> { -<a class="jxr_linenumber" name="L220" href="#L220">220</a> getSink().close(); -<a class="jxr_linenumber" name="L221" href="#L221">221</a> } -<a class="jxr_linenumber" name="L222" href="#L222">222</a> } -<a class="jxr_linenumber" name="L223" href="#L223">223</a> } -<a class="jxr_linenumber" name="L224" href="#L224">224</a> -<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> execute( Locale locale ) -<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong class="jxr_keyword">throws</strong> MavenReportException -<a class="jxr_linenumber" name="L227" href="#L227">227</a> { -<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">if</strong> ( !skip && canGenerateReport() ) -<a class="jxr_linenumber" name="L229" href="#L229">229</a> { -<a class="jxr_linenumber" name="L230" href="#L230">230</a> ClassLoader origLoader = Thread.currentThread().getContextClassLoader(); -<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L232" href="#L232">232</a> { -<a class="jxr_linenumber" name="L233" href="#L233">233</a> Thread.currentThread().setContextClassLoader( <strong class="jxr_keyword">this</strong>.getClass().getClassLoader() ); -<a class="jxr_linenumber" name="L234" href="#L234">234</a> -<a class="jxr_linenumber" name="L235" href="#L235">235</a> Report report = generateReport( locale ); -<a class="jxr_linenumber" name="L236" href="#L236">236</a> -<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">if</strong> ( !isHtml() && !isXml() ) -<a class="jxr_linenumber" name="L238" href="#L238">238</a> { -<a class="jxr_linenumber" name="L239" href="#L239">239</a> writeNonHtml( report ); -<a class="jxr_linenumber" name="L240" href="#L240">240</a> } -<a class="jxr_linenumber" name="L241" href="#L241">241</a> } -<a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">finally</strong> -<a class="jxr_linenumber" name="L243" href="#L243">243</a> { -<a class="jxr_linenumber" name="L244" href="#L244">244</a> Thread.currentThread().setContextClassLoader( origLoader ); -<a class="jxr_linenumber" name="L245" href="#L245">245</a> } -<a class="jxr_linenumber" name="L246" href="#L246">246</a> } -<a class="jxr_linenumber" name="L247" href="#L247">247</a> } -<a class="jxr_linenumber" name="L248" href="#L248">248</a> -<a class="jxr_linenumber" name="L249" href="#L249">249</a> @Override -<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() -<a class="jxr_linenumber" name="L251" href="#L251">251</a> { -<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">if</strong> ( skip ) -<a class="jxr_linenumber" name="L253" href="#L253">253</a> { -<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">return</strong> false; -<a class="jxr_linenumber" name="L255" href="#L255">255</a> } -<a class="jxr_linenumber" name="L256" href="#L256">256</a> -<a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">boolean</strong> result = <strong class="jxr_keyword">super</strong>.canGenerateReport(); -<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">if</strong> ( result ) -<a class="jxr_linenumber" name="L259" href="#L259">259</a> { -<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L261" href="#L261">261</a> { -<a class="jxr_linenumber" name="L262" href="#L262">262</a> executePmdWithClassloader(); -<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">if</strong> ( skipEmptyReport ) -<a class="jxr_linenumber" name="L264" href="#L264">264</a> { -<a class="jxr_linenumber" name="L265" href="#L265">265</a> result = renderer.hasViolations(); -<a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong class="jxr_keyword">if</strong> ( result ) -<a class="jxr_linenumber" name="L267" href="#L267">267</a> { -<a class="jxr_linenumber" name="L268" href="#L268">268</a> getLog().debug( <span class="jxr_string">"Skipping report since skipEmptyReport is true and"</span> -<a class="jxr_linenumber" name="L269" href="#L269">269</a> + <span class="jxr_string">"there are no PMD violations."</span> ); -<a class="jxr_linenumber" name="L270" href="#L270">270</a> } -<a class="jxr_linenumber" name="L271" href="#L271">271</a> } -<a class="jxr_linenumber" name="L272" href="#L272">272</a> } -<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">catch</strong> ( MavenReportException e ) -<a class="jxr_linenumber" name="L274" href="#L274">274</a> { -<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException( e ); -<a class="jxr_linenumber" name="L276" href="#L276">276</a> } -<a class="jxr_linenumber" name="L277" href="#L277">277</a> } -<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">return</strong> result; -<a class="jxr_linenumber" name="L279" href="#L279">279</a> } -<a class="jxr_linenumber" name="L280" href="#L280">280</a> -<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> executePmdWithClassloader() -<a class="jxr_linenumber" name="L282" href="#L282">282</a> <strong class="jxr_keyword">throws</strong> MavenReportException -<a class="jxr_linenumber" name="L283" href="#L283">283</a> { -<a class="jxr_linenumber" name="L284" href="#L284">284</a> ClassLoader origLoader = Thread.currentThread().getContextClassLoader(); -<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L286" href="#L286">286</a> { -<a class="jxr_linenumber" name="L287" href="#L287">287</a> Thread.currentThread().setContextClassLoader( <strong class="jxr_keyword">this</strong>.getClass().getClassLoader() ); -<a class="jxr_linenumber" name="L288" href="#L288">288</a> executePmd(); -<a class="jxr_linenumber" name="L289" href="#L289">289</a> } -<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">finally</strong> -<a class="jxr_linenumber" name="L291" href="#L291">291</a> { -<a class="jxr_linenumber" name="L292" href="#L292">292</a> Thread.currentThread().setContextClassLoader( origLoader ); -<a class="jxr_linenumber" name="L293" href="#L293">293</a> } -<a class="jxr_linenumber" name="L294" href="#L294">294</a> } -<a class="jxr_linenumber" name="L295" href="#L295">295</a> -<a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> executePmd() -<a class="jxr_linenumber" name="L297" href="#L297">297</a> <strong class="jxr_keyword">throws</strong> MavenReportException -<a class="jxr_linenumber" name="L298" href="#L298">298</a> { -<a class="jxr_linenumber" name="L299" href="#L299">299</a> <strong class="jxr_keyword">if</strong> ( renderer != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L300" href="#L300">300</a> { -<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_comment">// PMD has already been run</em> -<a class="jxr_linenumber" name="L302" href="#L302">302</a> getLog().debug( <span class="jxr_string">"PMD has already been run - skipping redundant execution."</span> ); -<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L304" href="#L304">304</a> } -<a class="jxr_linenumber" name="L305" href="#L305">305</a> -<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L307" href="#L307">307</a> { -<a class="jxr_linenumber" name="L308" href="#L308">308</a> excludeFromFile.loadExcludeFromFailuresData( excludeFromFailureFile ); -<a class="jxr_linenumber" name="L309" href="#L309">309</a> } -<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">catch</strong> ( MojoExecutionException e ) -<a class="jxr_linenumber" name="L311" href="#L311">311</a> { -<a class="jxr_linenumber" name="L312" href="#L312">312</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Unable to load exclusions"</span>, e ); -<a class="jxr_linenumber" name="L313" href="#L313">313</a> } -<a class="jxr_linenumber" name="L314" href="#L314">314</a> -<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_comment">// configure ResourceManager</em> -<a class="jxr_linenumber" name="L316" href="#L316">316</a> locator.addSearchPath( FileResourceLoader.ID, project.getFile().getParentFile().getAbsolutePath() ); -<a class="jxr_linenumber" name="L317" href="#L317">317</a> locator.addSearchPath( <span class="jxr_string">"url"</span>, <span class="jxr_string">""</span> ); -<a class="jxr_linenumber" name="L318" href="#L318">318</a> locator.setOutputDirectory( targetDirectory ); -<a class="jxr_linenumber" name="L319" href="#L319">319</a> -<a class="jxr_linenumber" name="L320" href="#L320">320</a> renderer = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/pmd/PmdCollectingRenderer.html">PmdCollectingRenderer</a>(); -<a class="jxr_linenumber" name="L321" href="#L321">321</a> PMDConfiguration pmdConfiguration = getPMDConfiguration(); -<a class="jxr_linenumber" name="L322" href="#L322">322</a> -<a class="jxr_linenumber" name="L323" href="#L323">323</a> String[] sets = <strong class="jxr_keyword">new</strong> String[rulesets.length]; -<a class="jxr_linenumber" name="L324" href="#L324">324</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L325" href="#L325">325</a> { -<a class="jxr_linenumber" name="L326" href="#L326">326</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> idx = 0; idx < rulesets.length; idx++ ) -<a class="jxr_linenumber" name="L327" href="#L327">327</a> { -<a class="jxr_linenumber" name="L328" href="#L328">328</a> String set = rulesets[idx]; -<a class="jxr_linenumber" name="L329" href="#L329">329</a> getLog().debug( <span class="jxr_string">"Preparing ruleset: "</span> + set ); -<a class="jxr_linenumber" name="L330" href="#L330">330</a> RuleSetReferenceId id = <strong class="jxr_keyword">new</strong> RuleSetReferenceId( set ); -<a class="jxr_linenumber" name="L331" href="#L331">331</a> File ruleset = locator.getResourceAsFile( id.getRuleSetFileName(), getLocationTemp( set ) ); -<a class="jxr_linenumber" name="L332" href="#L332">332</a> <strong class="jxr_keyword">if</strong> ( <strong class="jxr_keyword">null</strong> == ruleset ) -<a class="jxr_linenumber" name="L333" href="#L333">333</a> { -<a class="jxr_linenumber" name="L334" href="#L334">334</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Could not resolve "</span> + set ); -<a class="jxr_linenumber" name="L335" href="#L335">335</a> } -<a class="jxr_linenumber" name="L336" href="#L336">336</a> sets[idx] = ruleset.getAbsolutePath(); -<a class="jxr_linenumber" name="L337" href="#L337">337</a> } -<a class="jxr_linenumber" name="L338" href="#L338">338</a> } -<a class="jxr_linenumber" name="L339" href="#L339">339</a> <strong class="jxr_keyword">catch</strong> ( ResourceNotFoundException e ) -<a class="jxr_linenumber" name="L340" href="#L340">340</a> { -<a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e ); -<a class="jxr_linenumber" name="L342" href="#L342">342</a> } -<a class="jxr_linenumber" name="L343" href="#L343">343</a> <strong class="jxr_keyword">catch</strong> ( FileResourceCreationException e ) -<a class="jxr_linenumber" name="L344" href="#L344">344</a> { -<a class="jxr_linenumber" name="L345" href="#L345">345</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e ); -<a class="jxr_linenumber" name="L346" href="#L346">346</a> } -<a class="jxr_linenumber" name="L347" href="#L347">347</a> pmdConfiguration.setRuleSets( StringUtils.join( sets, <span class="jxr_string">","</span> ) ); -<a class="jxr_linenumber" name="L348" href="#L348">348</a> -<a class="jxr_linenumber" name="L349" href="#L349">349</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L350" href="#L350">350</a> { -<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">if</strong> ( filesToProcess == <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L352" href="#L352">352</a> { -<a class="jxr_linenumber" name="L353" href="#L353">353</a> filesToProcess = getFilesToProcess(); -<a class="jxr_linenumber" name="L354" href="#L354">354</a> } -<a class="jxr_linenumber" name="L355" href="#L355">355</a> -<a class="jxr_linenumber" name="L356" href="#L356">356</a> <strong class="jxr_keyword">if</strong> ( filesToProcess.isEmpty() && !<span class="jxr_string">"java"</span>.equals( language ) ) -<a class="jxr_linenumber" name="L357" href="#L357">357</a> { -<a class="jxr_linenumber" name="L358" href="#L358">358</a> getLog().warn( <span class="jxr_string">"No files found to process. Did you add your additional source folders like javascript?"</span> -<a class="jxr_linenumber" name="L359" href="#L359">359</a> + <span class="jxr_string">" (see also build-helper-maven-plugin)"</span> ); +<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">return</strong> getBundle( locale ).getString( <span class="jxr_string">"report.pmd.name"</span> ); +<a class="jxr_linenumber" name="L213" href="#L213">213</a> } +<a class="jxr_linenumber" name="L214" href="#L214">214</a> +<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"> * {@inheritDoc}</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> <strong class="jxr_keyword">public</strong> String getDescription( Locale locale ) +<a class="jxr_linenumber" name="L219" href="#L219">219</a> { +<a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">return</strong> getBundle( locale ).getString( <span class="jxr_string">"report.pmd.description"</span> ); +<a class="jxr_linenumber" name="L221" href="#L221">221</a> } +<a class="jxr_linenumber" name="L222" href="#L222">222</a> +<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRulesets( String[] rules ) +<a class="jxr_linenumber" name="L224" href="#L224">224</a> { +<a class="jxr_linenumber" name="L225" href="#L225">225</a> rulesets = rules; +<a class="jxr_linenumber" name="L226" href="#L226">226</a> } +<a class="jxr_linenumber" name="L227" href="#L227">227</a> +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L231" href="#L231">231</a> @Override +<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> executeReport( Locale locale ) +<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">throws</strong> MavenReportException +<a class="jxr_linenumber" name="L234" href="#L234">234</a> { +<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L236" href="#L236">236</a> { +<a class="jxr_linenumber" name="L237" href="#L237">237</a> execute( locale ); +<a class="jxr_linenumber" name="L238" href="#L238">238</a> } +<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">finally</strong> +<a class="jxr_linenumber" name="L240" href="#L240">240</a> { +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">if</strong> ( getSink() != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L242" href="#L242">242</a> { +<a class="jxr_linenumber" name="L243" href="#L243">243</a> getSink().close(); +<a class="jxr_linenumber" name="L244" href="#L244">244</a> } +<a class="jxr_linenumber" name="L245" href="#L245">245</a> } +<a class="jxr_linenumber" name="L246" href="#L246">246</a> } +<a class="jxr_linenumber" name="L247" href="#L247">247</a> +<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> execute( Locale locale ) +<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">throws</strong> MavenReportException +<a class="jxr_linenumber" name="L250" href="#L250">250</a> { +<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">if</strong> ( !skip && canGenerateReport() ) +<a class="jxr_linenumber" name="L252" href="#L252">252</a> { +<a class="jxr_linenumber" name="L253" href="#L253">253</a> ClassLoader origLoader = Thread.currentThread().getContextClassLoader(); +<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L255" href="#L255">255</a> { +<a class="jxr_linenumber" name="L256" href="#L256">256</a> Thread.currentThread().setContextClassLoader( <strong class="jxr_keyword">this</strong>.getClass().getClassLoader() ); +<a class="jxr_linenumber" name="L257" href="#L257">257</a> +<a class="jxr_linenumber" name="L258" href="#L258">258</a> Report report = generateReport( locale ); +<a class="jxr_linenumber" name="L259" href="#L259">259</a> +<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">if</strong> ( !isHtml() && !isXml() ) +<a class="jxr_linenumber" name="L261" href="#L261">261</a> { +<a class="jxr_linenumber" name="L262" href="#L262">262</a> writeNonHtml( report ); +<a class="jxr_linenumber" name="L263" href="#L263">263</a> } +<a class="jxr_linenumber" name="L264" href="#L264">264</a> } +<a class="jxr_linenumber" name="L265" href="#L265">265</a> <strong class="jxr_keyword">finally</strong> +<a class="jxr_linenumber" name="L266" href="#L266">266</a> { +<a class="jxr_linenumber" name="L267" href="#L267">267</a> Thread.currentThread().setContextClassLoader( origLoader ); +<a class="jxr_linenumber" name="L268" href="#L268">268</a> } +<a class="jxr_linenumber" name="L269" href="#L269">269</a> } +<a class="jxr_linenumber" name="L270" href="#L270">270</a> } +<a class="jxr_linenumber" name="L271" href="#L271">271</a> +<a class="jxr_linenumber" name="L272" href="#L272">272</a> @Override +<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() +<a class="jxr_linenumber" name="L274" href="#L274">274</a> { +<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">if</strong> ( skip ) +<a class="jxr_linenumber" name="L276" href="#L276">276</a> { +<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L278" href="#L278">278</a> } +<a class="jxr_linenumber" name="L279" href="#L279">279</a> +<a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">boolean</strong> result = <strong class="jxr_keyword">super</strong>.canGenerateReport(); +<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">if</strong> ( result ) +<a class="jxr_linenumber" name="L282" href="#L282">282</a> { +<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L284" href="#L284">284</a> { +<a class="jxr_linenumber" name="L285" href="#L285">285</a> executePmdWithClassloader(); +<a class="jxr_linenumber" name="L286" href="#L286">286</a> <strong class="jxr_keyword">if</strong> ( skipEmptyReport ) +<a class="jxr_linenumber" name="L287" href="#L287">287</a> { +<a class="jxr_linenumber" name="L288" href="#L288">288</a> result = renderer.hasViolations(); +<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">if</strong> ( result ) +<a class="jxr_linenumber" name="L290" href="#L290">290</a> { +<a class="jxr_linenumber" name="L291" href="#L291">291</a> getLog().debug( <span class="jxr_string">"Skipping report since skipEmptyReport is true and"</span> +<a class="jxr_linenumber" name="L292" href="#L292">292</a> + <span class="jxr_string">"there are no PMD violations."</span> ); +<a class="jxr_linenumber" name="L293" href="#L293">293</a> } +<a class="jxr_linenumber" name="L294" href="#L294">294</a> } +<a class="jxr_linenumber" name="L295" href="#L295">295</a> } +<a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong class="jxr_keyword">catch</strong> ( MavenReportException e ) +<a class="jxr_linenumber" name="L297" href="#L297">297</a> { +<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException( e ); +<a class="jxr_linenumber" name="L299" href="#L299">299</a> } +<a class="jxr_linenumber" name="L300" href="#L300">300</a> } +<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong class="jxr_keyword">return</strong> result; +<a class="jxr_linenumber" name="L302" href="#L302">302</a> } +<a class="jxr_linenumber" name="L303" href="#L303">303</a> +<a class="jxr_linenumber" name="L304" href="#L304">304</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> executePmdWithClassloader() +<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">throws</strong> MavenReportException +<a class="jxr_linenumber" name="L306" href="#L306">306</a> { +<a class="jxr_linenumber" name="L307" href="#L307">307</a> ClassLoader origLoader = Thread.currentThread().getContextClassLoader(); +<a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L309" href="#L309">309</a> { +<a class="jxr_linenumber" name="L310" href="#L310">310</a> Thread.currentThread().setContextClassLoader( <strong class="jxr_keyword">this</strong>.getClass().getClassLoader() ); +<a class="jxr_linenumber" name="L311" href="#L311">311</a> executePmd(); +<a class="jxr_linenumber" name="L312" href="#L312">312</a> } +<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">finally</strong> +<a class="jxr_linenumber" name="L314" href="#L314">314</a> { +<a class="jxr_linenumber" name="L315" href="#L315">315</a> Thread.currentThread().setContextClassLoader( origLoader ); +<a class="jxr_linenumber" name="L316" href="#L316">316</a> } +<a class="jxr_linenumber" name="L317" href="#L317">317</a> } +<a class="jxr_linenumber" name="L318" href="#L318">318</a> +<a class="jxr_linenumber" name="L319" href="#L319">319</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> executePmd() +<a class="jxr_linenumber" name="L320" href="#L320">320</a> <strong class="jxr_keyword">throws</strong> MavenReportException +<a class="jxr_linenumber" name="L321" href="#L321">321</a> { +<a class="jxr_linenumber" name="L322" href="#L322">322</a> <strong class="jxr_keyword">if</strong> ( renderer != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L323" href="#L323">323</a> { +<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_comment">// PMD has already been run</em> +<a class="jxr_linenumber" name="L325" href="#L325">325</a> getLog().debug( <span class="jxr_string">"PMD has already been run - skipping redundant execution."</span> ); +<a class="jxr_linenumber" name="L326" href="#L326">326</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L327" href="#L327">327</a> } +<a class="jxr_linenumber" name="L328" href="#L328">328</a> +<a class="jxr_linenumber" name="L329" href="#L329">329</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L330" href="#L330">330</a> { +<a class="jxr_linenumber" name="L331" href="#L331">331</a> excludeFromFile.loadExcludeFromFailuresData( excludeFromFailureFile ); +<a class="jxr_linenumber" name="L332" href="#L332">332</a> } +<a class="jxr_linenumber" name="L333" href="#L333">333</a> <strong class="jxr_keyword">catch</strong> ( MojoExecutionException e ) +<a class="jxr_linenumber" name="L334" href="#L334">334</a> { +<a class="jxr_linenumber" name="L335" href="#L335">335</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Unable to load exclusions"</span>, e ); +<a class="jxr_linenumber" name="L336" href="#L336">336</a> } +<a class="jxr_linenumber" name="L337" href="#L337">337</a> +<a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_comment">// configure ResourceManager</em> +<a class="jxr_linenumber" name="L339" href="#L339">339</a> locator.addSearchPath( FileResourceLoader.ID, project.getFile().getParentFile().getAbsolutePath() ); +<a class="jxr_linenumber" name="L340" href="#L340">340</a> locator.addSearchPath( <span class="jxr_string">"url"</span>, <span class="jxr_string">""</span> ); +<a class="jxr_linenumber" name="L341" href="#L341">341</a> locator.setOutputDirectory( targetDirectory ); +<a class="jxr_linenumber" name="L342" href="#L342">342</a> +<a class="jxr_linenumber" name="L343" href="#L343">343</a> renderer = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/pmd/PmdCollectingRenderer.html">PmdCollectingRenderer</a>(); +<a class="jxr_linenumber" name="L344" href="#L344">344</a> PMDConfiguration pmdConfiguration = getPMDConfiguration(); +<a class="jxr_linenumber" name="L345" href="#L345">345</a> +<a class="jxr_linenumber" name="L346" href="#L346">346</a> String[] sets = <strong class="jxr_keyword">new</strong> String[rulesets.length]; +<a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L348" href="#L348">348</a> { +<a class="jxr_linenumber" name="L349" href="#L349">349</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> idx = 0; idx < rulesets.length; idx++ ) +<a class="jxr_linenumber" name="L350" href="#L350">350</a> { +<a class="jxr_linenumber" name="L351" href="#L351">351</a> String set = rulesets[idx]; +<a class="jxr_linenumber" name="L352" href="#L352">352</a> getLog().debug( <span class="jxr_string">"Preparing ruleset: "</span> + set ); +<a class="jxr_linenumber" name="L353" href="#L353">353</a> RuleSetReferenceId id = <strong class="jxr_keyword">new</strong> RuleSetReferenceId( set ); +<a class="jxr_linenumber" name="L354" href="#L354">354</a> File ruleset = locator.getResourceAsFile( id.getRuleSetFileName(), getLocationTemp( set ) ); +<a class="jxr_linenumber" name="L355" href="#L355">355</a> <strong class="jxr_keyword">if</strong> ( <strong class="jxr_keyword">null</strong> == ruleset ) +<a class="jxr_linenumber" name="L356" href="#L356">356</a> { +<a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Could not resolve "</span> + set ); +<a class="jxr_linenumber" name="L358" href="#L358">358</a> } +<a class="jxr_linenumber" name="L359" href="#L359">359</a> sets[idx] = ruleset.getAbsolutePath(); <a class="jxr_linenumber" name="L360" href="#L360">360</a> } <a class="jxr_linenumber" name="L361" href="#L361">361</a> } -<a class="jxr_linenumber" name="L362" href="#L362">362</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) +<a class="jxr_linenumber" name="L362" href="#L362">362</a> <strong class="jxr_keyword">catch</strong> ( ResourceNotFoundException e ) <a class="jxr_linenumber" name="L363" href="#L363">363</a> { -<a class="jxr_linenumber" name="L364" href="#L364">364</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Can't get file list"</span>, e ); +<a class="jxr_linenumber" name="L364" href="#L364">364</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e ); <a class="jxr_linenumber" name="L365" href="#L365">365</a> } -<a class="jxr_linenumber" name="L366" href="#L366">366</a> -<a class="jxr_linenumber" name="L367" href="#L367">367</a> String encoding = getSourceEncoding(); -<a class="jxr_linenumber" name="L368" href="#L368">368</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( encoding ) && !filesToProcess.isEmpty() ) -<a class="jxr_linenumber" name="L369" href="#L369">369</a> { -<a class="jxr_linenumber" name="L370" href="#L370">370</a> getLog().warn( <span class="jxr_string">"File encoding has not been set, using platform encoding "</span> + ReaderFactory.FILE_ENCODING -<a class="jxr_linenumber" name="L371" href="#L371">371</a> + <span class="jxr_string">", i.e. build is platform dependent!"</span> ); -<a class="jxr_linenumber" name="L372" href="#L372">372</a> encoding = ReaderFactory.FILE_ENCODING; -<a class="jxr_linenumber" name="L373" href="#L373">373</a> } -<a class="jxr_linenumber" name="L374" href="#L374">374</a> pmdConfiguration.setSourceEncoding( encoding ); -<a class="jxr_linenumber" name="L375" href="#L375">375</a> -<a class="jxr_linenumber" name="L376" href="#L376">376</a> List<DataSource> dataSources = <strong class="jxr_keyword">new</strong> ArrayList<>( filesToProcess.size() ); -<a class="jxr_linenumber" name="L377" href="#L377">377</a> <strong class="jxr_keyword">for</strong> ( File f : filesToProcess.keySet() ) -<a class="jxr_linenumber" name="L378" href="#L378">378</a> { -<a class="jxr_linenumber" name="L379" href="#L379">379</a> dataSources.add( <strong class="jxr_keyword">new</strong> FileDataSource( f ) ); -<a class="jxr_linenumber" name="L380" href="#L380">380</a> } -<a class="jxr_linenumber" name="L381" href="#L381">381</a> -<a class="jxr_linenumber" name="L382" href="#L382">382</a> <strong class="jxr_keyword">if</strong> ( sets.length > 0 ) -<a class="jxr_linenumber" name="L383" href="#L383">383</a> { -<a class="jxr_linenumber" name="L384" href="#L384">384</a> processFilesWithPMD( pmdConfiguration, dataSources ); -<a class="jxr_linenumber" name="L385" href="#L385">385</a> } -<a class="jxr_linenumber" name="L386" href="#L386">386</a> <strong class="jxr_keyword">else</strong> -<a class="jxr_linenumber" name="L387" href="#L387">387</a> { -<a class="jxr_linenumber" name="L388" href="#L388">388</a> getLog().debug( <span class="jxr_string">"Skipping PMD execution as no rulesets are defined."</span> ); -<a class="jxr_linenumber" name="L389" href="#L389">389</a> } -<a class="jxr_linenumber" name="L390" href="#L390">390</a> -<a class="jxr_linenumber" name="L391" href="#L391">391</a> <strong class="jxr_keyword">if</strong> ( renderer.hasErrors() ) +<a class="jxr_linenumber" name="L366" href="#L366">366</a> <strong class="jxr_keyword">catch</strong> ( FileResourceCreationException e ) +<a class="jxr_linenumber" name="L367" href="#L367">367</a> { +<a class="jxr_linenumber" name="L368" href="#L368">368</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e ); +<a class="jxr_linenumber" name="L369" href="#L369">369</a> } +<a class="jxr_linenumber" name="L370" href="#L370">370</a> pmdConfiguration.setRuleSets( StringUtils.join( sets, <span class="jxr_string">","</span> ) ); +<a class="jxr_linenumber" name="L371" href="#L371">371</a> +<a class="jxr_linenumber" name="L372" href="#L372">372</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L373" href="#L373">373</a> { +<a class="jxr_linenumber" name="L374" href="#L374">374</a> <strong class="jxr_keyword">if</strong> ( filesToProcess == <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L375" href="#L375">375</a> { +<a class="jxr_linenumber" name="L376" href="#L376">376</a> filesToProcess = getFilesToProcess(); +<a class="jxr_linenumber" name="L377" href="#L377">377</a> } +<a class="jxr_linenumber" name="L378" href="#L378">378</a> +<a class="jxr_linenumber" name="L379" href="#L379">379</a> <strong class="jxr_keyword">if</strong> ( filesToProcess.isEmpty() && !<span class="jxr_string">"java"</span>.equals( language ) ) +<a class="jxr_linenumber" name="L380" href="#L380">380</a> { +<a class="jxr_linenumber" name="L381" href="#L381">381</a> getLog().warn( <span class="jxr_string">"No files found to process. Did you add your additional source folders like javascript?"</span> +<a class="jxr_linenumber" name="L382" href="#L382">382</a> + <span class="jxr_string">" (see also build-helper-maven-plugin)"</span> ); +<a class="jxr_linenumber" name="L383" href="#L383">383</a> } +<a class="jxr_linenumber" name="L384" href="#L384">384</a> } +<a class="jxr_linenumber" name="L385" href="#L385">385</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) +<a class="jxr_linenumber" name="L386" href="#L386">386</a> { +<a class="jxr_linenumber" name="L387" href="#L387">387</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Can't get file list"</span>, e ); +<a class="jxr_linenumber" name="L388" href="#L388">388</a> } +<a class="jxr_linenumber" name="L389" href="#L389">389</a> +<a class="jxr_linenumber" name="L390" href="#L390">390</a> String encoding = getSourceEncoding(); +<a class="jxr_linenumber" name="L391" href="#L391">391</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( encoding ) && !filesToProcess.isEmpty() ) <a class="jxr_linenumber" name="L392" href="#L392">392</a> { -<a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong class="jxr_keyword">if</strong> ( !skipPmdError ) -<a class="jxr_linenumber" name="L394" href="#L394">394</a> { -<a class="jxr_linenumber" name="L395" href="#L395">395</a> getLog().error( <span class="jxr_string">"PMD processing errors:"</span> ); -<a class="jxr_linenumber" name="L396" href="#L396">396</a> getLog().error( renderer.getErrorsAsString() ); -<a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Found "</span> + renderer.getErrors().size() + <span class="jxr_string">" PMD processing errors"</span> ); -<a class="jxr_linenumber" name="L398" href="#L398">398</a> } -<a class="jxr_linenumber" name="L399" href="#L399">399</a> getLog().warn( <span class="jxr_string">"There are "</span> + renderer.getErrors().size() + <span class="jxr_string">" PMD processing errors:"</span> ); -<a class="jxr_linenumber" name="L400" href="#L400">400</a> getLog().warn( renderer.getErrorsAsString() ); -<a class="jxr_linenumber" name="L401" href="#L401">401</a> } -<a class="jxr_linenumber" name="L402" href="#L402">402</a> -<a class="jxr_linenumber" name="L403" href="#L403">403</a> removeExcludedViolations( renderer.getViolations() ); +<a class="jxr_linenumber" name="L393" href="#L393">393</a> getLog().warn( <span class="jxr_string">"File encoding has not been set, using platform encoding "</span> + ReaderFactory.FILE_ENCODING +<a class="jxr_linenumber" name="L394" href="#L394">394</a> + <span class="jxr_string">", i.e. build is platform dependent!"</span> ); +<a class="jxr_linenumber" name="L395" href="#L395">395</a> encoding = ReaderFactory.FILE_ENCODING; +<a class="jxr_linenumber" name="L396" href="#L396">396</a> } +<a class="jxr_linenumber" name="L397" href="#L397">397</a> pmdConfiguration.setSourceEncoding( encoding ); +<a class="jxr_linenumber" name="L398" href="#L398">398</a> +<a class="jxr_linenumber" name="L399" href="#L399">399</a> List<DataSource> dataSources = <strong class="jxr_keyword">new</strong> ArrayList<>( filesToProcess.size() ); +<a class="jxr_linenumber" name="L400" href="#L400">400</a> <strong class="jxr_keyword">for</strong> ( File f : filesToProcess.keySet() ) +<a class="jxr_linenumber" name="L401" href="#L401">401</a> { +<a class="jxr_linenumber" name="L402" href="#L402">402</a> dataSources.add( <strong class="jxr_keyword">new</strong> FileDataSource( f ) ); +<a class="jxr_linenumber" name="L403" href="#L403">403</a> } <a class="jxr_linenumber" name="L404" href="#L404">404</a> -<a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_comment">// if format is XML, we need to output it even if the file list is empty or we have no violations</em> -<a class="jxr_linenumber" name="L406" href="#L406">406</a> <em class="jxr_comment">// so the "check" goals can check for violations</em> -<a class="jxr_linenumber" name="L407" href="#L407">407</a> <strong class="jxr_keyword">if</strong> ( isXml() && renderer != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L408" href="#L408">408</a> { -<a class="jxr_linenumber" name="L409" href="#L409">409</a> writeNonHtml( renderer.asReport() ); -<a class="jxr_linenumber" name="L410" href="#L410">410</a> } -<a class="jxr_linenumber" name="L411" href="#L411">411</a> -<a class="jxr_linenumber" name="L412" href="#L412">412</a> <strong class="jxr_keyword">if</strong> ( benchmark ) -<a class="jxr_linenumber" name="L413" href="#L413">413</a> { -<a class="jxr_linenumber" name="L414" href="#L414">414</a> <strong class="jxr_keyword">try</strong> ( PrintStream benchmarkFileStream = <strong class="jxr_keyword">new</strong> PrintStream( benchmarkOutputFilename ) ) -<a class="jxr_linenumber" name="L415" href="#L415">415</a> { -<a class="jxr_linenumber" name="L416" href="#L416">416</a> ( <strong class="jxr_keyword">new</strong> TextReport() ).generate( Benchmarker.values(), benchmarkFileStream ); -<a class="jxr_linenumber" name="L417" href="#L417">417</a> } -<a class="jxr_linenumber" name="L418" href="#L418">418</a> <strong class="jxr_keyword">catch</strong> ( FileNotFoundException fnfe ) -<a class="jxr_linenumber" name="L419" href="#L419">419</a> { -<a class="jxr_linenumber" name="L420" href="#L420">420</a> getLog().error( <span class="jxr_string">"Unable to generate benchmark file: "</span> + benchmarkOutputFilename, fnfe ); +<a class="jxr_linenumber" name="L405" href="#L405">405</a> <strong class="jxr_keyword">if</strong> ( sets.length > 0 ) +<a class="jxr_linenumber" name="L406" href="#L406">406</a> { +<a class="jxr_linenumber" name="L407" href="#L407">407</a> processFilesWithPMD( pmdConfiguration, dataSources ); +<a class="jxr_linenumber" name="L408" href="#L408">408</a> } +<a class="jxr_linenumber" name="L409" href="#L409">409</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="L410" href="#L410">410</a> { +<a class="jxr_linenumber" name="L411" href="#L411">411</a> getLog().debug( <span class="jxr_string">"Skipping PMD execution as no rulesets are defined."</span> ); +<a class="jxr_linenumber" name="L412" href="#L412">412</a> } +<a class="jxr_linenumber" name="L413" href="#L413">413</a> +<a class="jxr_linenumber" name="L414" href="#L414">414</a> <strong class="jxr_keyword">if</strong> ( renderer.hasErrors() ) +<a class="jxr_linenumber" name="L415" href="#L415">415</a> { +<a class="jxr_linenumber" name="L416" href="#L416">416</a> <strong class="jxr_keyword">if</strong> ( !skipPmdError ) +<a class="jxr_linenumber" name="L417" href="#L417">417</a> { +<a class="jxr_linenumber" name="L418" href="#L418">418</a> getLog().error( <span class="jxr_string">"PMD processing errors:"</span> ); +<a class="jxr_linenumber" name="L419" href="#L419">419</a> getLog().error( renderer.getErrorsAsString() ); +<a class="jxr_linenumber" name="L420" href="#L420">420</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Found "</span> + renderer.getErrors().size() + <span class="jxr_string">" PMD processing errors"</span> ); <a class="jxr_linenumber" name="L421" href="#L421">421</a> } -<a class="jxr_linenumber" name="L422" href="#L422">422</a> } -<a class="jxr_linenumber" name="L423" href="#L423">423</a> } -<a class="jxr_linenumber" name="L424" href="#L424">424</a> -<a class="jxr_linenumber" name="L425" href="#L425">425</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> removeExcludedViolations( List<RuleViolation> violations ) -<a class="jxr_linenumber" name="L426" href="#L426">426</a> { -<a class="jxr_linenumber" name="L427" href="#L427">427</a> getLog().debug( <span class="jxr_string">"Removing excluded violations. Using "</span> + excludeFromFile.countExclusions() -<a class="jxr_linenumber" name="L428" href="#L428">428</a> + <span class="jxr_string">" configured exclusions."</span> ); -<a class="jxr_linenumber" name="L429" href="#L429">429</a> <strong class="jxr_keyword">int</strong> violationsBefore = violations.size(); -<a class="jxr_linenumber" name="L430" href="#L430">430</a> -<a class="jxr_linenumber" name="L431" href="#L431">431</a> Iterator<RuleViolation> iterator = violations.iterator(); -<a class="jxr_linenumber" name="L432" href="#L432">432</a> <strong class="jxr_keyword">while</strong> ( iterator.hasNext() ) -<a class="jxr_linenumber" name="L433" href="#L433">433</a> { -<a class="jxr_linenumber" name="L434" href="#L434">434</a> RuleViolation rv = iterator.next(); -<a class="jxr_linenumber" name="L435" href="#L435">435</a> <strong class="jxr_keyword">if</strong> ( excludeFromFile.isExcludedFromFailure( rv ) ) -<a class="jxr_linenumber" name="L436" href="#L436">436</a> { -<a class="jxr_linenumber" name="L437" href="#L437">437</a> iterator.remove(); -<a class="jxr_linenumber" name="L438" href="#L438">438</a> } -<a class="jxr_linenumber" name="L439" href="#L439">439</a> } -<a class="jxr_linenumber" name="L440" href="#L440">440</a> -<a class="jxr_linenumber" name="L441" href="#L441">441</a> <strong class="jxr_keyword">int</strong> numberOfExcludedViolations = violationsBefore - violations.size(); -<a class="jxr_linenumber" name="L442" href="#L442">442</a> getLog().debug( <span class="jxr_string">"Excluded "</span> + numberOfExcludedViolations + <span class="jxr_string">" violations."</span> ); -<a class="jxr_linenumber" name="L443" href="#L443">443</a> } -<a class="jxr_linenumber" name="L444" href="#L444">444</a> -<a class="jxr_linenumber" name="L445" href="#L445">445</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> processFilesWithPMD( PMDConfiguration pmdConfiguration, List<DataSource> dataSources ) -<a class="jxr_linenumber" name="L446" href="#L446">446</a> <strong class="jxr_keyword">throws</strong> MavenReportException -<a class="jxr_linenumber" name="L447" href="#L447">447</a> { -<a class="jxr_linenumber" name="L448" href="#L448">448</a> RuleSetFactory ruleSetFactory = <strong class="jxr_keyword">new</strong> RuleSetFactory(); -<a class="jxr_linenumber" name="L449" href="#L449">449</a> ruleSetFactory.setMinimumPriority( RulePriority.valueOf( <strong class="jxr_keyword">this</strong>.minimumPriority ) ); -<a class="jxr_linenumber" name="L450" href="#L450">450</a> RuleContext ruleContext = <strong class="jxr_keyword">new</strong> RuleContext(); -<a class="jxr_linenumber" name="L451" href="#L451">451</a> -<a class="jxr_linenumber" name="L452" href="#L452">452</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L453" href="#L453">453</a> { -<a class="jxr_linenumber" name="L454" href="#L454">454</a> getLog().debug( <span class="jxr_string">"Executing PMD..."</span> ); -<a class="jxr_linenumber" name="L455" href="#L455">455</a> PMD.processFiles( pmdConfiguration, ruleSetFactory, dataSources, ruleContext, -<a class="jxr_linenumber" name="L456" href="#L456">456</a> Arrays.<Renderer>asList( renderer ) ); -<a class="jxr_linenumber" name="L457" href="#L457">457</a> -<a class="jxr_linenumber" name="L458" href="#L458">458</a> <strong class="jxr_keyword">if</strong> ( getLog().isDebugEnabled() ) +<a class="jxr_linenumber" name="L422" href="#L422">422</a> getLog().warn( <span class="jxr_string">"There are "</span> + renderer.getErrors().size() + <span class="jxr_string">" PMD processing errors:"</span> ); +<a class="jxr_linenumber" name="L423" href="#L423">423</a> getLog().warn( renderer.getErrorsAsString() ); +<a class="jxr_linenumber" name="L424" href="#L424">424</a> } +<a class="jxr_linenumber" name="L425" href="#L425">425</a> +<a class="jxr_linenumber" name="L426" href="#L426">426</a> removeExcludedViolations( renderer.getViolations() ); +<a class="jxr_linenumber" name="L427" href="#L427">427</a> +<a class="jxr_linenumber" name="L428" href="#L428">428</a> <em class="jxr_comment">// if format is XML, we need to output it even if the file list is empty or we have no violations</em> +<a class="jxr_linenumber" name="L429" href="#L429">429</a> <em class="jxr_comment">// so the "check" goals can check for violations</em> +<a class="jxr_linenumber" name="L430" href="#L430">430</a> <strong class="jxr_keyword">if</strong> ( isXml() && renderer != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L431" href="#L431">431</a> { +<a class="jxr_linenumber" name="L432" href="#L432">432</a> writeNonHtml( renderer.asReport() ); +<a class="jxr_linenumber" name="L433" href="#L433">433</a> } +<a class="jxr_linenumber" name="L434" href="#L434">434</a> +<a class="jxr_linenumber" name="L435" href="#L435">435</a> <strong class="jxr_keyword">if</strong> ( benchmark ) +<a class="jxr_linenumber" name="L436" href="#L436">436</a> { +<a class="jxr_linenumber" name="L437" href="#L437">437</a> <strong class="jxr_keyword">try</strong> ( PrintStream benchmarkFileStream = <strong class="jxr_keyword">new</strong> PrintStream( benchmarkOutputFilename ) ) +<a class="jxr_linenumber" name="L438" href="#L438">438</a> { +<a class="jxr_linenumber" name="L439" href="#L439">439</a> ( <strong class="jxr_keyword">new</strong> TextReport() ).generate( Benchmarker.values(), benchmarkFileStream ); +<a class="jxr_linenumber" name="L440" href="#L440">440</a> } +<a class="jxr_linenumber" name="L441" href="#L441">441</a> <strong class="jxr_keyword">catch</strong> ( FileNotFoundException fnfe ) +<a class="jxr_linenumber" name="L442" href="#L442">442</a> { +<a class="jxr_linenumber" name="L443" href="#L443">443</a> getLog().error( <span class="jxr_string">"Unable to generate benchmark file: "</span> + benchmarkOutputFilename, fnfe ); +<a class="jxr_linenumber" name="L444" href="#L444">444</a> } +<a class="jxr_linenumber" name="L445" href="#L445">445</a> } +<a class="jxr_linenumber" name="L446" href="#L446">446</a> } +<a class="jxr_linenumber" name="L447" href="#L447">447</a> +<a class="jxr_linenumber" name="L448" href="#L448">448</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> removeExcludedViolations( List<RuleViolation> violations ) +<a class="jxr_linenumber" name="L449" href="#L449">449</a> { +<a class="jxr_linenumber" name="L450" href="#L450">450</a> getLog().debug( <span class="jxr_string">"Removing excluded violations. Using "</span> + excludeFromFile.countExclusions() +<a class="jxr_linenumber" name="L451" href="#L451">451</a> + <span class="jxr_string">" configured exclusions."</span> ); +<a class="jxr_linenumber" name="L452" href="#L452">452</a> <strong class="jxr_keyword">int</strong> violationsBefore = violations.size(); +<a class="jxr_linenumber" name="L453" href="#L453">453</a> +<a class="jxr_linenumber" name="L454" href="#L454">454</a> Iterator<RuleViolation> iterator = violations.iterator(); +<a class="jxr_linenumber" name="L455" href="#L455">455</a> <strong class="jxr_keyword">while</strong> ( iterator.hasNext() ) +<a class="jxr_linenumber" name="L456" href="#L456">456</a> { +<a class="jxr_linenumber" name="L457" href="#L457">457</a> RuleViolation rv = iterator.next(); +<a class="jxr_linenumber" name="L458" href="#L458">458</a> <strong class="jxr_keyword">if</strong> ( excludeFromFile.isExcludedFromFailure( rv ) ) <a class="jxr_linenumber" name="L459" href="#L459">459</a> { -<a class="jxr_linenumber" name="L460" href="#L460">460</a> getLog().debug( <span class="jxr_string">"PMD finished. Found "</span> + renderer.getViolations().size() + <span class="jxr_string">" violations."</span> ); +<a class="jxr_linenumber" name="L460" href="#L460">460</a> iterator.remove(); <a class="jxr_linenumber" name="L461" href="#L461">461</a> } <a class="jxr_linenumber" name="L462" href="#L462">462</a> } -<a class="jxr_linenumber" name="L463" href="#L463">463</a> <strong class="jxr_keyword">catch</strong> ( Exception e ) -<a class="jxr_linenumber" name="L464" href="#L464">464</a> { -<a class="jxr_linenumber" name="L465" href="#L465">465</a> String message = <span class="jxr_string">"Failure executing PMD: "</span> + e.getLocalizedMessage(); -<a class="jxr_linenumber" name="L466" href="#L466">466</a> <strong class="jxr_keyword">if</strong> ( !skipPmdError ) -<a class="jxr_linenumber" name="L467" href="#L467">467</a> { -<a class="jxr_linenumber" name="L468" href="#L468">468</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( message, e ); -<a class="jxr_linenumber" name="L469" href="#L469">469</a> } -<a class="jxr_linenumber" name="L470" href="#L470">470</a> getLog().warn( message, e ); -<a class="jxr_linenumber" name="L471" href="#L471">471</a> } -<a class="jxr_linenumber" name="L472" href="#L472">472</a> } -<a class="jxr_linenumber" name="L473" href="#L473">473</a> -<a class="jxr_linenumber" name="L474" href="#L474">474</a> <strong class="jxr_keyword">private</strong> Report generateReport( Locale locale ) -<a class="jxr_linenumber" name="L475" href="#L475">475</a> <strong class="jxr_keyword">throws</strong> MavenReportException -<a class="jxr_linenumber" name="L476" href="#L476">476</a> { -<a class="jxr_linenumber" name="L477" href="#L477">477</a> Sink sink = getSink(); -<a class="jxr_linenumber" name="L478" href="#L478">478</a> <a href="../../../../../org/apache/maven/plugin/pmd/PmdReportGenerator.html">PmdReportGenerator</a> doxiaRenderer = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/pmd/PmdReportGenerator.html">PmdReportGenerator</a>( getLog(), sink, getBundle( locale ), aggregate ); -<a class="jxr_linenumber" name="L479" href="#L479">479</a> doxiaRenderer.setFiles( filesToProcess ); -<a class="jxr_linenumber" name="L480" href="#L480">480</a> doxiaRenderer.setViolations( renderer.getViolations() ); -<a class="jxr_linenumber" name="L481" href="#L481">481</a> -<a class="jxr_linenumber" name="L482" href="#L482">482</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L483" href="#L483">483</a> { -<a class="jxr_linenumber" name="L484" href="#L484">484</a> doxiaRenderer.beginDocument(); -<a class="jxr_linenumber" name="L485" href="#L485">485</a> doxiaRenderer.render(); -<a class="jxr_linenumber" name="L486" href="#L486">486</a> doxiaRenderer.endDocument(); -<a class="jxr_linenumber" name="L487" href="#L487">487</a> } -<a class="jxr_linenumber" name="L488" href="#L488">488</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) -<a class="jxr_linenumber" name="L489" href="#L489">489</a> { -<a class="jxr_linenumber" name="L490" href="#L490">490</a> getLog().warn( <span class="jxr_string">"Failure creating the report: "</span> + e.getLocalizedMessage(), e ); -<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> <strong class="jxr_keyword">return</strong> renderer.asReport(); -<a class="jxr_linenumber" name="L494" href="#L494">494</a> } -<a class="jxr_linenumber" name="L495" href="#L495">495</a> -<a class="jxr_linenumber" name="L496" href="#L496">496</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L497" href="#L497">497</a> <em class="jxr_javadoccomment"> * Convenience method to get the location of the specified file name.</em> -<a class="jxr_linenumber" name="L498" href="#L498">498</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L499" href="#L499">499</a> <em class="jxr_javadoccomment"> * @param name the name of the file whose location is to be resolved</em> -<a class="jxr_linenumber" name="L500" href="#L500">500</a> <em class="jxr_javadoccomment"> * @return a String that contains the absolute file name of the file</em> -<a class="jxr_linenumber" name="L501" href="#L501">501</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L502" href="#L502">502</a> <strong class="jxr_keyword">protected</strong> String getLocationTemp( String name ) -<a class="jxr_linenumber" name="L503" href="#L503">503</a> { -<a class="jxr_linenumber" name="L504" href="#L504">504</a> String loc = name; -<a class="jxr_linenumber" name="L505" href="#L505">505</a> <strong class="jxr_keyword">if</strong> ( loc.indexOf( '/' ) != -1 ) +<a class="jxr_linenumber" name="L463" href="#L463">463</a> +<a class="jxr_linenumber" name="L464" href="#L464">464</a> <strong class="jxr_keyword">int</strong> numberOfExcludedViolations = violationsBefore - violations.size(); +<a class="jxr_linenumber" name="L465" href="#L465">465</a> getLog().debug( <span class="jxr_string">"Excluded "</span> + numberOfExcludedViolations + <span class="jxr_string">" violations."</span> ); +<a class="jxr_linenumber" name="L466" href="#L466">466</a> } +<a class="jxr_linenumber" name="L467" href="#L467">467</a> +<a class="jxr_linenumber" name="L468" href="#L468">468</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> processFilesWithPMD( PMDConfiguration pmdConfiguration, List<DataSource> dataSources ) +<a class="jxr_linenumber" name="L469" href="#L469">469</a> <strong class="jxr_keyword">throws</strong> MavenReportException +<a class="jxr_linenumber" name="L470" href="#L470">470</a> { +<a class="jxr_linenumber" name="L471" href="#L471">471</a> RuleSetFactory ruleSetFactory = <strong class="jxr_keyword">new</strong> RuleSetFactory( RuleSetFactory.<strong class="jxr_keyword">class</strong>.getClassLoader(), +<a class="jxr_linenumber" name="L472" href="#L472">472</a> RulePriority.valueOf( <strong class="jxr_keyword">this</strong>.minimumPriority ), false, <strong class="jxr_keyword">true</strong> ); +<a class="jxr_linenumber" name="L473" href="#L473">473</a> RuleContext ruleContext = <strong class="jxr_keyword">new</strong> RuleContext(); +<a class="jxr_linenumber" name="L474" href="#L474">474</a> +<a class="jxr_linenumber" name="L475" href="#L475">475</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L476" href="#L476">476</a> { +<a class="jxr_linenumber" name="L477" href="#L477">477</a> getLog().debug( <span class="jxr_string">"Executing PMD..."</span> ); +<a class="jxr_linenumber" name="L478" href="#L478">478</a> PMD.processFiles( pmdConfiguration, ruleSetFactory, dataSources, ruleContext, +<a class="jxr_linenumber" name="L479" href="#L479">479</a> Arrays.<Renderer>asList( renderer ) ); +<a class="jxr_linenumber" name="L480" href="#L480">480</a> +<a class="jxr_linenumber" name="L481" href="#L481">481</a> <strong class="jxr_keyword">if</strong> ( getLog().isDebugEnabled() ) +<a class="jxr_linenumber" name="L482" href="#L482">482</a> { +<a class="jxr_linenumber" name="L483" href="#L483">483</a> getLog().debug( <span class="jxr_string">"PMD finished. Found "</span> + renderer.getViolations().size() + <span class="jxr_string">" violations."</span> ); +<a class="jxr_linenumber" name="L484" href="#L484">484</a> } +<a class="jxr_linenumber" name="L485" href="#L485">485</a> } +<a class="jxr_linenumber" name="L486" href="#L486">486</a> <strong class="jxr_keyword">catch</strong> ( Exception e ) +<a class="jxr_linenumber" name="L487" href="#L487">487</a> { +<a class="jxr_linenumber" name="L488" href="#L488">488</a> String message = <span class="jxr_string">"Failure executing PMD: "</span> + e.getLocalizedMessage(); +<a class="jxr_linenumber" name="L489" href="#L489">489</a> <strong class="jxr_keyword">if</strong> ( !skipPmdError ) +<a class="jxr_linenumber" name="L490" href="#L490">490</a> { +<a class="jxr_linenumber" name="L491" href="#L491">491</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( message, e ); +<a class="jxr_linenumber" name="L492" href="#L492">492</a> } +<a class="jxr_linenumber" name="L493" href="#L493">493</a> getLog().warn( message, e ); +<a class="jxr_linenumber" name="L494" href="#L494">494</a> } +<a class="jxr_linenumber" name="L495" href="#L495">495</a> } +<a class="jxr_linenumber" name="L496" href="#L496">496</a> +<a class="jxr_linenumber" name="L497" href="#L497">497</a> <strong class="jxr_keyword">private</strong> Report generateReport( Locale locale ) +<a class="jxr_linenumber" name="L498" href="#L498">498</a> <strong class="jxr_keyword">throws</strong> MavenReportException +<a class="jxr_linenumber" name="L499" href="#L499">499</a> { +<a class="jxr_linenumber" name="L500" href="#L500">500</a> Sink sink = getSink(); +<a class="jxr_linenumber" name="L501" href="#L501">501</a> <a href="../../../../../org/apache/maven/plugin/pmd/PmdReportGenerator.html">PmdReportGenerator</a> doxiaRenderer = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/pmd/PmdReportGenerator.html">PmdReportGenerator</a>( getLog(), sink, getBundle( locale ), aggregate ); +<a class="jxr_linenumber" name="L502" href="#L502">502</a> doxiaRenderer.setFiles( filesToProcess ); +<a class="jxr_linenumber" name="L503" href="#L503">503</a> doxiaRenderer.setViolations( renderer.getViolations() ); +<a class="jxr_linenumber" name="L504" href="#L504">504</a> +<a class="jxr_linenumber" name="L505" href="#L505">505</a> <strong class="jxr_keyword">try</strong> <a class="jxr_linenumber" name="L506" href="#L506">506</a> { -<a class="jxr_linenumber" name="L507" href="#L507">507</a> loc = loc.substring( loc.lastIndexOf( '/' ) + 1 ); -<a class="jxr_linenumber" name="L508" href="#L508">508</a> } -<a class="jxr_linenumber" name="L509" href="#L509">509</a> <strong class="jxr_keyword">if</strong> ( loc.indexOf( '\\' ) != -1 ) -<a class="jxr_linenumber" name="L510" href="#L510">510</a> { -<a class="jxr_linenumber" name="L511" href="#L511">511</a> loc = loc.substring( loc.lastIndexOf( '\\' ) + 1 ); -<a class="jxr_linenumber" name="L512" href="#L512">512</a> } -<a class="jxr_linenumber" name="L513" href="#L513">513</a> -<a class="jxr_linenumber" name="L514" href="#L514">514</a> <em class="jxr_comment">// MPMD-127 in the case that the rules are defined externally on a url</em> -<a class="jxr_linenumber" name="L515" href="#L515">515</a> <em class="jxr_comment">// we need to replace some special url characters that cannot be</em> -<a class="jxr_linenumber" name="L516" href="#L516">516</a> <em class="jxr_comment">// used in filenames on disk or produce ackward filenames.</em> -<a class="jxr_linenumber" name="L517" href="#L517">517</a> <em class="jxr_comment">// replace all occurrences of the following characters: ? : & = %</em> -<a class="jxr_linenumber" name="L518" href="#L518">518</a> loc = loc.replaceAll( <span class="jxr_string">"[\\?\\:\\&\\=\\%]"</span>, <span class="jxr_string">"_"</span> ); -<a class="jxr_linenumber" name="L519" href="#L519">519</a> -<a class="jxr_linenumber" name="L520" href="#L520">520</a> <strong class="jxr_keyword">if</strong> ( !loc.endsWith( <span class="jxr_string">".xml"</span> ) ) -<a class="jxr_linenumber" name="L521" href="#L521">521</a> { -<a class="jxr_linenumber" name="L522" href="#L522">522</a> loc = loc + <span class="jxr_string">".xml"</span>; -<a class="jxr_linenumber" name="L523" href="#L523">523</a> } -<a class="jxr_linenumber" name="L524" href="#L524">524</a> -<a class="jxr_linenumber" name="L525" href="#L525">525</a> getLog().debug( <span class="jxr_string">"Before: "</span> + name + <span class="jxr_string">" After: "</span> + loc ); -<a class="jxr_linenumber" name="L526" href="#L526">526</a> <strong class="jxr_keyword">return</strong> loc; -<a class="jxr_linenumber" name="L527" href="#L527">527</a> } -<a class="jxr_linenumber" name="L528" href="#L528">528</a> -<a class="jxr_linenumber" name="L529" href="#L529">529</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L530" href="#L530">530</a> <em class="jxr_javadoccomment"> * Use the PMD renderers to render in any format aside from HTML.</em> -<a class="jxr_linenumber" name="L531" href="#L531">531</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L532" href="#L532">532</a> <em class="jxr_javadoccomment"> * @param report</em> -<a class="jxr_linenumber" name="L533" href="#L533">533</a> <em class="jxr_javadoccomment"> * @throws MavenReportException</em> -<a class="jxr_linenumber" name="L534" href="#L534">534</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L535" href="#L535">535</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeNonHtml( Report report ) -<a class="jxr_linenumber" name="L536" href="#L536">536</a> <strong class="jxr_keyword">throws</strong> MavenReportException -<a class="jxr_linenumber" name="L537" href="#L537">537</a> { -<a class="jxr_linenumber" name="L538" href="#L538">538</a> Renderer r = createRenderer(); -<a class="jxr_linenumber" name="L539" href="#L539">539</a> -<a class="jxr_linenumber" name="L540" href="#L540">540</a> <strong class="jxr_keyword">if</strong> ( r == <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L541" href="#L541">541</a> { -<a class="jxr_linenumber" name="L542" href="#L542">542</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L543" href="#L543">543</a> } -<a class="jxr_linenumber" name="L544" href="#L544">544</a> -<a class="jxr_linenumber" name="L545" href="#L545">545</a> File targetFile = <strong class="jxr_keyword">new</strong> File( targetDirectory, <span class="jxr_string">"pmd."</span> + format ); -<a class="jxr_linenumber" name="L546" href="#L546">546</a> <strong class="jxr_keyword">try</strong> ( Writer writer = <strong class="jxr_keyword">new</strong> OutputStreamWriter( <strong class="jxr_keyword">new</strong> FileOutputStream( targetFile ), getOutputEncoding() ) ) -<a class="jxr_linenumber" name="L547" href="#L547">547</a> { -<a class="jxr_linenumber" name="L548" href="#L548">548</a> targetDirectory.mkdirs(); -<a class="jxr_linenumber" name="L549" href="#L549">549</a> -<a class="jxr_linenumber" name="L550" href="#L550">550</a> r.setWriter( writer ); -<a class="jxr_linenumber" name="L551" href="#L551">551</a> r.start(); -<a class="jxr_linenumber" name="L552" href="#L552">552</a> r.renderFileReport( report ); -<a class="jxr_linenumber" name="L553" href="#L553">553</a> r.end(); -<a class="jxr_linenumber" name="L554" href="#L554">554</a> -<a class="jxr_linenumber" name="L555" href="#L555">555</a> <strong class="jxr_keyword">if</strong> ( includeXmlInSite ) -<a class="jxr_linenumber" name="L556" href="#L556">556</a> { -<a class="jxr_linenumber" name="L557" href="#L557">557</a> File siteDir = getReportOutputDirectory(); -<a class="jxr_linenumber" name="L558" href="#L558">558</a> siteDir.mkdirs(); -<a class="jxr_linenumber" name="L559" href="#L559">559</a> FileUtils.copyFile( targetFile, <strong class="jxr_keyword">new</strong> File( siteDir, <span class="jxr_string">"pmd."</span> + format ) ); -<a class="jxr_linenumber" name="L560" href="#L560">560</a> } -<a class="jxr_linenumber" name="L561" href="#L561">561</a> } -<a class="jxr_linenumber" name="L562" href="#L562">562</a> <strong class="jxr_keyword">catch</strong> ( IOException ioe ) -<a class="jxr_linenumber" name="L563" href="#L563">563</a> { -<a class="jxr_linenumber" name="L564" href="#L564">564</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( ioe.getMessage(), ioe ); -<a class="jxr_linenumber" name="L565" href="#L565">565</a> } -<a class="jxr_linenumber" name="L566" href="#L566">566</a> } +<a class="jxr_linenumber" name="L507" href="#L507">507</a> doxiaRenderer.beginDocument(); +<a class="jxr_linenumber" name="L508" href="#L508">508</a> doxiaRenderer.render(); +<a class="jxr_linenumber" name="L509" href="#L509">509</a> doxiaRenderer.endDocument(); +<a class="jxr_linenumber" name="L510" href="#L510">510</a> } +<a class="jxr_linenumber" name="L511" href="#L511">511</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) +<a class="jxr_linenumber" name="L512" href="#L512">512</a> { +<a class="jxr_linenumber" name="L513" href="#L513">513</a> getLog().warn( <span class="jxr_string">"Failure creating the report: "</span> + e.getLocalizedMessage(), e ); +<a class="jxr_linenumber" name="L514" href="#L514">514</a> } +<a class="jxr_linenumber" name="L515" href="#L515">515</a> +<a class="jxr_linenumber" name="L516" href="#L516">516</a> <strong class="jxr_keyword">return</strong> renderer.asReport(); +<a class="jxr_linenumber" name="L517" href="#L517">517</a> } +<a class="jxr_linenumber" name="L518" href="#L518">518</a> +<a class="jxr_linenumber" name="L519" href="#L519">519</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L520" href="#L520">520</a> <em class="jxr_javadoccomment"> * Convenience method to get the location of the specified file name.</em> +<a class="jxr_linenumber" name="L521" href="#L521">521</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L522" href="#L522">522</a> <em class="jxr_javadoccomment"> * @param name the name of the file whose location is to be resolved</em> +<a class="jxr_linenumber" name="L523" href="#L523">523</a> <em class="jxr_javadoccomment"> * @return a String that contains the absolute file name of the file</em> +<a class="jxr_linenumber" name="L524" href="#L524">524</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L525" href="#L525">525</a> <strong class="jxr_keyword">protected</strong> String getLocationTemp( String name ) +<a class="jxr_linenumber" name="L526" href="#L526">526</a> { +<a class="jxr_linenumber" name="L527" href="#L527">527</a> String loc = name; +<a class="jxr_linenumber" name="L528" href="#L528">528</a> <strong class="jxr_keyword">if</strong> ( loc.indexOf( '/' ) != -1 ) +<a class="jxr_linenumber" name="L529" href="#L529">529</a> { +<a class="jxr_linenumber" name="L530" href="#L530">530</a> loc = loc.substring( loc.lastIndexOf( '/' ) + 1 ); +<a class="jxr_linenumber" name="L531" href="#L531">531</a> } +<a class="jxr_linenumber" name="L532" href="#L532">532</a> <strong class="jxr_keyword">if</strong> ( loc.indexOf( '\\' ) != -1 ) +<a class="jxr_linenumber" name="L533" href="#L533">533</a> { +<a class="jxr_linenumber" name="L534" href="#L534">534</a> loc = loc.substring( loc.lastIndexOf( '\\' ) + 1 ); +<a class="jxr_linenumber" name="L535" href="#L535">535</a> } +<a class="jxr_linenumber" name="L536" href="#L536">536</a> +<a class="jxr_linenumber" name="L537" href="#L537">537</a> <em class="jxr_comment">// MPMD-127 in the case that the rules are defined externally on a url</em> +<a class="jxr_linenumber" name="L538" href="#L538">538</a> <em class="jxr_comment">// we need to replace some special url characters that cannot be</em> +<a class="jxr_linenumber" name="L539" href="#L539">539</a> <em class="jxr_comment">// used in filenames on disk or produce ackward filenames.</em> +<a class="jxr_linenumber" name="L540" href="#L540">540</a> <em class="jxr_comment">// replace all occurrences of the following characters: ? : & = %</em> +<a class="jxr_linenumber" name="L541" href="#L541">541</a> loc = loc.replaceAll( <span class="jxr_string">"[\\?\\:\\&\\=\\%]"</span>, <span class="jxr_string">"_"</span> ); +<a class="jxr_linenumber" name="L542" href="#L542">542</a> +<a class="jxr_linenumber" name="L543" href="#L543">543</a> <strong class="jxr_keyword">if</strong> ( !loc.endsWith( <span class="jxr_string">".xml"</span> ) ) +<a class="jxr_linenumber" name="L544" href="#L544">544</a> { +<a class="jxr_linenumber" name="L545" href="#L545">545</a> loc = loc + <span class="jxr_string">".xml"</span>; +<a class="jxr_linenumber" name="L546" href="#L546">546</a> } +<a class="jxr_linenumber" name="L547" href="#L547">547</a> +<a class="jxr_linenumber" name="L548" href="#L548">548</a> getLog().debug( <span class="jxr_string">"Before: "</span> + name + <span class="jxr_string">" After: "</span> + loc ); +<a class="jxr_linenumber" name="L549" href="#L549">549</a> <strong class="jxr_keyword">return</strong> loc; +<a class="jxr_linenumber" name="L550" href="#L550">550</a> } +<a class="jxr_linenumber" name="L551" href="#L551">551</a> +<a class="jxr_linenumber" name="L552" href="#L552">552</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L553" href="#L553">553</a> <em class="jxr_javadoccomment"> * Use the PMD renderers to render in any format aside from HTML.</em> +<a class="jxr_linenumber" name="L554" href="#L554">554</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L555" href="#L555">555</a> <em class="jxr_javadoccomment"> * @param report</em> +<a class="jxr_linenumber" name="L556" href="#L556">556</a> <em class="jxr_javadoccomment"> * @throws MavenReportException</em> +<a class="jxr_linenumber" name="L557" href="#L557">557</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L558" href="#L558">558</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeNonHtml( Report report ) +<a class="jxr_linenumber" name="L559" href="#L559">559</a> <strong class="jxr_keyword">throws</strong> MavenReportException +<a class="jxr_linenumber" name="L560" href="#L560">560</a> { +<a class="jxr_linenumber" name="L561" href="#L561">561</a> Renderer r = createRenderer(); +<a class="jxr_linenumber" name="L562" href="#L562">562</a> +<a class="jxr_linenumber" name="L563" href="#L563">563</a> <strong class="jxr_keyword">if</strong> ( r == <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L564" href="#L564">564</a> { +<a class="jxr_linenumber" name="L565" href="#L565">565</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L566" href="#L566">566</a> } <a class="jxr_linenumber" name="L567" href="#L567">567</a> -<a class="jxr_linenumber" name="L568" href="#L568">568</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L569" href="#L569">569</a> <em class="jxr_javadoccomment"> * Constructs the PMD configuration class, passing it an argument that configures the target JDK.</em> -<a class="jxr_linenumber" name="L570" href="#L570">570</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L571" href="#L571">571</a> <em class="jxr_javadoccomment"> * @return the resulting PMD</em> -<a class="jxr_linenumber" name="L572" href="#L572">572</a> <em class="jxr_javadoccomment"> * @throws org.apache.maven.reporting.MavenReportException if targetJdk is not supported</em> -<a class="jxr_linenumber" name="L573" href="#L573">573</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L574" href="#L574">574</a> <strong class="jxr_keyword">public</strong> PMDConfiguration getPMDConfiguration() -<a class="jxr_linenumber" name="L575" href="#L575">575</a> <strong class="jxr_keyword">throws</strong> MavenReportException -<a class="jxr_linenumber" name="L576" href="#L576">576</a> { -<a class="jxr_linenumber" name="L577" href="#L577">577</a> PMDConfiguration configuration = <strong class="jxr_keyword">new</strong> PMDConfiguration(); -<a class="jxr_linenumber" name="L578" href="#L578">578</a> LanguageVersion languageVersion = <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L579" href="#L579">579</a> -<a class="jxr_linenumber" name="L580" href="#L580">580</a> <strong class="jxr_keyword">if</strong> ( ( <span class="jxr_string">"java"</span>.equals( language ) || <strong class="jxr_keyword">null</strong> == language ) && <strong class="jxr_keyword">null</strong> != targetJdk ) -<a class="jxr_linenumber" name="L581" href="#L581">581</a> { -<a class="jxr_linenumber" name="L582" href="#L582">582</a> languageVersion = LanguageRegistry.findLanguageVersionByTerseName( <span class="jxr_string">"java "</span> + targetJdk ); -<a class="jxr_linenumber" name="L583" href="#L583">583</a> <strong class="jxr_keyword">if</strong> ( languageVersion == <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L584" href="#L584">584</a> { -<a class="jxr_linenumber" name="L585" href="#L585">585</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Unsupported targetJdk value '"</span> + targetJdk + <span class="jxr_string">"'."</span> );
[... 249 lines stripped ...]