Modified: maven/website/components/plugins-archives/maven-checkstyle-plugin-LATEST/xref/org/apache/maven/plugins/checkstyle/CheckstyleReportRenderer.html ============================================================================== --- maven/website/components/plugins-archives/maven-checkstyle-plugin-LATEST/xref/org/apache/maven/plugins/checkstyle/CheckstyleReportRenderer.html (original) +++ maven/website/components/plugins-archives/maven-checkstyle-plugin-LATEST/xref/org/apache/maven/plugins/checkstyle/CheckstyleReportRenderer.html Sun Jun 2 14:48:29 2024 @@ -250,473 +250,474 @@ <a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_comment">// column 2: Rule name + configured attributes</em> <a class="jxr_linenumber" name="L243" href="#L243">243</a> sink.tableCell(); <a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">if</strong> (!<span class="jxr_string">"extension"</span>.equals(category)) { -<a class="jxr_linenumber" name="L245" href="#L245">245</a> sink.link(<span class="jxr_string">"https://checkstyle.org/config_"</span> + category + <span class="jxr_string">".html#"</span> + ruleName); -<a class="jxr_linenumber" name="L246" href="#L246">246</a> sink.text(ruleName); -<a class="jxr_linenumber" name="L247" href="#L247">247</a> sink.link_(); -<a class="jxr_linenumber" name="L248" href="#L248">248</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L249" href="#L249">249</a> sink.text(ruleName); -<a class="jxr_linenumber" name="L250" href="#L250">250</a> } -<a class="jxr_linenumber" name="L251" href="#L251">251</a> -<a class="jxr_linenumber" name="L252" href="#L252">252</a> List<String> attribnames = <strong class="jxr_keyword">new</strong> ArrayList<>(Arrays.asList(checkerConfig.getAttributeNames())); -<a class="jxr_linenumber" name="L253" href="#L253">253</a> attribnames.remove(<span class="jxr_string">"severity"</span>); <em class="jxr_comment">// special value (deserves unique column)</em> -<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">if</strong> (!attribnames.isEmpty()) { -<a class="jxr_linenumber" name="L255" href="#L255">255</a> sink.list(); -<a class="jxr_linenumber" name="L256" href="#L256">256</a> <strong class="jxr_keyword">for</strong> (String name : attribnames) { -<a class="jxr_linenumber" name="L257" href="#L257">257</a> sink.listItem(); -<a class="jxr_linenumber" name="L258" href="#L258">258</a> -<a class="jxr_linenumber" name="L259" href="#L259">259</a> sink.text(name); -<a class="jxr_linenumber" name="L260" href="#L260">260</a> -<a class="jxr_linenumber" name="L261" href="#L261">261</a> String value = getConfigAttribute(checkerConfig, <strong class="jxr_keyword">null</strong>, name, <span class="jxr_string">""</span>); -<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_comment">// special case, Header.header and RegexpHeader.header</em> -<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"header"</span>.equals(name) && (<span class="jxr_string">"Header"</span>.equals(ruleName) || <span class="jxr_string">"RegexpHeader"</span>.equals(ruleName))) { -<a class="jxr_linenumber" name="L264" href="#L264">264</a> String[] lines = StringUtils.split(value, <span class="jxr_string">"\\n"</span>); -<a class="jxr_linenumber" name="L265" href="#L265">265</a> <strong class="jxr_keyword">int</strong> linenum = 1; -<a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong class="jxr_keyword">for</strong> (String line : lines) { -<a class="jxr_linenumber" name="L267" href="#L267">267</a> sink.lineBreak(); -<a class="jxr_linenumber" name="L268" href="#L268">268</a> sink.rawText(<span class="jxr_string">"<span style=\"color: gray\">"</span>); -<a class="jxr_linenumber" name="L269" href="#L269">269</a> sink.text(linenum + <span class="jxr_string">":"</span>); -<a class="jxr_linenumber" name="L270" href="#L270">270</a> sink.rawText(<span class="jxr_string">"</span>"</span>); -<a class="jxr_linenumber" name="L271" href="#L271">271</a> sink.nonBreakingSpace(); -<a class="jxr_linenumber" name="L272" href="#L272">272</a> sink.monospaced(); -<a class="jxr_linenumber" name="L273" href="#L273">273</a> sink.text(line); -<a class="jxr_linenumber" name="L274" href="#L274">274</a> sink.monospaced_(); -<a class="jxr_linenumber" name="L275" href="#L275">275</a> linenum++; -<a class="jxr_linenumber" name="L276" href="#L276">276</a> } -<a class="jxr_linenumber" name="L277" href="#L277">277</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"headerFile"</span>.equals(name) && <span class="jxr_string">"RegexpHeader"</span>.equals(ruleName)) { -<a class="jxr_linenumber" name="L278" href="#L278">278</a> sink.text(<span class="jxr_string">": "</span>); -<a class="jxr_linenumber" name="L279" href="#L279">279</a> sink.monospaced(); -<a class="jxr_linenumber" name="L280" href="#L280">280</a> sink.text(<span class="jxr_string">"\""</span>); -<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_comment">// Make the headerFile value relative to ${basedir}</em> -<a class="jxr_linenumber" name="L282" href="#L282">282</a> String path = -<a class="jxr_linenumber" name="L283" href="#L283">283</a> siteTool.getRelativePath(value, project.getBasedir().getAbsolutePath()); -<a class="jxr_linenumber" name="L284" href="#L284">284</a> sink.text(path.replace('\\', '/')); -<a class="jxr_linenumber" name="L285" href="#L285">285</a> sink.text(value); -<a class="jxr_linenumber" name="L286" href="#L286">286</a> sink.text(<span class="jxr_string">"\""</span>); -<a class="jxr_linenumber" name="L287" href="#L287">287</a> sink.monospaced_(); -<a class="jxr_linenumber" name="L288" href="#L288">288</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L289" href="#L289">289</a> sink.text(<span class="jxr_string">": "</span>); -<a class="jxr_linenumber" name="L290" href="#L290">290</a> sink.monospaced(); -<a class="jxr_linenumber" name="L291" href="#L291">291</a> sink.text(<span class="jxr_string">"\""</span>); -<a class="jxr_linenumber" name="L292" href="#L292">292</a> sink.text(value); -<a class="jxr_linenumber" name="L293" href="#L293">293</a> sink.text(<span class="jxr_string">"\""</span>); -<a class="jxr_linenumber" name="L294" href="#L294">294</a> sink.monospaced_(); -<a class="jxr_linenumber" name="L295" href="#L295">295</a> } -<a class="jxr_linenumber" name="L296" href="#L296">296</a> sink.listItem_(); -<a class="jxr_linenumber" name="L297" href="#L297">297</a> } -<a class="jxr_linenumber" name="L298" href="#L298">298</a> sink.list_(); -<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> sink.tableCell_(); -<a class="jxr_linenumber" name="L302" href="#L302">302</a> -<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_comment">// column 3: rule violation count</em> -<a class="jxr_linenumber" name="L304" href="#L304">304</a> sink.tableCell(); -<a class="jxr_linenumber" name="L305" href="#L305">305</a> sink.text(String.valueOf(ref.violations)); -<a class="jxr_linenumber" name="L306" href="#L306">306</a> sink.tableCell_(); -<a class="jxr_linenumber" name="L307" href="#L307">307</a> -<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_comment">// column 4: severity</em> -<a class="jxr_linenumber" name="L309" href="#L309">309</a> sink.tableCell(); -<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_comment">// Grab the severity from the rule configuration, this time use error as default value</em> -<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_comment">// Also pass along all parent configurations, so that we can try to find the severity there</em> -<a class="jxr_linenumber" name="L312" href="#L312">312</a> String severity = getConfigAttribute(checkerConfig, parentConfiguration, <span class="jxr_string">"severity"</span>, <span class="jxr_string">"error"</span>); -<a class="jxr_linenumber" name="L313" href="#L313">313</a> iconSeverity(severity, TEXT_SIMPLE); -<a class="jxr_linenumber" name="L314" href="#L314">314</a> sink.tableCell_(); -<a class="jxr_linenumber" name="L315" href="#L315">315</a> -<a class="jxr_linenumber" name="L316" href="#L316">316</a> sink.tableRow_(); -<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> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> * Check if a violation matches a rule.</em> -<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"> * @param event the violation to check</em> -<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment"> * @param ruleName The name of the rule</em> -<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_javadoccomment"> * @param expectedMessage A message that, if it's not null, will be matched to the message from the violation</em> -<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment"> * @param expectedSeverity A severity that, if it's not null, will be matched to the severity from the violation</em> -<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment"> * @return The number of rule violations</em> -<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> matchRule(AuditEvent event, String ruleName, String expectedMessage, String expectedSeverity) { -<a class="jxr_linenumber" name="L329" href="#L329">329</a> <strong class="jxr_keyword">if</strong> (!ruleName.equals(RuleUtil.getName(event))) { -<a class="jxr_linenumber" name="L330" href="#L330">330</a> <strong class="jxr_keyword">return</strong> false; -<a class="jxr_linenumber" name="L331" href="#L331">331</a> } -<a class="jxr_linenumber" name="L332" href="#L332">332</a> -<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_comment">// check message too, for those that have a specific one.</em> -<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_comment">// like GenericIllegalRegexp and Regexp</em> -<a class="jxr_linenumber" name="L335" href="#L335">335</a> <strong class="jxr_keyword">if</strong> (expectedMessage != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_comment">// event.getMessage() uses java.text.MessageFormat in its implementation.</em> -<a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_comment">// Read MessageFormat Javadoc about single quote:</em> -<a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_comment">// http://java.sun.com/j2se/1.4.2/docs/api/java/text/MessageFormat.html</em> -<a class="jxr_linenumber" name="L339" href="#L339">339</a> String msgWithoutSingleQuote = StringUtils.replace(expectedMessage, <span class="jxr_string">"'"</span>, <span class="jxr_string">""</span>); -<a class="jxr_linenumber" name="L340" href="#L340">340</a> -<a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong class="jxr_keyword">if</strong> (!(expectedMessage.equals(event.getMessage()) || msgWithoutSingleQuote.equals(event.getMessage()))) { -<a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">return</strong> false; -<a class="jxr_linenumber" name="L343" href="#L343">343</a> } -<a class="jxr_linenumber" name="L344" href="#L344">344</a> } -<a class="jxr_linenumber" name="L345" href="#L345">345</a> <em class="jxr_comment">// Check the severity. This helps to distinguish between</em> -<a class="jxr_linenumber" name="L346" href="#L346">346</a> <em class="jxr_comment">// different configurations for the same rule, where each</em> -<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_comment">// configuration has a different severity, like JavadocMethod.</em> -<a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_comment">// See also https://issues.apache.org/jira/browse/MCHECKSTYLE-41</em> -<a class="jxr_linenumber" name="L349" href="#L349">349</a> <strong class="jxr_keyword">if</strong> (expectedSeverity != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L350" href="#L350">350</a> <strong class="jxr_keyword">if</strong> (!expectedSeverity.equals(event.getSeverityLevel().getName())) { -<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">return</strong> false; -<a class="jxr_linenumber" name="L352" href="#L352">352</a> } -<a class="jxr_linenumber" name="L353" href="#L353">353</a> } -<a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; -<a class="jxr_linenumber" name="L355" href="#L355">355</a> } -<a class="jxr_linenumber" name="L356" href="#L356">356</a> -<a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> renderSeveritySummarySection() { -<a class="jxr_linenumber" name="L358" href="#L358">358</a> <strong class="jxr_keyword">if</strong> (!enableSeveritySummary) { -<a class="jxr_linenumber" name="L359" href="#L359">359</a> <strong class="jxr_keyword">return</strong>; -<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> startSection(getI18nString(<span class="jxr_string">"summary"</span>)); -<a class="jxr_linenumber" name="L363" href="#L363">363</a> -<a class="jxr_linenumber" name="L364" href="#L364">364</a> startTable(); -<a class="jxr_linenumber" name="L365" href="#L365">365</a> -<a class="jxr_linenumber" name="L366" href="#L366">366</a> sink.tableRow(); -<a class="jxr_linenumber" name="L367" href="#L367">367</a> sink.tableHeaderCell(); -<a class="jxr_linenumber" name="L368" href="#L368">368</a> sink.text(getI18nString(<span class="jxr_string">"files"</span>)); -<a class="jxr_linenumber" name="L369" href="#L369">369</a> sink.tableHeaderCell_(); -<a class="jxr_linenumber" name="L370" href="#L370">370</a> -<a class="jxr_linenumber" name="L371" href="#L371">371</a> sink.tableHeaderCell(); -<a class="jxr_linenumber" name="L372" href="#L372">372</a> iconSeverity(<span class="jxr_string">"info"</span>, TEXT_TITLE); -<a class="jxr_linenumber" name="L373" href="#L373">373</a> sink.tableHeaderCell_(); -<a class="jxr_linenumber" name="L374" href="#L374">374</a> -<a class="jxr_linenumber" name="L375" href="#L375">375</a> sink.tableHeaderCell(); -<a class="jxr_linenumber" name="L376" href="#L376">376</a> iconSeverity(<span class="jxr_string">"warning"</span>, TEXT_TITLE); -<a class="jxr_linenumber" name="L377" href="#L377">377</a> sink.tableHeaderCell_(); -<a class="jxr_linenumber" name="L378" href="#L378">378</a> -<a class="jxr_linenumber" name="L379" href="#L379">379</a> sink.tableHeaderCell(); -<a class="jxr_linenumber" name="L380" href="#L380">380</a> iconSeverity(<span class="jxr_string">"error"</span>, TEXT_TITLE); -<a class="jxr_linenumber" name="L381" href="#L381">381</a> sink.tableHeaderCell_(); -<a class="jxr_linenumber" name="L382" href="#L382">382</a> sink.tableRow_(); -<a class="jxr_linenumber" name="L383" href="#L383">383</a> -<a class="jxr_linenumber" name="L384" href="#L384">384</a> tableRow(<strong class="jxr_keyword">new</strong> String[] { -<a class="jxr_linenumber" name="L385" href="#L385">385</a> String.valueOf(results.getFileCount()), -<a class="jxr_linenumber" name="L386" href="#L386">386</a> String.valueOf(results.getSeverityCount(SeverityLevel.INFO)), -<a class="jxr_linenumber" name="L387" href="#L387">387</a> String.valueOf(results.getSeverityCount(SeverityLevel.WARNING)), -<a class="jxr_linenumber" name="L388" href="#L388">388</a> String.valueOf(results.getSeverityCount(SeverityLevel.ERROR)) -<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> endTable(); -<a class="jxr_linenumber" name="L392" href="#L392">392</a> -<a class="jxr_linenumber" name="L393" href="#L393">393</a> endSection(); -<a class="jxr_linenumber" name="L394" href="#L394">394</a> } -<a class="jxr_linenumber" name="L395" href="#L395">395</a> -<a class="jxr_linenumber" name="L396" href="#L396">396</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> renderFilesSummarySection() { -<a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong class="jxr_keyword">if</strong> (!enableFilesSummary) { -<a class="jxr_linenumber" name="L398" href="#L398">398</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L399" href="#L399">399</a> } -<a class="jxr_linenumber" name="L400" href="#L400">400</a> -<a class="jxr_linenumber" name="L401" href="#L401">401</a> startSection(getI18nString(<span class="jxr_string">"files"</span>)); -<a class="jxr_linenumber" name="L402" href="#L402">402</a> -<a class="jxr_linenumber" name="L403" href="#L403">403</a> startTable(); -<a class="jxr_linenumber" name="L404" href="#L404">404</a> -<a class="jxr_linenumber" name="L405" href="#L405">405</a> sink.tableRow(); -<a class="jxr_linenumber" name="L406" href="#L406">406</a> sink.tableHeaderCell(); -<a class="jxr_linenumber" name="L407" href="#L407">407</a> sink.text(getI18nString(<span class="jxr_string">"file"</span>)); -<a class="jxr_linenumber" name="L408" href="#L408">408</a> sink.tableHeaderCell_(); -<a class="jxr_linenumber" name="L409" href="#L409">409</a> sink.tableHeaderCell(); -<a class="jxr_linenumber" name="L410" href="#L410">410</a> iconSeverity(<span class="jxr_string">"info"</span>, TEXT_ABBREV); -<a class="jxr_linenumber" name="L411" href="#L411">411</a> sink.tableHeaderCell_(); -<a class="jxr_linenumber" name="L412" href="#L412">412</a> sink.tableHeaderCell(); -<a class="jxr_linenumber" name="L413" href="#L413">413</a> iconSeverity(<span class="jxr_string">"warning"</span>, TEXT_ABBREV); -<a class="jxr_linenumber" name="L414" href="#L414">414</a> sink.tableHeaderCell_(); -<a class="jxr_linenumber" name="L415" href="#L415">415</a> sink.tableHeaderCell(); -<a class="jxr_linenumber" name="L416" href="#L416">416</a> iconSeverity(<span class="jxr_string">"error"</span>, TEXT_ABBREV); -<a class="jxr_linenumber" name="L417" href="#L417">417</a> sink.tableHeaderCell_(); -<a class="jxr_linenumber" name="L418" href="#L418">418</a> sink.tableRow_(); -<a class="jxr_linenumber" name="L419" href="#L419">419</a> -<a class="jxr_linenumber" name="L420" href="#L420">420</a> <em class="jxr_comment">// Sort the files before writing them to the report</em> -<a class="jxr_linenumber" name="L421" href="#L421">421</a> List<String> fileList = <strong class="jxr_keyword">new</strong> ArrayList<>(results.getFiles().keySet()); -<a class="jxr_linenumber" name="L422" href="#L422">422</a> Collections.sort(fileList); -<a class="jxr_linenumber" name="L423" href="#L423">423</a> -<a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong class="jxr_keyword">for</strong> (String filename : fileList) { -<a class="jxr_linenumber" name="L425" href="#L425">425</a> List<AuditEvent> violations = results.getFileViolations(filename); -<a class="jxr_linenumber" name="L426" href="#L426">426</a> <strong class="jxr_keyword">if</strong> (violations.isEmpty()) { -<a class="jxr_linenumber" name="L427" href="#L427">427</a> <em class="jxr_comment">// skip files without violations</em> -<a class="jxr_linenumber" name="L428" href="#L428">428</a> <strong class="jxr_keyword">continue</strong>; -<a class="jxr_linenumber" name="L429" href="#L429">429</a> } -<a class="jxr_linenumber" name="L430" href="#L430">430</a> -<a class="jxr_linenumber" name="L431" href="#L431">431</a> sink.tableRow(); -<a class="jxr_linenumber" name="L432" href="#L432">432</a> -<a class="jxr_linenumber" name="L433" href="#L433">433</a> sink.tableCell(); -<a class="jxr_linenumber" name="L434" href="#L434">434</a> sink.link(<span class="jxr_string">"#"</span> + DoxiaUtils.encodeId(filename)); -<a class="jxr_linenumber" name="L435" href="#L435">435</a> sink.text(filename); -<a class="jxr_linenumber" name="L436" href="#L436">436</a> sink.link_(); -<a class="jxr_linenumber" name="L437" href="#L437">437</a> sink.tableCell_(); -<a class="jxr_linenumber" name="L438" href="#L438">438</a> -<a class="jxr_linenumber" name="L439" href="#L439">439</a> sink.tableCell(); -<a class="jxr_linenumber" name="L440" href="#L440">440</a> sink.text(String.valueOf(results.getSeverityCount(violations, SeverityLevel.INFO))); -<a class="jxr_linenumber" name="L441" href="#L441">441</a> sink.tableCell_(); -<a class="jxr_linenumber" name="L442" href="#L442">442</a> -<a class="jxr_linenumber" name="L443" href="#L443">443</a> sink.tableCell(); -<a class="jxr_linenumber" name="L444" href="#L444">444</a> sink.text(String.valueOf(results.getSeverityCount(violations, SeverityLevel.WARNING))); -<a class="jxr_linenumber" name="L445" href="#L445">445</a> sink.tableCell_(); -<a class="jxr_linenumber" name="L446" href="#L446">446</a> -<a class="jxr_linenumber" name="L447" href="#L447">447</a> sink.tableCell(); -<a class="jxr_linenumber" name="L448" href="#L448">448</a> sink.text(String.valueOf(results.getSeverityCount(violations, SeverityLevel.ERROR))); -<a class="jxr_linenumber" name="L449" href="#L449">449</a> sink.tableCell_(); -<a class="jxr_linenumber" name="L450" href="#L450">450</a> -<a class="jxr_linenumber" name="L451" href="#L451">451</a> sink.tableRow_(); -<a class="jxr_linenumber" name="L452" href="#L452">452</a> } -<a class="jxr_linenumber" name="L453" href="#L453">453</a> -<a class="jxr_linenumber" name="L454" href="#L454">454</a> endTable(); -<a class="jxr_linenumber" name="L455" href="#L455">455</a> -<a class="jxr_linenumber" name="L456" href="#L456">456</a> endSection(); -<a class="jxr_linenumber" name="L457" href="#L457">457</a> } -<a class="jxr_linenumber" name="L458" href="#L458">458</a> -<a class="jxr_linenumber" name="L459" href="#L459">459</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> renderDetailsSection() { -<a class="jxr_linenumber" name="L460" href="#L460">460</a> startSection(getI18nString(<span class="jxr_string">"details"</span>)); -<a class="jxr_linenumber" name="L461" href="#L461">461</a> -<a class="jxr_linenumber" name="L462" href="#L462">462</a> <em class="jxr_comment">// Sort the files before writing their details to the report</em> -<a class="jxr_linenumber" name="L463" href="#L463">463</a> List<String> fileList = <strong class="jxr_keyword">new</strong> ArrayList<>(results.getFiles().keySet()); -<a class="jxr_linenumber" name="L464" href="#L464">464</a> Collections.sort(fileList); -<a class="jxr_linenumber" name="L465" href="#L465">465</a> -<a class="jxr_linenumber" name="L466" href="#L466">466</a> <strong class="jxr_keyword">for</strong> (String file : fileList) { -<a class="jxr_linenumber" name="L467" href="#L467">467</a> List<AuditEvent> violations = results.getFileViolations(file); -<a class="jxr_linenumber" name="L468" href="#L468">468</a> -<a class="jxr_linenumber" name="L469" href="#L469">469</a> <strong class="jxr_keyword">if</strong> (violations.isEmpty()) { -<a class="jxr_linenumber" name="L470" href="#L470">470</a> <em class="jxr_comment">// skip files without violations</em> -<a class="jxr_linenumber" name="L471" href="#L471">471</a> <strong class="jxr_keyword">continue</strong>; -<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> startSection(file); -<a class="jxr_linenumber" name="L475" href="#L475">475</a> -<a class="jxr_linenumber" name="L476" href="#L476">476</a> startTable(); -<a class="jxr_linenumber" name="L477" href="#L477">477</a> -<a class="jxr_linenumber" name="L478" href="#L478">478</a> tableHeader(<strong class="jxr_keyword">new</strong> String[] { -<a class="jxr_linenumber" name="L479" href="#L479">479</a> getI18nString(<span class="jxr_string">"column.severity"</span>), -<a class="jxr_linenumber" name="L480" href="#L480">480</a> getI18nString(<span class="jxr_string">"rule.category"</span>), -<a class="jxr_linenumber" name="L481" href="#L481">481</a> getI18nString(<span class="jxr_string">"rule"</span>), -<a class="jxr_linenumber" name="L482" href="#L482">482</a> getI18nString(<span class="jxr_string">"column.message"</span>), -<a class="jxr_linenumber" name="L483" href="#L483">483</a> getI18nString(<span class="jxr_string">"column.line"</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> renderFileEvents(violations, file); -<a class="jxr_linenumber" name="L487" href="#L487">487</a> -<a class="jxr_linenumber" name="L488" href="#L488">488</a> endTable(); -<a class="jxr_linenumber" name="L489" href="#L489">489</a> -<a class="jxr_linenumber" name="L490" href="#L490">490</a> endSection(); -<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> endSection(); -<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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> renderFileEvents(List<AuditEvent> eventList, String filename) { -<a class="jxr_linenumber" name="L497" href="#L497">497</a> <strong class="jxr_keyword">for</strong> (AuditEvent event : eventList) { -<a class="jxr_linenumber" name="L498" href="#L498">498</a> SeverityLevel level = event.getSeverityLevel(); -<a class="jxr_linenumber" name="L499" href="#L499">499</a> -<a class="jxr_linenumber" name="L500" href="#L500">500</a> sink.tableRow(); -<a class="jxr_linenumber" name="L501" href="#L501">501</a> -<a class="jxr_linenumber" name="L502" href="#L502">502</a> sink.tableCell(); -<a class="jxr_linenumber" name="L503" href="#L503">503</a> iconSeverity(level.getName(), TEXT_SIMPLE); -<a class="jxr_linenumber" name="L504" href="#L504">504</a> sink.tableCell_(); -<a class="jxr_linenumber" name="L505" href="#L505">505</a> -<a class="jxr_linenumber" name="L506" href="#L506">506</a> sink.tableCell(); -<a class="jxr_linenumber" name="L507" href="#L507">507</a> String category = RuleUtil.getCategory(event); -<a class="jxr_linenumber" name="L508" href="#L508">508</a> <strong class="jxr_keyword">if</strong> (category != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L509" href="#L509">509</a> sink.text(category); -<a class="jxr_linenumber" name="L510" href="#L510">510</a> } -<a class="jxr_linenumber" name="L511" href="#L511">511</a> sink.tableCell_(); -<a class="jxr_linenumber" name="L512" href="#L512">512</a> -<a class="jxr_linenumber" name="L513" href="#L513">513</a> sink.tableCell(); -<a class="jxr_linenumber" name="L514" href="#L514">514</a> String ruleName = RuleUtil.getName(event); -<a class="jxr_linenumber" name="L515" href="#L515">515</a> <strong class="jxr_keyword">if</strong> (ruleName != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L516" href="#L516">516</a> sink.text(ruleName); -<a class="jxr_linenumber" name="L517" href="#L517">517</a> } -<a class="jxr_linenumber" name="L518" href="#L518">518</a> sink.tableCell_(); -<a class="jxr_linenumber" name="L519" href="#L519">519</a> -<a class="jxr_linenumber" name="L520" href="#L520">520</a> sink.tableCell(); -<a class="jxr_linenumber" name="L521" href="#L521">521</a> sink.text(event.getMessage()); -<a class="jxr_linenumber" name="L522" href="#L522">522</a> sink.tableCell_(); -<a class="jxr_linenumber" name="L523" href="#L523">523</a> -<a class="jxr_linenumber" name="L524" href="#L524">524</a> sink.tableCell(); -<a class="jxr_linenumber" name="L525" href="#L525">525</a> -<a class="jxr_linenumber" name="L526" href="#L526">526</a> <strong class="jxr_keyword">int</strong> line = event.getLine(); -<a class="jxr_linenumber" name="L527" href="#L527">527</a> String effectiveXrefLocation = getEffectiveXrefLocation(eventList); -<a class="jxr_linenumber" name="L528" href="#L528">528</a> <strong class="jxr_keyword">if</strong> (effectiveXrefLocation != <strong class="jxr_keyword">null</strong> && line != 0) { -<a class="jxr_linenumber" name="L529" href="#L529">529</a> sink.link(effectiveXrefLocation + <span class="jxr_string">"/"</span> + filename.replaceAll(<span class="jxr_string">"\\.java$"</span>, <span class="jxr_string">".html"</span>) + <span class="jxr_string">"#L"</span> + line); -<a class="jxr_linenumber" name="L530" href="#L530">530</a> sink.text(String.valueOf(line)); -<a class="jxr_linenumber" name="L531" href="#L531">531</a> sink.link_(); -<a class="jxr_linenumber" name="L532" href="#L532">532</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (line != 0) { -<a class="jxr_linenumber" name="L533" href="#L533">533</a> sink.text(String.valueOf(line)); -<a class="jxr_linenumber" name="L534" href="#L534">534</a> } -<a class="jxr_linenumber" name="L535" href="#L535">535</a> sink.tableCell_(); -<a class="jxr_linenumber" name="L536" href="#L536">536</a> -<a class="jxr_linenumber" name="L537" href="#L537">537</a> sink.tableRow_(); -<a class="jxr_linenumber" name="L538" href="#L538">538</a> } -<a class="jxr_linenumber" name="L539" href="#L539">539</a> } -<a class="jxr_linenumber" name="L540" href="#L540">540</a> -<a class="jxr_linenumber" name="L541" href="#L541">541</a> <strong class="jxr_keyword">private</strong> String getEffectiveXrefLocation(List<AuditEvent> eventList) { -<a class="jxr_linenumber" name="L542" href="#L542">542</a> String absoluteFilename = eventList.get(0).getFileName(); -<a class="jxr_linenumber" name="L543" href="#L543">543</a> <strong class="jxr_keyword">if</strong> (isTestSource(absoluteFilename)) { -<a class="jxr_linenumber" name="L544" href="#L544">544</a> <strong class="jxr_keyword">return</strong> getXrefTestLocation(); -<a class="jxr_linenumber" name="L545" href="#L545">545</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L546" href="#L546">546</a> <strong class="jxr_keyword">return</strong> getXrefLocation(); -<a class="jxr_linenumber" name="L547" href="#L547">547</a> } -<a class="jxr_linenumber" name="L548" href="#L548">548</a> } -<a class="jxr_linenumber" name="L549" href="#L549">549</a> -<a class="jxr_linenumber" name="L550" href="#L550">550</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isTestSource(<strong class="jxr_keyword">final</strong> String absoluteFilename) { -<a class="jxr_linenumber" name="L551" href="#L551">551</a> <strong class="jxr_keyword">for</strong> (File testSourceDirectory : testSourceDirectories) { -<a class="jxr_linenumber" name="L552" href="#L552">552</a> <strong class="jxr_keyword">if</strong> (absoluteFilename.startsWith(testSourceDirectory.getAbsolutePath())) { -<a class="jxr_linenumber" name="L553" href="#L553">553</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; -<a class="jxr_linenumber" name="L554" href="#L554">554</a> } -<a class="jxr_linenumber" name="L555" href="#L555">555</a> } -<a class="jxr_linenumber" name="L556" href="#L556">556</a> -<a class="jxr_linenumber" name="L557" href="#L557">557</a> <strong class="jxr_keyword">return</strong> false; -<a class="jxr_linenumber" name="L558" href="#L558">558</a> } -<a class="jxr_linenumber" name="L559" href="#L559">559</a> -<a class="jxr_linenumber" name="L560" href="#L560">560</a> <strong class="jxr_keyword">public</strong> String getXrefLocation() { -<a class="jxr_linenumber" name="L561" href="#L561">561</a> <strong class="jxr_keyword">return</strong> xrefLocation; -<a class="jxr_linenumber" name="L562" href="#L562">562</a> } -<a class="jxr_linenumber" name="L563" href="#L563">563</a> -<a class="jxr_linenumber" name="L564" href="#L564">564</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setXrefLocation(String xrefLocation) { -<a class="jxr_linenumber" name="L565" href="#L565">565</a> <strong class="jxr_keyword">this</strong>.xrefLocation = xrefLocation; -<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> <strong class="jxr_keyword">public</strong> String getXrefTestLocation() { -<a class="jxr_linenumber" name="L569" href="#L569">569</a> <strong class="jxr_keyword">return</strong> xrefTestLocation; -<a class="jxr_linenumber" name="L570" href="#L570">570</a> } -<a class="jxr_linenumber" name="L571" href="#L571">571</a> -<a class="jxr_linenumber" name="L572" href="#L572">572</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setXrefTestLocation(String xrefTestLocation) { -<a class="jxr_linenumber" name="L573" href="#L573">573</a> <strong class="jxr_keyword">this</strong>.xrefTestLocation = xrefTestLocation; -<a class="jxr_linenumber" name="L574" href="#L574">574</a> } -<a class="jxr_linenumber" name="L575" href="#L575">575</a> -<a class="jxr_linenumber" name="L576" href="#L576">576</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setTestSourceDirectories(List<File> testSourceDirectories) { -<a class="jxr_linenumber" name="L577" href="#L577">577</a> <strong class="jxr_keyword">this</strong>.testSourceDirectories = testSourceDirectories; -<a class="jxr_linenumber" name="L578" href="#L578">578</a> } -<a class="jxr_linenumber" name="L579" href="#L579">579</a> -<a class="jxr_linenumber" name="L580" href="#L580">580</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setTreeWalkerNames(List<String> treeWalkerNames) { -<a class="jxr_linenumber" name="L581" href="#L581">581</a> <strong class="jxr_keyword">this</strong>.treeWalkerNames = treeWalkerNames; -<a class="jxr_linenumber" name="L582" href="#L582">582</a> } -<a class="jxr_linenumber" name="L583" href="#L583">583</a> -<a class="jxr_linenumber" name="L584" href="#L584">584</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L585" href="#L585">585</a> <em class="jxr_javadoccomment"> * Render an icon of given level with associated text.</em> -<a class="jxr_linenumber" name="L586" href="#L586">586</a> <em class="jxr_javadoccomment"> * @param level one of <code>INFO</code>, <code>WARNING</code> or <code>ERROR</code> constants</em> -<a class="jxr_linenumber" name="L587" href="#L587">587</a> <em class="jxr_javadoccomment"> * @param textType one of <code>NO_TEXT</code>, <code>TEXT_SIMPLE</code>, <code>TEXT_TITLE</code> or</em> -<a class="jxr_linenumber" name="L588" href="#L588">588</a> <em class="jxr_javadoccomment"> * <code>TEXT_ABBREV</code> constants</em> -<a class="jxr_linenumber" name="L589" href="#L589">589</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L590" href="#L590">590</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> iconSeverity(String level, <strong class="jxr_keyword">int</strong> textType) { -<a class="jxr_linenumber" name="L591" href="#L591">591</a> sink.figureGraphics(<span class="jxr_string">"images/icon_"</span> + level + <span class="jxr_string">"_sml.gif"</span>); -<a class="jxr_linenumber" name="L592" href="#L592">592</a> -<a class="jxr_linenumber" name="L593" href="#L593">593</a> <strong class="jxr_keyword">if</strong> (textType > NO_TEXT) { -<a class="jxr_linenumber" name="L594" href="#L594">594</a> sink.nonBreakingSpace(); -<a class="jxr_linenumber" name="L595" href="#L595">595</a> String suffix; -<a class="jxr_linenumber" name="L596" href="#L596">596</a> <strong class="jxr_keyword">switch</strong> (textType) { -<a class="jxr_linenumber" name="L597" href="#L597">597</a> <strong class="jxr_keyword">case</strong> TEXT_TITLE: -<a class="jxr_linenumber" name="L598" href="#L598">598</a> suffix = <span class="jxr_string">"s"</span>; -<a class="jxr_linenumber" name="L599" href="#L599">599</a> <strong class="jxr_keyword">break</strong>; -<a class="jxr_linenumber" name="L600" href="#L600">600</a> <strong class="jxr_keyword">case</strong> TEXT_ABBREV: -<a class="jxr_linenumber" name="L601" href="#L601">601</a> suffix = <span class="jxr_string">"s.abbrev"</span>; -<a class="jxr_linenumber" name="L602" href="#L602">602</a> <strong class="jxr_keyword">break</strong>; -<a class="jxr_linenumber" name="L603" href="#L603">603</a> <strong class="jxr_keyword">default</strong>: -<a class="jxr_linenumber" name="L604" href="#L604">604</a> suffix = <span class="jxr_string">""</span>; -<a class="jxr_linenumber" name="L605" href="#L605">605</a> } -<a class="jxr_linenumber" name="L606" href="#L606">606</a> sink.text(getI18nString(level + suffix)); -<a class="jxr_linenumber" name="L607" href="#L607">607</a> } -<a class="jxr_linenumber" name="L608" href="#L608">608</a> } -<a class="jxr_linenumber" name="L609" href="#L609">609</a> -<a class="jxr_linenumber" name="L610" href="#L610">610</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L611" href="#L611">611</a> <em class="jxr_javadoccomment"> * Get the effective Checkstyle version at runtime.</em> -<a class="jxr_linenumber" name="L612" href="#L612">612</a> <em class="jxr_javadoccomment"> * @return the MANIFEST implementation version of Checkstyle API package (can be <code>null</code>)</em> -<a class="jxr_linenumber" name="L613" href="#L613">613</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L614" href="#L614">614</a> <strong class="jxr_keyword">private</strong> String getCheckstyleVersion() { -<a class="jxr_linenumber" name="L615" href="#L615">615</a> Package checkstyleApiPackage = Configuration.<strong class="jxr_keyword">class</strong>.getPackage(); -<a class="jxr_linenumber" name="L616" href="#L616">616</a> -<a class="jxr_linenumber" name="L617" href="#L617">617</a> <strong class="jxr_keyword">return</strong> (checkstyleApiPackage == <strong class="jxr_keyword">null</strong>) ? <strong class="jxr_keyword">null</strong> : checkstyleApiPackage.getImplementationVersion(); -<a class="jxr_linenumber" name="L618" href="#L618">618</a> } -<a class="jxr_linenumber" name="L619" href="#L619">619</a> -<a class="jxr_linenumber" name="L620" href="#L620">620</a> <strong class="jxr_keyword">public</strong> List<ConfReference> sortConfiguration(<a name="CheckstyleResults" href="../../../../../org/apache/maven/plugins/checkstyle/exec/CheckstyleResults.html#CheckstyleResults">CheckstyleResults</a> results) { -<a class="jxr_linenumber" name="L621" href="#L621">621</a> List<ConfReference> result = <strong class="jxr_keyword">new</strong> ArrayList<>(); -<a class="jxr_linenumber" name="L622" href="#L622">622</a> -<a class="jxr_linenumber" name="L623" href="#L623">623</a> sortConfiguration(result, checkstyleConfig, <strong class="jxr_keyword">null</strong>, results); -<a class="jxr_linenumber" name="L624" href="#L624">624</a> -<a class="jxr_linenumber" name="L625" href="#L625">625</a> Collections.sort(result); -<a class="jxr_linenumber" name="L626" href="#L626">626</a> -<a class="jxr_linenumber" name="L627" href="#L627">627</a> <strong class="jxr_keyword">return</strong> result; -<a class="jxr_linenumber" name="L628" href="#L628">628</a> } -<a class="jxr_linenumber" name="L629" href="#L629">629</a> -<a class="jxr_linenumber" name="L630" href="#L630">630</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> sortConfiguration( -<a class="jxr_linenumber" name="L631" href="#L631">631</a> List<ConfReference> result, -<a class="jxr_linenumber" name="L632" href="#L632">632</a> Configuration config, -<a class="jxr_linenumber" name="L633" href="#L633">633</a> ChainedItem<Configuration> parent, -<a class="jxr_linenumber" name="L634" href="#L634">634</a> <a name="CheckstyleResults" href="../../../../../org/apache/maven/plugins/checkstyle/exec/CheckstyleResults.html#CheckstyleResults">CheckstyleResults</a> results) { -<a class="jxr_linenumber" name="L635" href="#L635">635</a> <strong class="jxr_keyword">for</strong> (Configuration childConfig : config.getChildren()) { -<a class="jxr_linenumber" name="L636" href="#L636">636</a> String ruleName = childConfig.getName(); -<a class="jxr_linenumber" name="L637" href="#L637">637</a> -<a class="jxr_linenumber" name="L638" href="#L638">638</a> <strong class="jxr_keyword">if</strong> (treeWalkerNames.contains(ruleName)) { -<a class="jxr_linenumber" name="L639" href="#L639">639</a> <em class="jxr_comment">// special sub-case: TreeWalker is the parent of multiple rules, not an effective rule</em> -<a class="jxr_linenumber" name="L640" href="#L640">640</a> sortConfiguration(result, childConfig, <strong class="jxr_keyword">new</strong> ChainedItem<>(config, parent), results); -<a class="jxr_linenumber" name="L641" href="#L641">641</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L642" href="#L642">642</a> String fixedmessage = getConfigAttribute(childConfig, <strong class="jxr_keyword">null</strong>, <span class="jxr_string">"message"</span>, <strong class="jxr_keyword">null</strong>); -<a class="jxr_linenumber" name="L643" href="#L643">643</a> <em class="jxr_comment">// Grab the severity from the rule configuration. Do not set default value here as</em> -<a class="jxr_linenumber" name="L644" href="#L644">644</a> <em class="jxr_comment">// it breaks our rule aggregate section entirely. The counts are off but this is</em> -<a class="jxr_linenumber" name="L645" href="#L645">645</a> <em class="jxr_comment">// not appropriate fix location per MCHECKSTYLE-365.</em> -<a class="jxr_linenumber" name="L646" href="#L646">646</a> String configSeverity = getConfigAttribute(childConfig, <strong class="jxr_keyword">null</strong>, <span class="jxr_string">"severity"</span>, <strong class="jxr_keyword">null</strong>); -<a class="jxr_linenumber" name="L647" href="#L647">647</a> -<a class="jxr_linenumber" name="L648" href="#L648">648</a> <em class="jxr_comment">// count rule violations</em> -<a class="jxr_linenumber" name="L649" href="#L649">649</a> <strong class="jxr_keyword">long</strong> violations = 0; -<a class="jxr_linenumber" name="L650" href="#L650">650</a> AuditEvent lastMatchedEvent = <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L651" href="#L651">651</a> <strong class="jxr_keyword">for</strong> (List<AuditEvent> errors : results.getFiles().values()) { -<a class="jxr_linenumber" name="L652" href="#L652">652</a> <strong class="jxr_keyword">for</strong> (AuditEvent event : errors) { -<a class="jxr_linenumber" name="L653" href="#L653">653</a> <strong class="jxr_keyword">if</strong> (matchRule(event, ruleName, fixedmessage, configSeverity)) { -<a class="jxr_linenumber" name="L654" href="#L654">654</a> lastMatchedEvent = event; -<a class="jxr_linenumber" name="L655" href="#L655">655</a> violations++; -<a class="jxr_linenumber" name="L656" href="#L656">656</a> } -<a class="jxr_linenumber" name="L657" href="#L657">657</a> } -<a class="jxr_linenumber" name="L658" href="#L658">658</a> } -<a class="jxr_linenumber" name="L659" href="#L659">659</a> -<a class="jxr_linenumber" name="L660" href="#L660">660</a> <strong class="jxr_keyword">if</strong> (violations > 0) <em class="jxr_comment">// forget rules without violations</em> -<a class="jxr_linenumber" name="L661" href="#L661">661</a> { -<a class="jxr_linenumber" name="L662" href="#L662">662</a> String category = RuleUtil.getCategory(lastMatchedEvent); -<a class="jxr_linenumber" name="L663" href="#L663">663</a> -<a class="jxr_linenumber" name="L664" href="#L664">664</a> result.add(<strong class="jxr_keyword">new</strong> ConfReference(category, childConfig, parent, violations, result.size())); -<a class="jxr_linenumber" name="L665" href="#L665">665</a> } -<a class="jxr_linenumber" name="L666" href="#L666">666</a> } -<a class="jxr_linenumber" name="L667" href="#L667">667</a> } -<a class="jxr_linenumber" name="L668" href="#L668">668</a> } -<a class="jxr_linenumber" name="L669" href="#L669">669</a> -<a class="jxr_linenumber" name="L670" href="#L670">670</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> ConfReference <strong class="jxr_keyword">implements</strong> Comparable<ConfReference> { -<a class="jxr_linenumber" name="L671" href="#L671">671</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String category; -<a class="jxr_linenumber" name="L672" href="#L672">672</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Configuration configuration; -<a class="jxr_linenumber" name="L673" href="#L673">673</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> ChainedItem<Configuration> parentConfiguration; -<a class="jxr_linenumber" name="L674" href="#L674">674</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> violations; -<a class="jxr_linenumber" name="L675" href="#L675">675</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> count; -<a class="jxr_linenumber" name="L676" href="#L676">676</a> -<a class="jxr_linenumber" name="L677" href="#L677">677</a> ConfReference( -<a class="jxr_linenumber" name="L678" href="#L678">678</a> String category, -<a class="jxr_linenumber" name="L679" href="#L679">679</a> Configuration configuration, -<a class="jxr_linenumber" name="L680" href="#L680">680</a> ChainedItem<Configuration> parentConfiguration, -<a class="jxr_linenumber" name="L681" href="#L681">681</a> <strong class="jxr_keyword">long</strong> violations, -<a class="jxr_linenumber" name="L682" href="#L682">682</a> <strong class="jxr_keyword">int</strong> count) { -<a class="jxr_linenumber" name="L683" href="#L683">683</a> <strong class="jxr_keyword">this</strong>.category = category; -<a class="jxr_linenumber" name="L684" href="#L684">684</a> <strong class="jxr_keyword">this</strong>.configuration = configuration; -<a class="jxr_linenumber" name="L685" href="#L685">685</a> <strong class="jxr_keyword">this</strong>.parentConfiguration = parentConfiguration; -<a class="jxr_linenumber" name="L686" href="#L686">686</a> <strong class="jxr_keyword">this</strong>.violations = violations; -<a class="jxr_linenumber" name="L687" href="#L687">687</a> <strong class="jxr_keyword">this</strong>.count = count; -<a class="jxr_linenumber" name="L688" href="#L688">688</a> } -<a class="jxr_linenumber" name="L689" href="#L689">689</a> -<a class="jxr_linenumber" name="L690" href="#L690">690</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> compareTo(ConfReference o) { -<a class="jxr_linenumber" name="L691" href="#L691">691</a> <strong class="jxr_keyword">int</strong> compare = category.compareTo(o.category); -<a class="jxr_linenumber" name="L692" href="#L692">692</a> <strong class="jxr_keyword">if</strong> (compare == 0) { -<a class="jxr_linenumber" name="L693" href="#L693">693</a> compare = configuration.getName().compareTo(o.configuration.getName()); -<a class="jxr_linenumber" name="L694" href="#L694">694</a> } -<a class="jxr_linenumber" name="L695" href="#L695">695</a> <strong class="jxr_keyword">return</strong> (compare == 0) ? (o.count - count) : compare; -<a class="jxr_linenumber" name="L696" href="#L696">696</a> } -<a class="jxr_linenumber" name="L697" href="#L697">697</a> } -<a class="jxr_linenumber" name="L698" href="#L698">698</a> -<a class="jxr_linenumber" name="L699" href="#L699">699</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> ChainedItem<T> { -<a class="jxr_linenumber" name="L700" href="#L700">700</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> ChainedItem<T> parent; -<a class="jxr_linenumber" name="L701" href="#L701">701</a> -<a class="jxr_linenumber" name="L702" href="#L702">702</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> T value; -<a class="jxr_linenumber" name="L703" href="#L703">703</a> -<a class="jxr_linenumber" name="L704" href="#L704">704</a> ChainedItem(T value, ChainedItem<T> parent) { -<a class="jxr_linenumber" name="L705" href="#L705">705</a> <strong class="jxr_keyword">this</strong>.parent = parent; -<a class="jxr_linenumber" name="L706" href="#L706">706</a> <strong class="jxr_keyword">this</strong>.value = value; -<a class="jxr_linenumber" name="L707" href="#L707">707</a> } -<a class="jxr_linenumber" name="L708" href="#L708">708</a> } -<a class="jxr_linenumber" name="L709" href="#L709">709</a> } +<a class="jxr_linenumber" name="L245" href="#L245">245</a> sink.link( +<a class="jxr_linenumber" name="L246" href="#L246">246</a> <span class="jxr_string">"https://checkstyle.org/checks/"</span> + category + <span class="jxr_string">"/"</span> + ruleName.toLowerCase(Locale.ENGLISH) + <span class="jxr_string">".html"</span>); +<a class="jxr_linenumber" name="L247" href="#L247">247</a> sink.text(ruleName); +<a class="jxr_linenumber" name="L248" href="#L248">248</a> sink.link_(); +<a class="jxr_linenumber" name="L249" href="#L249">249</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L250" href="#L250">250</a> sink.text(ruleName); +<a class="jxr_linenumber" name="L251" href="#L251">251</a> } +<a class="jxr_linenumber" name="L252" href="#L252">252</a> +<a class="jxr_linenumber" name="L253" href="#L253">253</a> List<String> attribnames = <strong class="jxr_keyword">new</strong> ArrayList<>(Arrays.asList(checkerConfig.getAttributeNames())); +<a class="jxr_linenumber" name="L254" href="#L254">254</a> attribnames.remove(<span class="jxr_string">"severity"</span>); <em class="jxr_comment">// special value (deserves unique column)</em> +<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">if</strong> (!attribnames.isEmpty()) { +<a class="jxr_linenumber" name="L256" href="#L256">256</a> sink.list(); +<a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">for</strong> (String name : attribnames) { +<a class="jxr_linenumber" name="L258" href="#L258">258</a> sink.listItem(); +<a class="jxr_linenumber" name="L259" href="#L259">259</a> +<a class="jxr_linenumber" name="L260" href="#L260">260</a> sink.text(name); +<a class="jxr_linenumber" name="L261" href="#L261">261</a> +<a class="jxr_linenumber" name="L262" href="#L262">262</a> String value = getConfigAttribute(checkerConfig, <strong class="jxr_keyword">null</strong>, name, <span class="jxr_string">""</span>); +<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_comment">// special case, Header.header and RegexpHeader.header</em> +<a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"header"</span>.equals(name) && (<span class="jxr_string">"Header"</span>.equals(ruleName) || <span class="jxr_string">"RegexpHeader"</span>.equals(ruleName))) { +<a class="jxr_linenumber" name="L265" href="#L265">265</a> String[] lines = StringUtils.split(value, <span class="jxr_string">"\\n"</span>); +<a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong class="jxr_keyword">int</strong> linenum = 1; +<a class="jxr_linenumber" name="L267" href="#L267">267</a> <strong class="jxr_keyword">for</strong> (String line : lines) { +<a class="jxr_linenumber" name="L268" href="#L268">268</a> sink.lineBreak(); +<a class="jxr_linenumber" name="L269" href="#L269">269</a> sink.rawText(<span class="jxr_string">"<span style=\"color: gray\">"</span>); +<a class="jxr_linenumber" name="L270" href="#L270">270</a> sink.text(linenum + <span class="jxr_string">":"</span>); +<a class="jxr_linenumber" name="L271" href="#L271">271</a> sink.rawText(<span class="jxr_string">"</span>"</span>); +<a class="jxr_linenumber" name="L272" href="#L272">272</a> sink.nonBreakingSpace(); +<a class="jxr_linenumber" name="L273" href="#L273">273</a> sink.monospaced(); +<a class="jxr_linenumber" name="L274" href="#L274">274</a> sink.text(line); +<a class="jxr_linenumber" name="L275" href="#L275">275</a> sink.monospaced_(); +<a class="jxr_linenumber" name="L276" href="#L276">276</a> linenum++; +<a class="jxr_linenumber" name="L277" href="#L277">277</a> } +<a class="jxr_linenumber" name="L278" href="#L278">278</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"headerFile"</span>.equals(name) && <span class="jxr_string">"RegexpHeader"</span>.equals(ruleName)) { +<a class="jxr_linenumber" name="L279" href="#L279">279</a> sink.text(<span class="jxr_string">": "</span>); +<a class="jxr_linenumber" name="L280" href="#L280">280</a> sink.monospaced(); +<a class="jxr_linenumber" name="L281" href="#L281">281</a> sink.text(<span class="jxr_string">"\""</span>); +<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_comment">// Make the headerFile value relative to ${basedir}</em> +<a class="jxr_linenumber" name="L283" href="#L283">283</a> String path = +<a class="jxr_linenumber" name="L284" href="#L284">284</a> siteTool.getRelativePath(value, project.getBasedir().getAbsolutePath()); +<a class="jxr_linenumber" name="L285" href="#L285">285</a> sink.text(path.replace('\\', '/')); +<a class="jxr_linenumber" name="L286" href="#L286">286</a> sink.text(value); +<a class="jxr_linenumber" name="L287" href="#L287">287</a> sink.text(<span class="jxr_string">"\""</span>); +<a class="jxr_linenumber" name="L288" href="#L288">288</a> sink.monospaced_(); +<a class="jxr_linenumber" name="L289" href="#L289">289</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L290" href="#L290">290</a> sink.text(<span class="jxr_string">": "</span>); +<a class="jxr_linenumber" name="L291" href="#L291">291</a> sink.monospaced(); +<a class="jxr_linenumber" name="L292" href="#L292">292</a> sink.text(<span class="jxr_string">"\""</span>); +<a class="jxr_linenumber" name="L293" href="#L293">293</a> sink.text(value); +<a class="jxr_linenumber" name="L294" href="#L294">294</a> sink.text(<span class="jxr_string">"\""</span>); +<a class="jxr_linenumber" name="L295" href="#L295">295</a> sink.monospaced_(); +<a class="jxr_linenumber" name="L296" href="#L296">296</a> } +<a class="jxr_linenumber" name="L297" href="#L297">297</a> sink.listItem_(); +<a class="jxr_linenumber" name="L298" href="#L298">298</a> } +<a class="jxr_linenumber" name="L299" href="#L299">299</a> sink.list_(); +<a class="jxr_linenumber" name="L300" href="#L300">300</a> } +<a class="jxr_linenumber" name="L301" href="#L301">301</a> +<a class="jxr_linenumber" name="L302" href="#L302">302</a> sink.tableCell_(); +<a class="jxr_linenumber" name="L303" href="#L303">303</a> +<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_comment">// column 3: rule violation count</em> +<a class="jxr_linenumber" name="L305" href="#L305">305</a> sink.tableCell(); +<a class="jxr_linenumber" name="L306" href="#L306">306</a> sink.text(String.valueOf(ref.violations)); +<a class="jxr_linenumber" name="L307" href="#L307">307</a> sink.tableCell_(); +<a class="jxr_linenumber" name="L308" href="#L308">308</a> +<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_comment">// column 4: severity</em> +<a class="jxr_linenumber" name="L310" href="#L310">310</a> sink.tableCell(); +<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_comment">// Grab the severity from the rule configuration, this time use error as default value</em> +<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_comment">// Also pass along all parent configurations, so that we can try to find the severity there</em> +<a class="jxr_linenumber" name="L313" href="#L313">313</a> String severity = getConfigAttribute(checkerConfig, parentConfiguration, <span class="jxr_string">"severity"</span>, <span class="jxr_string">"error"</span>); +<a class="jxr_linenumber" name="L314" href="#L314">314</a> iconSeverity(severity, TEXT_SIMPLE); +<a class="jxr_linenumber" name="L315" href="#L315">315</a> sink.tableCell_(); +<a class="jxr_linenumber" name="L316" href="#L316">316</a> +<a class="jxr_linenumber" name="L317" href="#L317">317</a> sink.tableRow_(); +<a class="jxr_linenumber" name="L318" href="#L318">318</a> } +<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"> * Check if a violation matches a rule.</em> +<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment"> * @param event the violation to check</em> +<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_javadoccomment"> * @param ruleName The name of the rule</em> +<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment"> * @param expectedMessage A message that, if it's not null, will be matched to the message from the violation</em> +<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment"> * @param expectedSeverity A severity that, if it's not null, will be matched to the severity from the violation</em> +<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> * @return The number of rule violations</em> +<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> matchRule(AuditEvent event, String ruleName, String expectedMessage, String expectedSeverity) { +<a class="jxr_linenumber" name="L330" href="#L330">330</a> <strong class="jxr_keyword">if</strong> (!ruleName.equals(RuleUtil.getName(event))) { +<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L332" href="#L332">332</a> } +<a class="jxr_linenumber" name="L333" href="#L333">333</a> +<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_comment">// check message too, for those that have a specific one.</em> +<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_comment">// like GenericIllegalRegexp and Regexp</em> +<a class="jxr_linenumber" name="L336" href="#L336">336</a> <strong class="jxr_keyword">if</strong> (expectedMessage != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_comment">// event.getMessage() uses java.text.MessageFormat in its implementation.</em> +<a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_comment">// Read MessageFormat Javadoc about single quote:</em> +<a class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_comment">// http://java.sun.com/j2se/1.4.2/docs/api/java/text/MessageFormat.html</em> +<a class="jxr_linenumber" name="L340" href="#L340">340</a> String msgWithoutSingleQuote = StringUtils.replace(expectedMessage, <span class="jxr_string">"'"</span>, <span class="jxr_string">""</span>); +<a class="jxr_linenumber" name="L341" href="#L341">341</a> +<a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">if</strong> (!(expectedMessage.equals(event.getMessage()) || msgWithoutSingleQuote.equals(event.getMessage()))) { +<a class="jxr_linenumber" name="L343" href="#L343">343</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L344" href="#L344">344</a> } +<a class="jxr_linenumber" name="L345" href="#L345">345</a> } +<a class="jxr_linenumber" name="L346" href="#L346">346</a> <em class="jxr_comment">// Check the severity. This helps to distinguish between</em> +<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_comment">// different configurations for the same rule, where each</em> +<a class="jxr_linenumber" name="L348" href="#L348">348</a> <em class="jxr_comment">// configuration has a different severity, like JavadocMethod.</em> +<a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_comment">// See also https://issues.apache.org/jira/browse/MCHECKSTYLE-41</em> +<a class="jxr_linenumber" name="L350" href="#L350">350</a> <strong class="jxr_keyword">if</strong> (expectedSeverity != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">if</strong> (!expectedSeverity.equals(event.getSeverityLevel().getName())) { +<a class="jxr_linenumber" name="L352" href="#L352">352</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L353" href="#L353">353</a> } +<a class="jxr_linenumber" name="L354" href="#L354">354</a> } +<a class="jxr_linenumber" name="L355" href="#L355">355</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L356" href="#L356">356</a> } +<a class="jxr_linenumber" name="L357" href="#L357">357</a> +<a class="jxr_linenumber" name="L358" href="#L358">358</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> renderSeveritySummarySection() { +<a class="jxr_linenumber" name="L359" href="#L359">359</a> <strong class="jxr_keyword">if</strong> (!enableSeveritySummary) { +<a class="jxr_linenumber" name="L360" href="#L360">360</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L361" href="#L361">361</a> } +<a class="jxr_linenumber" name="L362" href="#L362">362</a> +<a class="jxr_linenumber" name="L363" href="#L363">363</a> startSection(getI18nString(<span class="jxr_string">"summary"</span>)); +<a class="jxr_linenumber" name="L364" href="#L364">364</a> +<a class="jxr_linenumber" name="L365" href="#L365">365</a> startTable(); +<a class="jxr_linenumber" name="L366" href="#L366">366</a> +<a class="jxr_linenumber" name="L367" href="#L367">367</a> sink.tableRow(); +<a class="jxr_linenumber" name="L368" href="#L368">368</a> sink.tableHeaderCell(); +<a class="jxr_linenumber" name="L369" href="#L369">369</a> sink.text(getI18nString(<span class="jxr_string">"files"</span>)); +<a class="jxr_linenumber" name="L370" href="#L370">370</a> sink.tableHeaderCell_(); +<a class="jxr_linenumber" name="L371" href="#L371">371</a> +<a class="jxr_linenumber" name="L372" href="#L372">372</a> sink.tableHeaderCell(); +<a class="jxr_linenumber" name="L373" href="#L373">373</a> iconSeverity(<span class="jxr_string">"info"</span>, TEXT_TITLE); +<a class="jxr_linenumber" name="L374" href="#L374">374</a> sink.tableHeaderCell_(); +<a class="jxr_linenumber" name="L375" href="#L375">375</a> +<a class="jxr_linenumber" name="L376" href="#L376">376</a> sink.tableHeaderCell(); +<a class="jxr_linenumber" name="L377" href="#L377">377</a> iconSeverity(<span class="jxr_string">"warning"</span>, TEXT_TITLE); +<a class="jxr_linenumber" name="L378" href="#L378">378</a> sink.tableHeaderCell_(); +<a class="jxr_linenumber" name="L379" href="#L379">379</a> +<a class="jxr_linenumber" name="L380" href="#L380">380</a> sink.tableHeaderCell(); +<a class="jxr_linenumber" name="L381" href="#L381">381</a> iconSeverity(<span class="jxr_string">"error"</span>, TEXT_TITLE); +<a class="jxr_linenumber" name="L382" href="#L382">382</a> sink.tableHeaderCell_(); +<a class="jxr_linenumber" name="L383" href="#L383">383</a> sink.tableRow_(); +<a class="jxr_linenumber" name="L384" href="#L384">384</a> +<a class="jxr_linenumber" name="L385" href="#L385">385</a> tableRow(<strong class="jxr_keyword">new</strong> String[] { +<a class="jxr_linenumber" name="L386" href="#L386">386</a> String.valueOf(results.getFileCount()), +<a class="jxr_linenumber" name="L387" href="#L387">387</a> String.valueOf(results.getSeverityCount(SeverityLevel.INFO)), +<a class="jxr_linenumber" name="L388" href="#L388">388</a> String.valueOf(results.getSeverityCount(SeverityLevel.WARNING)), +<a class="jxr_linenumber" name="L389" href="#L389">389</a> String.valueOf(results.getSeverityCount(SeverityLevel.ERROR)) +<a class="jxr_linenumber" name="L390" href="#L390">390</a> }); +<a class="jxr_linenumber" name="L391" href="#L391">391</a> +<a class="jxr_linenumber" name="L392" href="#L392">392</a> endTable(); +<a class="jxr_linenumber" name="L393" href="#L393">393</a> +<a class="jxr_linenumber" name="L394" href="#L394">394</a> endSection(); +<a class="jxr_linenumber" name="L395" href="#L395">395</a> } +<a class="jxr_linenumber" name="L396" href="#L396">396</a> +<a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> renderFilesSummarySection() { +<a class="jxr_linenumber" name="L398" href="#L398">398</a> <strong class="jxr_keyword">if</strong> (!enableFilesSummary) { +<a class="jxr_linenumber" name="L399" href="#L399">399</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L400" href="#L400">400</a> } +<a class="jxr_linenumber" name="L401" href="#L401">401</a> +<a class="jxr_linenumber" name="L402" href="#L402">402</a> startSection(getI18nString(<span class="jxr_string">"files"</span>)); +<a class="jxr_linenumber" name="L403" href="#L403">403</a> +<a class="jxr_linenumber" name="L404" href="#L404">404</a> startTable(); +<a class="jxr_linenumber" name="L405" href="#L405">405</a> +<a class="jxr_linenumber" name="L406" href="#L406">406</a> sink.tableRow(); +<a class="jxr_linenumber" name="L407" href="#L407">407</a> sink.tableHeaderCell(); +<a class="jxr_linenumber" name="L408" href="#L408">408</a> sink.text(getI18nString(<span class="jxr_string">"file"</span>)); +<a class="jxr_linenumber" name="L409" href="#L409">409</a> sink.tableHeaderCell_(); +<a class="jxr_linenumber" name="L410" href="#L410">410</a> sink.tableHeaderCell(); +<a class="jxr_linenumber" name="L411" href="#L411">411</a> iconSeverity(<span class="jxr_string">"info"</span>, TEXT_ABBREV); +<a class="jxr_linenumber" name="L412" href="#L412">412</a> sink.tableHeaderCell_(); +<a class="jxr_linenumber" name="L413" href="#L413">413</a> sink.tableHeaderCell(); +<a class="jxr_linenumber" name="L414" href="#L414">414</a> iconSeverity(<span class="jxr_string">"warning"</span>, TEXT_ABBREV); +<a class="jxr_linenumber" name="L415" href="#L415">415</a> sink.tableHeaderCell_(); +<a class="jxr_linenumber" name="L416" href="#L416">416</a> sink.tableHeaderCell(); +<a class="jxr_linenumber" name="L417" href="#L417">417</a> iconSeverity(<span class="jxr_string">"error"</span>, TEXT_ABBREV); +<a class="jxr_linenumber" name="L418" href="#L418">418</a> sink.tableHeaderCell_(); +<a class="jxr_linenumber" name="L419" href="#L419">419</a> sink.tableRow_(); +<a class="jxr_linenumber" name="L420" href="#L420">420</a> +<a class="jxr_linenumber" name="L421" href="#L421">421</a> <em class="jxr_comment">// Sort the files before writing them to the report</em> +<a class="jxr_linenumber" name="L422" href="#L422">422</a> List<String> fileList = <strong class="jxr_keyword">new</strong> ArrayList<>(results.getFiles().keySet()); +<a class="jxr_linenumber" name="L423" href="#L423">423</a> Collections.sort(fileList); +<a class="jxr_linenumber" name="L424" href="#L424">424</a> +<a class="jxr_linenumber" name="L425" href="#L425">425</a> <strong class="jxr_keyword">for</strong> (String filename : fileList) { +<a class="jxr_linenumber" name="L426" href="#L426">426</a> List<AuditEvent> violations = results.getFileViolations(filename); +<a class="jxr_linenumber" name="L427" href="#L427">427</a> <strong class="jxr_keyword">if</strong> (violations.isEmpty()) { +<a class="jxr_linenumber" name="L428" href="#L428">428</a> <em class="jxr_comment">// skip files without violations</em> +<a class="jxr_linenumber" name="L429" href="#L429">429</a> <strong class="jxr_keyword">continue</strong>; +<a class="jxr_linenumber" name="L430" href="#L430">430</a> } +<a class="jxr_linenumber" name="L431" href="#L431">431</a> +<a class="jxr_linenumber" name="L432" href="#L432">432</a> sink.tableRow(); +<a class="jxr_linenumber" name="L433" href="#L433">433</a> +<a class="jxr_linenumber" name="L434" href="#L434">434</a> sink.tableCell(); +<a class="jxr_linenumber" name="L435" href="#L435">435</a> sink.link(<span class="jxr_string">"#"</span> + DoxiaUtils.encodeId(filename)); +<a class="jxr_linenumber" name="L436" href="#L436">436</a> sink.text(filename); +<a class="jxr_linenumber" name="L437" href="#L437">437</a> sink.link_(); +<a class="jxr_linenumber" name="L438" href="#L438">438</a> sink.tableCell_(); +<a class="jxr_linenumber" name="L439" href="#L439">439</a> +<a class="jxr_linenumber" name="L440" href="#L440">440</a> sink.tableCell(); +<a class="jxr_linenumber" name="L441" href="#L441">441</a> sink.text(String.valueOf(results.getSeverityCount(violations, SeverityLevel.INFO))); +<a class="jxr_linenumber" name="L442" href="#L442">442</a> sink.tableCell_(); +<a class="jxr_linenumber" name="L443" href="#L443">443</a> +<a class="jxr_linenumber" name="L444" href="#L444">444</a> sink.tableCell(); +<a class="jxr_linenumber" name="L445" href="#L445">445</a> sink.text(String.valueOf(results.getSeverityCount(violations, SeverityLevel.WARNING))); +<a class="jxr_linenumber" name="L446" href="#L446">446</a> sink.tableCell_(); +<a class="jxr_linenumber" name="L447" href="#L447">447</a> +<a class="jxr_linenumber" name="L448" href="#L448">448</a> sink.tableCell(); +<a class="jxr_linenumber" name="L449" href="#L449">449</a> sink.text(String.valueOf(results.getSeverityCount(violations, SeverityLevel.ERROR))); +<a class="jxr_linenumber" name="L450" href="#L450">450</a> sink.tableCell_(); +<a class="jxr_linenumber" name="L451" href="#L451">451</a> +<a class="jxr_linenumber" name="L452" href="#L452">452</a> sink.tableRow_(); +<a class="jxr_linenumber" name="L453" href="#L453">453</a> } +<a class="jxr_linenumber" name="L454" href="#L454">454</a> +<a class="jxr_linenumber" name="L455" href="#L455">455</a> endTable(); +<a class="jxr_linenumber" name="L456" href="#L456">456</a> +<a class="jxr_linenumber" name="L457" href="#L457">457</a> endSection(); +<a class="jxr_linenumber" name="L458" href="#L458">458</a> } +<a class="jxr_linenumber" name="L459" href="#L459">459</a> +<a class="jxr_linenumber" name="L460" href="#L460">460</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> renderDetailsSection() { +<a class="jxr_linenumber" name="L461" href="#L461">461</a> startSection(getI18nString(<span class="jxr_string">"details"</span>)); +<a class="jxr_linenumber" name="L462" href="#L462">462</a> +<a class="jxr_linenumber" name="L463" href="#L463">463</a> <em class="jxr_comment">// Sort the files before writing their details to the report</em> +<a class="jxr_linenumber" name="L464" href="#L464">464</a> List<String> fileList = <strong class="jxr_keyword">new</strong> ArrayList<>(results.getFiles().keySet()); +<a class="jxr_linenumber" name="L465" href="#L465">465</a> Collections.sort(fileList); +<a class="jxr_linenumber" name="L466" href="#L466">466</a> +<a class="jxr_linenumber" name="L467" href="#L467">467</a> <strong class="jxr_keyword">for</strong> (String file : fileList) { +<a class="jxr_linenumber" name="L468" href="#L468">468</a> List<AuditEvent> violations = results.getFileViolations(file); +<a class="jxr_linenumber" name="L469" href="#L469">469</a> +<a class="jxr_linenumber" name="L470" href="#L470">470</a> <strong class="jxr_keyword">if</strong> (violations.isEmpty()) { +<a class="jxr_linenumber" name="L471" href="#L471">471</a> <em class="jxr_comment">// skip files without violations</em> +<a class="jxr_linenumber" name="L472" href="#L472">472</a> <strong class="jxr_keyword">continue</strong>; +<a class="jxr_linenumber" name="L473" href="#L473">473</a> } +<a class="jxr_linenumber" name="L474" href="#L474">474</a> +<a class="jxr_linenumber" name="L475" href="#L475">475</a> startSection(file); +<a class="jxr_linenumber" name="L476" href="#L476">476</a> +<a class="jxr_linenumber" name="L477" href="#L477">477</a> startTable(); +<a class="jxr_linenumber" name="L478" href="#L478">478</a> +<a class="jxr_linenumber" name="L479" href="#L479">479</a> tableHeader(<strong class="jxr_keyword">new</strong> String[] { +<a class="jxr_linenumber" name="L480" href="#L480">480</a> getI18nString(<span class="jxr_string">"column.severity"</span>), +<a class="jxr_linenumber" name="L481" href="#L481">481</a> getI18nString(<span class="jxr_string">"rule.category"</span>), +<a class="jxr_linenumber" name="L482" href="#L482">482</a> getI18nString(<span class="jxr_string">"rule"</span>), +<a class="jxr_linenumber" name="L483" href="#L483">483</a> getI18nString(<span class="jxr_string">"column.message"</span>), +<a class="jxr_linenumber" name="L484" href="#L484">484</a> getI18nString(<span class="jxr_string">"column.line"</span>) +<a class="jxr_linenumber" name="L485" href="#L485">485</a> }); +<a class="jxr_linenumber" name="L486" href="#L486">486</a> +<a class="jxr_linenumber" name="L487" href="#L487">487</a> renderFileEvents(violations, file); +<a class="jxr_linenumber" name="L488" href="#L488">488</a> +<a class="jxr_linenumber" name="L489" href="#L489">489</a> endTable(); +<a class="jxr_linenumber" name="L490" href="#L490">490</a> +<a class="jxr_linenumber" name="L491" href="#L491">491</a> endSection(); +<a class="jxr_linenumber" name="L492" href="#L492">492</a> } +<a class="jxr_linenumber" name="L493" href="#L493">493</a> +<a class="jxr_linenumber" name="L494" href="#L494">494</a> endSection(); +<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> <strong class="jxr_keyword">void</strong> renderFileEvents(List<AuditEvent> eventList, String filename) { +<a class="jxr_linenumber" name="L498" href="#L498">498</a> <strong class="jxr_keyword">for</strong> (AuditEvent event : eventList) { +<a class="jxr_linenumber" name="L499" href="#L499">499</a> SeverityLevel level = event.getSeverityLevel(); +<a class="jxr_linenumber" name="L500" href="#L500">500</a> +<a class="jxr_linenumber" name="L501" href="#L501">501</a> sink.tableRow(); +<a class="jxr_linenumber" name="L502" href="#L502">502</a> +<a class="jxr_linenumber" name="L503" href="#L503">503</a> sink.tableCell(); +<a class="jxr_linenumber" name="L504" href="#L504">504</a> iconSeverity(level.getName(), TEXT_SIMPLE); +<a class="jxr_linenumber" name="L505" href="#L505">505</a> sink.tableCell_(); +<a class="jxr_linenumber" name="L506" href="#L506">506</a> +<a class="jxr_linenumber" name="L507" href="#L507">507</a> sink.tableCell(); +<a class="jxr_linenumber" name="L508" href="#L508">508</a> String category = RuleUtil.getCategory(event); +<a class="jxr_linenumber" name="L509" href="#L509">509</a> <strong class="jxr_keyword">if</strong> (category != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L510" href="#L510">510</a> sink.text(category); +<a class="jxr_linenumber" name="L511" href="#L511">511</a> } +<a class="jxr_linenumber" name="L512" href="#L512">512</a> sink.tableCell_(); +<a class="jxr_linenumber" name="L513" href="#L513">513</a> +<a class="jxr_linenumber" name="L514" href="#L514">514</a> sink.tableCell(); +<a class="jxr_linenumber" name="L515" href="#L515">515</a> String ruleName = RuleUtil.getName(event); +<a class="jxr_linenumber" name="L516" href="#L516">516</a> <strong class="jxr_keyword">if</strong> (ruleName != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L517" href="#L517">517</a> sink.text(ruleName); +<a class="jxr_linenumber" name="L518" href="#L518">518</a> } +<a class="jxr_linenumber" name="L519" href="#L519">519</a> sink.tableCell_(); +<a class="jxr_linenumber" name="L520" href="#L520">520</a> +<a class="jxr_linenumber" name="L521" href="#L521">521</a> sink.tableCell(); +<a class="jxr_linenumber" name="L522" href="#L522">522</a> sink.text(event.getMessage()); +<a class="jxr_linenumber" name="L523" href="#L523">523</a> sink.tableCell_(); +<a class="jxr_linenumber" name="L524" href="#L524">524</a> +<a class="jxr_linenumber" name="L525" href="#L525">525</a> sink.tableCell(); +<a class="jxr_linenumber" name="L526" href="#L526">526</a> +<a class="jxr_linenumber" name="L527" href="#L527">527</a> <strong class="jxr_keyword">int</strong> line = event.getLine(); +<a class="jxr_linenumber" name="L528" href="#L528">528</a> String effectiveXrefLocation = getEffectiveXrefLocation(eventList); +<a class="jxr_linenumber" name="L529" href="#L529">529</a> <strong class="jxr_keyword">if</strong> (effectiveXrefLocation != <strong class="jxr_keyword">null</strong> && line != 0) { +<a class="jxr_linenumber" name="L530" href="#L530">530</a> sink.link(effectiveXrefLocation + <span class="jxr_string">"/"</span> + filename.replaceAll(<span class="jxr_string">"\\.java$"</span>, <span class="jxr_string">".html"</span>) + <span class="jxr_string">"#L"</span> + line); +<a class="jxr_linenumber" name="L531" href="#L531">531</a> sink.text(String.valueOf(line)); +<a class="jxr_linenumber" name="L532" href="#L532">532</a> sink.link_(); +<a class="jxr_linenumber" name="L533" href="#L533">533</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (line != 0) { +<a class="jxr_linenumber" name="L534" href="#L534">534</a> sink.text(String.valueOf(line)); +<a class="jxr_linenumber" name="L535" href="#L535">535</a> } +<a class="jxr_linenumber" name="L536" href="#L536">536</a> sink.tableCell_(); +<a class="jxr_linenumber" name="L537" href="#L537">537</a> +<a class="jxr_linenumber" name="L538" href="#L538">538</a> sink.tableRow_(); +<a class="jxr_linenumber" name="L539" href="#L539">539</a> } +<a class="jxr_linenumber" name="L540" href="#L540">540</a> } +<a class="jxr_linenumber" name="L541" href="#L541">541</a> +<a class="jxr_linenumber" name="L542" href="#L542">542</a> <strong class="jxr_keyword">private</strong> String getEffectiveXrefLocation(List<AuditEvent> eventList) { +<a class="jxr_linenumber" name="L543" href="#L543">543</a> String absoluteFilename = eventList.get(0).getFileName(); +<a class="jxr_linenumber" name="L544" href="#L544">544</a> <strong class="jxr_keyword">if</strong> (isTestSource(absoluteFilename)) { +<a class="jxr_linenumber" name="L545" href="#L545">545</a> <strong class="jxr_keyword">return</strong> getXrefTestLocation(); +<a class="jxr_linenumber" name="L546" href="#L546">546</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L547" href="#L547">547</a> <strong class="jxr_keyword">return</strong> getXrefLocation(); +<a class="jxr_linenumber" name="L548" href="#L548">548</a> } +<a class="jxr_linenumber" name="L549" href="#L549">549</a> } +<a class="jxr_linenumber" name="L550" href="#L550">550</a> +<a class="jxr_linenumber" name="L551" href="#L551">551</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isTestSource(<strong class="jxr_keyword">final</strong> String absoluteFilename) { +<a class="jxr_linenumber" name="L552" href="#L552">552</a> <strong class="jxr_keyword">for</strong> (File testSourceDirectory : testSourceDirectories) { +<a class="jxr_linenumber" name="L553" href="#L553">553</a> <strong class="jxr_keyword">if</strong> (absoluteFilename.startsWith(testSourceDirectory.getAbsolutePath())) { +<a class="jxr_linenumber" name="L554" href="#L554">554</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L555" href="#L555">555</a> } +<a class="jxr_linenumber" name="L556" href="#L556">556</a> }
[... 162 lines stripped ...]