Modified: websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugin/pmd/AbstractPmdReport.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugin/pmd/AbstractPmdReport.html (original) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugin/pmd/AbstractPmdReport.html Sat Oct 8 16:53:12 2016 @@ -134,383 +134,432 @@ <a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">private</strong> List<String> includes; <a class="jxr_linenumber" name="L127" href="#L127">127</a> <a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * The directories containing the sources to be compiled.</em> -<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L131" href="#L131">131</a> @Parameter( defaultValue = <span class="jxr_string">"${project.compileSourceRoots}"</span> ) -<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">private</strong> List<String> compileSourceRoots; -<a class="jxr_linenumber" name="L133" href="#L133">133</a> -<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> <em class="jxr_javadoccomment"> * The directories containing the test-sources to be compiled.</em> -<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L137" href="#L137">137</a> @Parameter( defaultValue = <span class="jxr_string">"${project.testCompileSourceRoots}"</span> ) -<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">private</strong> List<String> testSourceRoots; -<a class="jxr_linenumber" name="L139" href="#L139">139</a> -<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * The project source directories that should be excluded.</em> -<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * @since 2.2</em> -<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L145" href="#L145">145</a> @Parameter -<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">private</strong> File[] excludeRoots; -<a class="jxr_linenumber" name="L147" href="#L147">147</a> -<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * Run PMD on the tests.</em> -<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * @since 2.2</em> -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L153" href="#L153">153</a> @Parameter( defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> includeTests; -<a class="jxr_linenumber" name="L155" href="#L155">155</a> -<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * Whether to build an aggregated report at the root, or build individual reports.</em> -<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * @since 2.2</em> -<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L161" href="#L161">161</a> @Parameter( property = <span class="jxr_string">"aggregate"</span>, defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> aggregate; -<a class="jxr_linenumber" name="L163" href="#L163">163</a> -<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * The file encoding to use when reading the Java sources.</em> -<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * @since 2.3</em> -<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L169" href="#L169">169</a> @Parameter( property = <span class="jxr_string">"encoding"</span>, defaultValue = <span class="jxr_string">"${project.build.sourceEncoding}"</span> ) -<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">private</strong> String sourceEncoding; -<a class="jxr_linenumber" name="L171" href="#L171">171</a> -<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * The file encoding when writing non-HTML reports.</em> -<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * @since 2.5</em> -<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L177" href="#L177">177</a> @Parameter( property = <span class="jxr_string">"outputEncoding"</span>, defaultValue = <span class="jxr_string">"${project.reporting.outputEncoding}"</span> ) -<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">private</strong> String outputEncoding; -<a class="jxr_linenumber" name="L179" href="#L179">179</a> -<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * The projects in the reactor for aggregation report.</em> -<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L183" href="#L183">183</a> @Parameter( property = <span class="jxr_string">"reactorProjects"</span>, readonly = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">protected</strong> List<MavenProject> reactorProjects; -<a class="jxr_linenumber" name="L185" href="#L185">185</a> -<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> <em class="jxr_javadoccomment"> * Whether to include the xml files generated by PMD/CPD in the site.</em> -<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * @since 3.0</em> -<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L191" href="#L191">191</a> @Parameter( defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> includeXmlInSite; -<a class="jxr_linenumber" name="L193" href="#L193">193</a> -<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> <em class="jxr_javadoccomment"> * Skip the PMD/CPD report generation if there are no violations or duplications found. Defaults to</em> -<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * <code>true</code>.</em> -<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * @since 3.1</em> -<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L200" href="#L200">200</a> @Parameter( defaultValue = <span class="jxr_string">"true"</span> ) -<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> skipEmptyReport; -<a class="jxr_linenumber" name="L202" href="#L202">202</a> -<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment">/** The files that are being analyzed. */</em> -<a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">protected</strong> Map<File, PmdFileInfo> filesToProcess; -<a class="jxr_linenumber" name="L205" href="#L205">205</a> -<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> -<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L209" href="#L209">209</a> @Override -<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">protected</strong> MavenProject getProject() -<a class="jxr_linenumber" name="L211" href="#L211">211</a> { -<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">return</strong> project; -<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> @Override -<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">protected</strong> Renderer getSiteRenderer() -<a class="jxr_linenumber" name="L220" href="#L220">220</a> { -<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">return</strong> siteRenderer; -<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> <strong class="jxr_keyword">protected</strong> String constructXRefLocation( <strong class="jxr_keyword">boolean</strong> test ) -<a class="jxr_linenumber" name="L225" href="#L225">225</a> { -<a class="jxr_linenumber" name="L226" href="#L226">226</a> String location = <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">if</strong> ( linkXRef ) -<a class="jxr_linenumber" name="L228" href="#L228">228</a> { -<a class="jxr_linenumber" name="L229" href="#L229">229</a> File xrefLoc = test ? xrefTestLocation : xrefLocation; +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * Specifies the location of the source directories to be used for PMD.</em> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * Defaults to <code>project.compileSourceRoots</code>.</em> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * @since 3.7</em> +<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> @Parameter( defaultValue = <span class="jxr_string">"${project.compileSourceRoots}"</span> ) +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">private</strong> List<String> compileSourceRoots; +<a class="jxr_linenumber" name="L135" href="#L135">135</a> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * The directories containing the test-sources to be used for PMD.</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * Defaults to <code>project.testCompileSourceRoots</code></em> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * @since 3.7</em> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> @Parameter( defaultValue = <span class="jxr_string">"${project.testCompileSourceRoots}"</span> ) +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">private</strong> List<String> testSourceRoots; +<a class="jxr_linenumber" name="L143" href="#L143">143</a> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * The project source directories that should be excluded.</em> +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * @since 2.2</em> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> @Parameter +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">private</strong> File[] excludeRoots; +<a class="jxr_linenumber" name="L151" href="#L151">151</a> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * Run PMD on the tests.</em> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * @since 2.2</em> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> @Parameter( defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> includeTests; +<a class="jxr_linenumber" name="L159" href="#L159">159</a> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * Whether to build an aggregated report at the root, or build individual reports.</em> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * @since 2.2</em> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> @Parameter( property = <span class="jxr_string">"aggregate"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> aggregate; +<a class="jxr_linenumber" name="L167" href="#L167">167</a> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * The file encoding to use when reading the Java sources.</em> +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * @since 2.3</em> +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> @Parameter( property = <span class="jxr_string">"encoding"</span>, defaultValue = <span class="jxr_string">"${project.build.sourceEncoding}"</span> ) +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">private</strong> String sourceEncoding; +<a class="jxr_linenumber" name="L175" href="#L175">175</a> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * The file encoding when writing non-HTML reports.</em> +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * @since 2.5</em> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L181" href="#L181">181</a> @Parameter( property = <span class="jxr_string">"outputEncoding"</span>, defaultValue = <span class="jxr_string">"${project.reporting.outputEncoding}"</span> ) +<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">private</strong> String outputEncoding; +<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"> * The projects in the reactor for aggregation report.</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> @Parameter( property = <span class="jxr_string">"reactorProjects"</span>, readonly = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">protected</strong> List<MavenProject> reactorProjects; +<a class="jxr_linenumber" name="L189" href="#L189">189</a> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * Whether to include the xml files generated by PMD/CPD in the site.</em> +<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"> * @since 3.0</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> @Parameter( defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> includeXmlInSite; +<a class="jxr_linenumber" name="L197" href="#L197">197</a> +<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * Skip the PMD/CPD report generation if there are no violations or duplications found. Defaults to</em> +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * <code>true</code>.</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.1</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( defaultValue = <span class="jxr_string">"true"</span> ) +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> skipEmptyReport; +<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"> * File that lists classes and rules to be excluded from failures.</em> +<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> * For PMD, this is a properties file. For CPD, this</em> +<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> * is a text file that contains comma-separated lists of classes</em> +<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * that are allowed to duplicate.</em> +<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * @since 3.7</em> +<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L215" href="#L215">215</a> @Parameter( property = <span class="jxr_string">"pmd.excludeFromFailureFile"</span>, defaultValue = <span class="jxr_string">""</span> ) +<a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">protected</strong> String excludeFromFailureFile; +<a class="jxr_linenumber" name="L217" href="#L217">217</a> +<a class="jxr_linenumber" name="L218" href="#L218">218</a> +<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment">/** The files that are being analyzed. */</em> +<a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">protected</strong> Map<File, PmdFileInfo> filesToProcess; +<a class="jxr_linenumber" name="L221" href="#L221">221</a> +<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L225" href="#L225">225</a> @Override +<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong class="jxr_keyword">protected</strong> MavenProject getProject() +<a class="jxr_linenumber" name="L227" href="#L227">227</a> { +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">return</strong> project; +<a class="jxr_linenumber" name="L229" href="#L229">229</a> } <a class="jxr_linenumber" name="L230" href="#L230">230</a> -<a class="jxr_linenumber" name="L231" href="#L231">231</a> String relativePath = -<a class="jxr_linenumber" name="L232" href="#L232">232</a> PathTool.getRelativePath( outputDirectory.getAbsolutePath(), xrefLoc.getAbsolutePath() ); -<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( relativePath ) ) -<a class="jxr_linenumber" name="L234" href="#L234">234</a> { -<a class="jxr_linenumber" name="L235" href="#L235">235</a> relativePath = <span class="jxr_string">"."</span>; -<a class="jxr_linenumber" name="L236" href="#L236">236</a> } -<a class="jxr_linenumber" name="L237" href="#L237">237</a> relativePath = relativePath + <span class="jxr_string">"/"</span> + xrefLoc.getName(); -<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">if</strong> ( xrefLoc.exists() ) -<a class="jxr_linenumber" name="L239" href="#L239">239</a> { -<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_comment">// XRef was already generated by manual execution of a lifecycle binding</em> -<a class="jxr_linenumber" name="L241" href="#L241">241</a> location = relativePath; -<a class="jxr_linenumber" name="L242" href="#L242">242</a> } -<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">else</strong> -<a class="jxr_linenumber" name="L244" href="#L244">244</a> { -<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_comment">// Not yet generated - check if the report is on its way</em> -<a class="jxr_linenumber" name="L246" href="#L246">246</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> ) -<a class="jxr_linenumber" name="L247" href="#L247">247</a> List<ReportPlugin> reportPlugins = project.getReportPlugins(); -<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong class="jxr_keyword">for</strong> ( ReportPlugin plugin : reportPlugins ) -<a class="jxr_linenumber" name="L249" href="#L249">249</a> { -<a class="jxr_linenumber" name="L250" href="#L250">250</a> String artifactId = plugin.getArtifactId(); -<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"maven-jxr-plugin"</span>.equals( artifactId ) || <span class="jxr_string">"jxr-maven-plugin"</span>.equals( artifactId ) ) -<a class="jxr_linenumber" name="L252" href="#L252">252</a> { -<a class="jxr_linenumber" name="L253" href="#L253">253</a> location = relativePath; -<a class="jxr_linenumber" name="L254" href="#L254">254</a> } -<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> -<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">if</strong> ( location == <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L259" href="#L259">259</a> { -<a class="jxr_linenumber" name="L260" href="#L260">260</a> getLog().warn( <span class="jxr_string">"Unable to locate Source XRef to link to - DISABLED"</span> ); -<a class="jxr_linenumber" name="L261" href="#L261">261</a> } -<a class="jxr_linenumber" name="L262" href="#L262">262</a> } -<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">return</strong> location; -<a class="jxr_linenumber" name="L264" href="#L264">264</a> } -<a class="jxr_linenumber" name="L265" href="#L265">265</a> -<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> * Convenience method to get the list of files where the PMD tool will be executed</em> -<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * @return a List of the files where the PMD tool will be executed</em> -<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException</em> -<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">protected</strong> Map<File, PmdFileInfo> getFilesToProcess() -<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">throws</strong> IOException -<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> ( aggregate && !project.isExecutionRoot() ) -<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> Collections.emptyMap(); +<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L234" href="#L234">234</a> @Override +<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">protected</strong> Renderer getSiteRenderer() +<a class="jxr_linenumber" name="L236" href="#L236">236</a> { +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">return</strong> siteRenderer; +<a class="jxr_linenumber" name="L238" href="#L238">238</a> } +<a class="jxr_linenumber" name="L239" href="#L239">239</a> +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">protected</strong> String constructXRefLocation( <strong class="jxr_keyword">boolean</strong> test ) +<a class="jxr_linenumber" name="L241" href="#L241">241</a> { +<a class="jxr_linenumber" name="L242" href="#L242">242</a> String location = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">if</strong> ( linkXRef ) +<a class="jxr_linenumber" name="L244" href="#L244">244</a> { +<a class="jxr_linenumber" name="L245" href="#L245">245</a> File xrefLoc = test ? xrefTestLocation : xrefLocation; +<a class="jxr_linenumber" name="L246" href="#L246">246</a> +<a class="jxr_linenumber" name="L247" href="#L247">247</a> String relativePath = +<a class="jxr_linenumber" name="L248" href="#L248">248</a> PathTool.getRelativePath( outputDirectory.getAbsolutePath(), xrefLoc.getAbsolutePath() ); +<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( relativePath ) ) +<a class="jxr_linenumber" name="L250" href="#L250">250</a> { +<a class="jxr_linenumber" name="L251" href="#L251">251</a> relativePath = <span class="jxr_string">"."</span>; +<a class="jxr_linenumber" name="L252" href="#L252">252</a> } +<a class="jxr_linenumber" name="L253" href="#L253">253</a> relativePath = relativePath + <span class="jxr_string">"/"</span> + xrefLoc.getName(); +<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">if</strong> ( xrefLoc.exists() ) +<a class="jxr_linenumber" name="L255" href="#L255">255</a> { +<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_comment">// XRef was already generated by manual execution of a lifecycle binding</em> +<a class="jxr_linenumber" name="L257" href="#L257">257</a> location = relativePath; +<a class="jxr_linenumber" name="L258" href="#L258">258</a> } +<a class="jxr_linenumber" name="L259" href="#L259">259</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="L260" href="#L260">260</a> { +<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_comment">// Not yet generated - check if the report is on its way</em> +<a class="jxr_linenumber" name="L262" href="#L262">262</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> ) +<a class="jxr_linenumber" name="L263" href="#L263">263</a> List<ReportPlugin> reportPlugins = project.getReportPlugins(); +<a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong class="jxr_keyword">for</strong> ( ReportPlugin plugin : reportPlugins ) +<a class="jxr_linenumber" name="L265" href="#L265">265</a> { +<a class="jxr_linenumber" name="L266" href="#L266">266</a> String artifactId = plugin.getArtifactId(); +<a class="jxr_linenumber" name="L267" href="#L267">267</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"maven-jxr-plugin"</span>.equals( artifactId ) || <span class="jxr_string">"jxr-maven-plugin"</span>.equals( artifactId ) ) +<a class="jxr_linenumber" name="L268" href="#L268">268</a> { +<a class="jxr_linenumber" name="L269" href="#L269">269</a> location = relativePath; +<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> +<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">if</strong> ( location == <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L275" href="#L275">275</a> { +<a class="jxr_linenumber" name="L276" href="#L276">276</a> getLog().warn( <span class="jxr_string">"Unable to locate Source XRef to link to - DISABLED"</span> ); +<a class="jxr_linenumber" name="L277" href="#L277">277</a> } <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">if</strong> ( excludeRoots == <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L281" href="#L281">281</a> { -<a class="jxr_linenumber" name="L282" href="#L282">282</a> excludeRoots = <strong class="jxr_keyword">new</strong> File[0]; -<a class="jxr_linenumber" name="L283" href="#L283">283</a> } -<a class="jxr_linenumber" name="L284" href="#L284">284</a> -<a class="jxr_linenumber" name="L285" href="#L285">285</a> Collection<File> excludeRootFiles = <strong class="jxr_keyword">new</strong> HashSet<File>( excludeRoots.length ); -<a class="jxr_linenumber" name="L286" href="#L286">286</a> -<a class="jxr_linenumber" name="L287" href="#L287">287</a> <strong class="jxr_keyword">for</strong> ( File file : excludeRoots ) -<a class="jxr_linenumber" name="L288" href="#L288">288</a> { -<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">if</strong> ( file.isDirectory() ) -<a class="jxr_linenumber" name="L290" href="#L290">290</a> { -<a class="jxr_linenumber" name="L291" href="#L291">291</a> excludeRootFiles.add( file ); -<a class="jxr_linenumber" name="L292" href="#L292">292</a> } -<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> List<PmdFileInfo> directories = <strong class="jxr_keyword">new</strong> ArrayList<PmdFileInfo>(); -<a class="jxr_linenumber" name="L296" href="#L296">296</a> -<a class="jxr_linenumber" name="L297" href="#L297">297</a> <strong class="jxr_keyword">if</strong> ( compileSourceRoots != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L298" href="#L298">298</a> { -<a class="jxr_linenumber" name="L299" href="#L299">299</a> <strong class="jxr_keyword">for</strong> ( String root : compileSourceRoots ) -<a class="jxr_linenumber" name="L300" href="#L300">300</a> { -<a class="jxr_linenumber" name="L301" href="#L301">301</a> File sroot = <strong class="jxr_keyword">new</strong> File( root ); -<a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">if</strong> ( sroot.exists() ) -<a class="jxr_linenumber" name="L303" href="#L303">303</a> { -<a class="jxr_linenumber" name="L304" href="#L304">304</a> String sourceXref = constructXRefLocation( false ); -<a class="jxr_linenumber" name="L305" href="#L305">305</a> directories.add( <strong class="jxr_keyword">new</strong> PmdFileInfo( project, sroot, sourceXref ) ); -<a class="jxr_linenumber" name="L306" href="#L306">306</a> } -<a class="jxr_linenumber" name="L307" href="#L307">307</a> } -<a class="jxr_linenumber" name="L308" href="#L308">308</a> +<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">return</strong> location; +<a class="jxr_linenumber" name="L280" href="#L280">280</a> } +<a class="jxr_linenumber" name="L281" href="#L281">281</a> +<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment"> * Convenience method to get the list of files where the PMD tool will be executed</em> +<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> * @return a List of the files where the PMD tool will be executed</em> +<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException</em> +<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L288" href="#L288">288</a> <strong class="jxr_keyword">protected</strong> Map<File, PmdFileInfo> getFilesToProcess() +<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">throws</strong> IOException +<a class="jxr_linenumber" name="L290" href="#L290">290</a> { +<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">if</strong> ( aggregate && !project.isExecutionRoot() ) +<a class="jxr_linenumber" name="L292" href="#L292">292</a> { +<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">return</strong> Collections.emptyMap(); +<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">if</strong> ( excludeRoots == <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L297" href="#L297">297</a> { +<a class="jxr_linenumber" name="L298" href="#L298">298</a> excludeRoots = <strong class="jxr_keyword">new</strong> File[0]; +<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> Collection<File> excludeRootFiles = <strong class="jxr_keyword">new</strong> HashSet<>( excludeRoots.length ); +<a class="jxr_linenumber" name="L302" href="#L302">302</a> +<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">for</strong> ( File file : excludeRoots ) +<a class="jxr_linenumber" name="L304" href="#L304">304</a> { +<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">if</strong> ( file.isDirectory() ) +<a class="jxr_linenumber" name="L306" href="#L306">306</a> { +<a class="jxr_linenumber" name="L307" href="#L307">307</a> excludeRootFiles.add( file ); +<a class="jxr_linenumber" name="L308" href="#L308">308</a> } <a class="jxr_linenumber" name="L309" href="#L309">309</a> } -<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">if</strong> ( includeTests ) -<a class="jxr_linenumber" name="L311" href="#L311">311</a> { -<a class="jxr_linenumber" name="L312" href="#L312">312</a> <strong class="jxr_keyword">if</strong> ( testSourceRoots != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L313" href="#L313">313</a> { -<a class="jxr_linenumber" name="L314" href="#L314">314</a> <strong class="jxr_keyword">for</strong> ( String root : testSourceRoots ) -<a class="jxr_linenumber" name="L315" href="#L315">315</a> { -<a class="jxr_linenumber" name="L316" href="#L316">316</a> File sroot = <strong class="jxr_keyword">new</strong> File( root ); -<a class="jxr_linenumber" name="L317" href="#L317">317</a> <strong class="jxr_keyword">if</strong> ( sroot.exists() ) -<a class="jxr_linenumber" name="L318" href="#L318">318</a> { -<a class="jxr_linenumber" name="L319" href="#L319">319</a> String testXref = constructXRefLocation( <strong class="jxr_keyword">true</strong> ); -<a class="jxr_linenumber" name="L320" href="#L320">320</a> directories.add( <strong class="jxr_keyword">new</strong> PmdFileInfo( project, sroot, testXref ) ); -<a class="jxr_linenumber" name="L321" href="#L321">321</a> } -<a class="jxr_linenumber" name="L322" href="#L322">322</a> } -<a class="jxr_linenumber" name="L323" href="#L323">323</a> } -<a class="jxr_linenumber" name="L324" href="#L324">324</a> } -<a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong class="jxr_keyword">if</strong> ( aggregate ) -<a class="jxr_linenumber" name="L326" href="#L326">326</a> { -<a class="jxr_linenumber" name="L327" href="#L327">327</a> <strong class="jxr_keyword">for</strong> ( MavenProject localProject : reactorProjects ) -<a class="jxr_linenumber" name="L328" href="#L328">328</a> { -<a class="jxr_linenumber" name="L329" href="#L329">329</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> ) -<a class="jxr_linenumber" name="L330" href="#L330">330</a> List<String> localCompileSourceRoots = localProject.getCompileSourceRoots(); -<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">for</strong> ( String root : localCompileSourceRoots ) -<a class="jxr_linenumber" name="L332" href="#L332">332</a> { -<a class="jxr_linenumber" name="L333" href="#L333">333</a> File sroot = <strong class="jxr_keyword">new</strong> File( root ); -<a class="jxr_linenumber" name="L334" href="#L334">334</a> <strong class="jxr_keyword">if</strong> ( sroot.exists() ) -<a class="jxr_linenumber" name="L335" href="#L335">335</a> { -<a class="jxr_linenumber" name="L336" href="#L336">336</a> String sourceXref = constructXRefLocation( false ); -<a class="jxr_linenumber" name="L337" href="#L337">337</a> directories.add( <strong class="jxr_keyword">new</strong> PmdFileInfo( localProject, sroot, sourceXref ) ); -<a class="jxr_linenumber" name="L338" href="#L338">338</a> } -<a class="jxr_linenumber" name="L339" href="#L339">339</a> } -<a class="jxr_linenumber" name="L340" href="#L340">340</a> <strong class="jxr_keyword">if</strong> ( includeTests ) -<a class="jxr_linenumber" name="L341" href="#L341">341</a> { -<a class="jxr_linenumber" name="L342" href="#L342">342</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> ) -<a class="jxr_linenumber" name="L343" href="#L343">343</a> List<String> localTestCompileSourceRoots = localProject.getTestCompileSourceRoots(); -<a class="jxr_linenumber" name="L344" href="#L344">344</a> <strong class="jxr_keyword">for</strong> ( String root : localTestCompileSourceRoots ) -<a class="jxr_linenumber" name="L345" href="#L345">345</a> { -<a class="jxr_linenumber" name="L346" href="#L346">346</a> File sroot = <strong class="jxr_keyword">new</strong> File( root ); -<a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong class="jxr_keyword">if</strong> ( sroot.exists() ) -<a class="jxr_linenumber" name="L348" href="#L348">348</a> { -<a class="jxr_linenumber" name="L349" href="#L349">349</a> String testXref = constructXRefLocation( <strong class="jxr_keyword">true</strong> ); -<a class="jxr_linenumber" name="L350" href="#L350">350</a> directories.add( <strong class="jxr_keyword">new</strong> PmdFileInfo( localProject, sroot, testXref ) ); -<a class="jxr_linenumber" name="L351" href="#L351">351</a> } -<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> } -<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> -<a class="jxr_linenumber" name="L358" href="#L358">358</a> String excluding = getExcludes(); -<a class="jxr_linenumber" name="L359" href="#L359">359</a> getLog().debug( <span class="jxr_string">"Exclusions: "</span> + excluding ); -<a class="jxr_linenumber" name="L360" href="#L360">360</a> String including = getIncludes(); -<a class="jxr_linenumber" name="L361" href="#L361">361</a> getLog().debug( <span class="jxr_string">"Inclusions: "</span> + including ); -<a class="jxr_linenumber" name="L362" href="#L362">362</a> -<a class="jxr_linenumber" name="L363" href="#L363">363</a> Map<File, PmdFileInfo> files = <strong class="jxr_keyword">new</strong> TreeMap<File, PmdFileInfo>(); -<a class="jxr_linenumber" name="L364" href="#L364">364</a> -<a class="jxr_linenumber" name="L365" href="#L365">365</a> <strong class="jxr_keyword">for</strong> ( PmdFileInfo finfo : directories ) -<a class="jxr_linenumber" name="L366" href="#L366">366</a> { -<a class="jxr_linenumber" name="L367" href="#L367">367</a> getLog().debug( <span class="jxr_string">"Searching for files in directory "</span> + finfo.getSourceDirectory().toString() ); -<a class="jxr_linenumber" name="L368" href="#L368">368</a> File sourceDirectory = finfo.getSourceDirectory(); -<a class="jxr_linenumber" name="L369" href="#L369">369</a> <strong class="jxr_keyword">if</strong> ( sourceDirectory.isDirectory() && !excludeRootFiles.contains( sourceDirectory ) ) -<a class="jxr_linenumber" name="L370" href="#L370">370</a> { -<a class="jxr_linenumber" name="L371" href="#L371">371</a> List<File> newfiles = FileUtils.getFiles( sourceDirectory, including, excluding ); -<a class="jxr_linenumber" name="L372" href="#L372">372</a> <strong class="jxr_keyword">for</strong> ( File newfile : newfiles ) -<a class="jxr_linenumber" name="L373" href="#L373">373</a> { -<a class="jxr_linenumber" name="L374" href="#L374">374</a> files.put( newfile.getCanonicalFile(), finfo ); -<a class="jxr_linenumber" name="L375" href="#L375">375</a> } -<a class="jxr_linenumber" name="L376" href="#L376">376</a> } -<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">return</strong> files; -<a class="jxr_linenumber" name="L380" href="#L380">380</a> } +<a class="jxr_linenumber" name="L310" href="#L310">310</a> +<a class="jxr_linenumber" name="L311" href="#L311">311</a> List<PmdFileInfo> directories = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L312" href="#L312">312</a> +<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">if</strong> ( <strong class="jxr_keyword">null</strong> == compileSourceRoots ) +<a class="jxr_linenumber" name="L314" href="#L314">314</a> { +<a class="jxr_linenumber" name="L315" href="#L315">315</a> compileSourceRoots = project.getCompileSourceRoots(); +<a class="jxr_linenumber" name="L316" href="#L316">316</a> } +<a class="jxr_linenumber" name="L317" href="#L317">317</a> <strong class="jxr_keyword">if</strong> ( compileSourceRoots != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L318" href="#L318">318</a> { +<a class="jxr_linenumber" name="L319" href="#L319">319</a> <strong class="jxr_keyword">for</strong> ( String root : compileSourceRoots ) +<a class="jxr_linenumber" name="L320" href="#L320">320</a> { +<a class="jxr_linenumber" name="L321" href="#L321">321</a> File sroot = <strong class="jxr_keyword">new</strong> File( root ); +<a class="jxr_linenumber" name="L322" href="#L322">322</a> <strong class="jxr_keyword">if</strong> ( sroot.exists() ) +<a class="jxr_linenumber" name="L323" href="#L323">323</a> { +<a class="jxr_linenumber" name="L324" href="#L324">324</a> String sourceXref = constructXRefLocation( false ); +<a class="jxr_linenumber" name="L325" href="#L325">325</a> directories.add( <strong class="jxr_keyword">new</strong> PmdFileInfo( project, sroot, sourceXref ) ); +<a class="jxr_linenumber" name="L326" href="#L326">326</a> } +<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> +<a class="jxr_linenumber" name="L330" href="#L330">330</a> <strong class="jxr_keyword">if</strong> ( <strong class="jxr_keyword">null</strong> == testSourceRoots ) +<a class="jxr_linenumber" name="L331" href="#L331">331</a> { +<a class="jxr_linenumber" name="L332" href="#L332">332</a> testSourceRoots = project.getTestCompileSourceRoots(); +<a class="jxr_linenumber" name="L333" href="#L333">333</a> } +<a class="jxr_linenumber" name="L334" href="#L334">334</a> <strong class="jxr_keyword">if</strong> ( includeTests ) +<a class="jxr_linenumber" name="L335" href="#L335">335</a> { +<a class="jxr_linenumber" name="L336" href="#L336">336</a> <strong class="jxr_keyword">if</strong> ( testSourceRoots != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L337" href="#L337">337</a> { +<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong class="jxr_keyword">for</strong> ( String root : testSourceRoots ) +<a class="jxr_linenumber" name="L339" href="#L339">339</a> { +<a class="jxr_linenumber" name="L340" href="#L340">340</a> File sroot = <strong class="jxr_keyword">new</strong> File( root ); +<a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong class="jxr_keyword">if</strong> ( sroot.exists() ) +<a class="jxr_linenumber" name="L342" href="#L342">342</a> { +<a class="jxr_linenumber" name="L343" href="#L343">343</a> String testXref = constructXRefLocation( <strong class="jxr_keyword">true</strong> ); +<a class="jxr_linenumber" name="L344" href="#L344">344</a> directories.add( <strong class="jxr_keyword">new</strong> PmdFileInfo( project, sroot, testXref ) ); +<a class="jxr_linenumber" name="L345" href="#L345">345</a> } +<a class="jxr_linenumber" name="L346" href="#L346">346</a> } +<a class="jxr_linenumber" name="L347" href="#L347">347</a> } +<a class="jxr_linenumber" name="L348" href="#L348">348</a> } +<a class="jxr_linenumber" name="L349" href="#L349">349</a> <strong class="jxr_keyword">if</strong> ( aggregate ) +<a class="jxr_linenumber" name="L350" href="#L350">350</a> { +<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">for</strong> ( MavenProject localProject : reactorProjects ) +<a class="jxr_linenumber" name="L352" href="#L352">352</a> { +<a class="jxr_linenumber" name="L353" href="#L353">353</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> ) +<a class="jxr_linenumber" name="L354" href="#L354">354</a> List<String> localCompileSourceRoots = localProject.getCompileSourceRoots(); +<a class="jxr_linenumber" name="L355" href="#L355">355</a> <strong class="jxr_keyword">for</strong> ( String root : localCompileSourceRoots ) +<a class="jxr_linenumber" name="L356" href="#L356">356</a> { +<a class="jxr_linenumber" name="L357" href="#L357">357</a> File sroot = <strong class="jxr_keyword">new</strong> File( root ); +<a class="jxr_linenumber" name="L358" href="#L358">358</a> <strong class="jxr_keyword">if</strong> ( sroot.exists() ) +<a class="jxr_linenumber" name="L359" href="#L359">359</a> { +<a class="jxr_linenumber" name="L360" href="#L360">360</a> String sourceXref = constructXRefLocation( false ); +<a class="jxr_linenumber" name="L361" href="#L361">361</a> directories.add( <strong class="jxr_keyword">new</strong> PmdFileInfo( localProject, sroot, sourceXref ) ); +<a class="jxr_linenumber" name="L362" href="#L362">362</a> } +<a class="jxr_linenumber" name="L363" href="#L363">363</a> } +<a class="jxr_linenumber" name="L364" href="#L364">364</a> <strong class="jxr_keyword">if</strong> ( includeTests ) +<a class="jxr_linenumber" name="L365" href="#L365">365</a> { +<a class="jxr_linenumber" name="L366" href="#L366">366</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> ) +<a class="jxr_linenumber" name="L367" href="#L367">367</a> List<String> localTestCompileSourceRoots = localProject.getTestCompileSourceRoots(); +<a class="jxr_linenumber" name="L368" href="#L368">368</a> <strong class="jxr_keyword">for</strong> ( String root : localTestCompileSourceRoots ) +<a class="jxr_linenumber" name="L369" href="#L369">369</a> { +<a class="jxr_linenumber" name="L370" href="#L370">370</a> File sroot = <strong class="jxr_keyword">new</strong> File( root ); +<a class="jxr_linenumber" name="L371" href="#L371">371</a> <strong class="jxr_keyword">if</strong> ( sroot.exists() ) +<a class="jxr_linenumber" name="L372" href="#L372">372</a> { +<a class="jxr_linenumber" name="L373" href="#L373">373</a> String testXref = constructXRefLocation( <strong class="jxr_keyword">true</strong> ); +<a class="jxr_linenumber" name="L374" href="#L374">374</a> directories.add( <strong class="jxr_keyword">new</strong> PmdFileInfo( localProject, sroot, testXref ) ); +<a class="jxr_linenumber" name="L375" href="#L375">375</a> } +<a class="jxr_linenumber" name="L376" href="#L376">376</a> } +<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> +<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> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L383" href="#L383">383</a> <em class="jxr_javadoccomment"> * Gets the comma separated list of effective include patterns.</em> -<a class="jxr_linenumber" name="L384" href="#L384">384</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L385" href="#L385">385</a> <em class="jxr_javadoccomment"> * @return The comma separated list of effective include patterns, never <code>null</code>.</em> -<a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L387" href="#L387">387</a> <strong class="jxr_keyword">private</strong> String getIncludes() -<a class="jxr_linenumber" name="L388" href="#L388">388</a> { -<a class="jxr_linenumber" name="L389" href="#L389">389</a> Collection<String> patterns = <strong class="jxr_keyword">new</strong> LinkedHashSet<String>(); -<a class="jxr_linenumber" name="L390" href="#L390">390</a> <strong class="jxr_keyword">if</strong> ( includes != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L391" href="#L391">391</a> { -<a class="jxr_linenumber" name="L392" href="#L392">392</a> patterns.addAll( includes ); -<a class="jxr_linenumber" name="L393" href="#L393">393</a> } -<a class="jxr_linenumber" name="L394" href="#L394">394</a> <strong class="jxr_keyword">if</strong> ( patterns.isEmpty() ) -<a class="jxr_linenumber" name="L395" href="#L395">395</a> { -<a class="jxr_linenumber" name="L396" href="#L396">396</a> patterns.add( <span class="jxr_string">"**/*.java"</span> ); -<a class="jxr_linenumber" name="L397" href="#L397">397</a> } -<a class="jxr_linenumber" name="L398" href="#L398">398</a> <strong class="jxr_keyword">return</strong> StringUtils.join( patterns.iterator(), <span class="jxr_string">","</span> ); -<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> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L402" href="#L402">402</a> <em class="jxr_javadoccomment"> * Gets the comma separated list of effective exclude patterns.</em> -<a class="jxr_linenumber" name="L403" href="#L403">403</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L404" href="#L404">404</a> <em class="jxr_javadoccomment"> * @return The comma separated list of effective exclude patterns, never <code>null</code>.</em> -<a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L406" href="#L406">406</a> <strong class="jxr_keyword">private</strong> String getExcludes() +<a class="jxr_linenumber" name="L382" href="#L382">382</a> String excluding = getExcludes(); +<a class="jxr_linenumber" name="L383" href="#L383">383</a> getLog().debug( <span class="jxr_string">"Exclusions: "</span> + excluding ); +<a class="jxr_linenumber" name="L384" href="#L384">384</a> String including = getIncludes(); +<a class="jxr_linenumber" name="L385" href="#L385">385</a> getLog().debug( <span class="jxr_string">"Inclusions: "</span> + including ); +<a class="jxr_linenumber" name="L386" href="#L386">386</a> +<a class="jxr_linenumber" name="L387" href="#L387">387</a> Map<File, PmdFileInfo> files = <strong class="jxr_keyword">new</strong> TreeMap<>(); +<a class="jxr_linenumber" name="L388" href="#L388">388</a> +<a class="jxr_linenumber" name="L389" href="#L389">389</a> <strong class="jxr_keyword">for</strong> ( PmdFileInfo finfo : directories ) +<a class="jxr_linenumber" name="L390" href="#L390">390</a> { +<a class="jxr_linenumber" name="L391" href="#L391">391</a> getLog().debug( <span class="jxr_string">"Searching for files in directory "</span> + finfo.getSourceDirectory().toString() ); +<a class="jxr_linenumber" name="L392" href="#L392">392</a> File sourceDirectory = finfo.getSourceDirectory(); +<a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong class="jxr_keyword">if</strong> ( sourceDirectory.isDirectory() && !isDirectoryExcluded( excludeRootFiles, sourceDirectory ) ) +<a class="jxr_linenumber" name="L394" href="#L394">394</a> { +<a class="jxr_linenumber" name="L395" href="#L395">395</a> List<File> newfiles = FileUtils.getFiles( sourceDirectory, including, excluding ); +<a class="jxr_linenumber" name="L396" href="#L396">396</a> <strong class="jxr_keyword">for</strong> ( File newfile : newfiles ) +<a class="jxr_linenumber" name="L397" href="#L397">397</a> { +<a class="jxr_linenumber" name="L398" href="#L398">398</a> files.put( newfile.getCanonicalFile(), finfo ); +<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> } +<a class="jxr_linenumber" name="L402" href="#L402">402</a> +<a class="jxr_linenumber" name="L403" href="#L403">403</a> <strong class="jxr_keyword">return</strong> files; +<a class="jxr_linenumber" name="L404" href="#L404">404</a> } +<a class="jxr_linenumber" name="L405" href="#L405">405</a> +<a class="jxr_linenumber" name="L406" href="#L406">406</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isDirectoryExcluded( Collection<File> excludeRootFiles, File sourceDirectoryToCheck ) <a class="jxr_linenumber" name="L407" href="#L407">407</a> { -<a class="jxr_linenumber" name="L408" href="#L408">408</a> Collection<String> patterns = <strong class="jxr_keyword">new</strong> LinkedHashSet<String>( FileUtils.getDefaultExcludesAsList() ); -<a class="jxr_linenumber" name="L409" href="#L409">409</a> <strong class="jxr_keyword">if</strong> ( excludes != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L408" href="#L408">408</a> <strong class="jxr_keyword">boolean</strong> returnVal = false; +<a class="jxr_linenumber" name="L409" href="#L409">409</a> <strong class="jxr_keyword">for</strong> ( File excludeDir : excludeRootFiles ) <a class="jxr_linenumber" name="L410" href="#L410">410</a> { -<a class="jxr_linenumber" name="L411" href="#L411">411</a> patterns.addAll( excludes ); -<a class="jxr_linenumber" name="L412" href="#L412">412</a> } -<a class="jxr_linenumber" name="L413" href="#L413">413</a> <strong class="jxr_keyword">return</strong> StringUtils.join( patterns.iterator(), <span class="jxr_string">","</span> ); -<a class="jxr_linenumber" name="L414" href="#L414">414</a> } -<a class="jxr_linenumber" name="L415" href="#L415">415</a> -<a class="jxr_linenumber" name="L416" href="#L416">416</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isHtml() -<a class="jxr_linenumber" name="L417" href="#L417">417</a> { -<a class="jxr_linenumber" name="L418" href="#L418">418</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"html"</span>.equals( format ); -<a class="jxr_linenumber" name="L419" href="#L419">419</a> } -<a class="jxr_linenumber" name="L420" href="#L420">420</a> -<a class="jxr_linenumber" name="L421" href="#L421">421</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isXml() -<a class="jxr_linenumber" name="L422" href="#L422">422</a> { -<a class="jxr_linenumber" name="L423" href="#L423">423</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"xml"</span>.equals( format ); -<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> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L427" href="#L427">427</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> -<a class="jxr_linenumber" name="L428" href="#L428">428</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L429" href="#L429">429</a> @Override -<a class="jxr_linenumber" name="L430" href="#L430">430</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() -<a class="jxr_linenumber" name="L431" href="#L431">431</a> { -<a class="jxr_linenumber" name="L432" href="#L432">432</a> <strong class="jxr_keyword">if</strong> ( aggregate && !project.isExecutionRoot() ) -<a class="jxr_linenumber" name="L433" href="#L433">433</a> { -<a class="jxr_linenumber" name="L434" href="#L434">434</a> <strong class="jxr_keyword">return</strong> false; -<a class="jxr_linenumber" name="L435" href="#L435">435</a> } -<a class="jxr_linenumber" name="L436" href="#L436">436</a> -<a class="jxr_linenumber" name="L437" href="#L437">437</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"pom"</span>.equals( project.getPackaging() ) && !aggregate ) -<a class="jxr_linenumber" name="L438" href="#L438">438</a> { -<a class="jxr_linenumber" name="L439" href="#L439">439</a> <strong class="jxr_keyword">return</strong> false; -<a class="jxr_linenumber" name="L440" href="#L440">440</a> } -<a class="jxr_linenumber" name="L441" href="#L441">441</a> -<a class="jxr_linenumber" name="L442" href="#L442">442</a> <em class="jxr_comment">// if format is XML, we need to output it even if the file list is empty</em> -<a class="jxr_linenumber" name="L443" href="#L443">443</a> <em class="jxr_comment">// so the "check" goals can check for failures</em> -<a class="jxr_linenumber" name="L444" href="#L444">444</a> <strong class="jxr_keyword">if</strong> ( isXml() ) -<a class="jxr_linenumber" name="L445" href="#L445">445</a> { -<a class="jxr_linenumber" name="L446" href="#L446">446</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; -<a class="jxr_linenumber" name="L447" href="#L447">447</a> } -<a class="jxr_linenumber" name="L448" href="#L448">448</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L449" href="#L449">449</a> { -<a class="jxr_linenumber" name="L450" href="#L450">450</a> filesToProcess = getFilesToProcess(); -<a class="jxr_linenumber" name="L451" href="#L451">451</a> <strong class="jxr_keyword">if</strong> ( filesToProcess.isEmpty() ) -<a class="jxr_linenumber" name="L452" href="#L452">452</a> { -<a class="jxr_linenumber" name="L453" href="#L453">453</a> <strong class="jxr_keyword">return</strong> false; -<a class="jxr_linenumber" name="L454" href="#L454">454</a> } -<a class="jxr_linenumber" name="L455" href="#L455">455</a> } -<a class="jxr_linenumber" name="L456" href="#L456">456</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) -<a class="jxr_linenumber" name="L457" href="#L457">457</a> { -<a class="jxr_linenumber" name="L458" href="#L458">458</a> getLog().error( e ); -<a class="jxr_linenumber" name="L459" href="#L459">459</a> } -<a class="jxr_linenumber" name="L460" href="#L460">460</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; -<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> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L464" href="#L464">464</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> -<a class="jxr_linenumber" name="L465" href="#L465">465</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L466" href="#L466">466</a> @Override -<a class="jxr_linenumber" name="L467" href="#L467">467</a> <strong class="jxr_keyword">protected</strong> String getOutputDirectory() -<a class="jxr_linenumber" name="L468" href="#L468">468</a> { -<a class="jxr_linenumber" name="L469" href="#L469">469</a> <strong class="jxr_keyword">return</strong> outputDirectory.getAbsolutePath(); -<a class="jxr_linenumber" name="L470" href="#L470">470</a> } -<a class="jxr_linenumber" name="L471" href="#L471">471</a> -<a class="jxr_linenumber" name="L472" href="#L472">472</a> <strong class="jxr_keyword">protected</strong> String getSourceEncoding() -<a class="jxr_linenumber" name="L473" href="#L473">473</a> { -<a class="jxr_linenumber" name="L474" href="#L474">474</a> <strong class="jxr_keyword">return</strong> sourceEncoding; -<a class="jxr_linenumber" name="L475" href="#L475">475</a> } -<a class="jxr_linenumber" name="L476" href="#L476">476</a> -<a class="jxr_linenumber" name="L477" href="#L477">477</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L478" href="#L478">478</a> <em class="jxr_javadoccomment"> * Gets the effective reporting output files encoding.</em> -<a class="jxr_linenumber" name="L479" href="#L479">479</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L480" href="#L480">480</a> <em class="jxr_javadoccomment"> * @return The effective reporting output file encoding, never <code>null</code>.</em> -<a class="jxr_linenumber" name="L481" href="#L481">481</a> <em class="jxr_javadoccomment"> * @since 2.5</em> -<a class="jxr_linenumber" name="L482" href="#L482">482</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L483" href="#L483">483</a> <strong class="jxr_keyword">protected</strong> String getOutputEncoding() -<a class="jxr_linenumber" name="L484" href="#L484">484</a> { -<a class="jxr_linenumber" name="L485" href="#L485">485</a> <strong class="jxr_keyword">return</strong> ( outputEncoding != <strong class="jxr_keyword">null</strong> ) ? outputEncoding : ReaderFactory.UTF_8; -<a class="jxr_linenumber" name="L486" href="#L486">486</a> } -<a class="jxr_linenumber" name="L487" href="#L487">487</a> -<a class="jxr_linenumber" name="L488" href="#L488">488</a> <strong class="jxr_keyword">static</strong> String getPmdVersion() -<a class="jxr_linenumber" name="L489" href="#L489">489</a> { -<a class="jxr_linenumber" name="L490" href="#L490">490</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L491" href="#L491">491</a> { -<a class="jxr_linenumber" name="L492" href="#L492">492</a> <strong class="jxr_keyword">return</strong> (String) PMD.<strong class="jxr_keyword">class</strong>.getField( <span class="jxr_string">"VERSION"</span> ).get( <strong class="jxr_keyword">null</strong> ); -<a class="jxr_linenumber" name="L493" href="#L493">493</a> } -<a class="jxr_linenumber" name="L494" href="#L494">494</a> <strong class="jxr_keyword">catch</strong> ( IllegalAccessException e ) -<a class="jxr_linenumber" name="L495" href="#L495">495</a> { -<a class="jxr_linenumber" name="L496" href="#L496">496</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException( <span class="jxr_string">"PMD VERSION field not accessible"</span>, e ); -<a class="jxr_linenumber" name="L497" href="#L497">497</a> } -<a class="jxr_linenumber" name="L498" href="#L498">498</a> <strong class="jxr_keyword">catch</strong> ( NoSuchFieldException e ) -<a class="jxr_linenumber" name="L499" href="#L499">499</a> { -<a class="jxr_linenumber" name="L500" href="#L500">500</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException( <span class="jxr_string">"PMD VERSION field not found"</span>, e ); -<a class="jxr_linenumber" name="L501" href="#L501">501</a> } -<a class="jxr_linenumber" name="L502" href="#L502">502</a> } -<a class="jxr_linenumber" name="L503" href="#L503">503</a> } +<a class="jxr_linenumber" name="L411" href="#L411">411</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L412" href="#L412">412</a> { +<a class="jxr_linenumber" name="L413" href="#L413">413</a> <strong class="jxr_keyword">if</strong> ( sourceDirectoryToCheck.getCanonicalPath().startsWith( excludeDir.getCanonicalPath() ) ) +<a class="jxr_linenumber" name="L414" href="#L414">414</a> { +<a class="jxr_linenumber" name="L415" href="#L415">415</a> getLog().debug( <span class="jxr_string">"Directory "</span> + sourceDirectoryToCheck.getAbsolutePath() +<a class="jxr_linenumber" name="L416" href="#L416">416</a> + <span class="jxr_string">" has been excluded as it matches excludeRoot "</span> +<a class="jxr_linenumber" name="L417" href="#L417">417</a> + excludeDir.getAbsolutePath() ); +<a class="jxr_linenumber" name="L418" href="#L418">418</a> returnVal = <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L419" href="#L419">419</a> <strong class="jxr_keyword">break</strong>; +<a class="jxr_linenumber" name="L420" href="#L420">420</a> } +<a class="jxr_linenumber" name="L421" href="#L421">421</a> } +<a class="jxr_linenumber" name="L422" href="#L422">422</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) +<a class="jxr_linenumber" name="L423" href="#L423">423</a> { +<a class="jxr_linenumber" name="L424" href="#L424">424</a> getLog().warn( <span class="jxr_string">"Error while checking "</span> + sourceDirectoryToCheck +<a class="jxr_linenumber" name="L425" href="#L425">425</a> + <span class="jxr_string">" whether it should be excluded."</span>, e ); +<a class="jxr_linenumber" name="L426" href="#L426">426</a> } +<a class="jxr_linenumber" name="L427" href="#L427">427</a> } +<a class="jxr_linenumber" name="L428" href="#L428">428</a> <strong class="jxr_keyword">return</strong> returnVal; +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L432" href="#L432">432</a> <em class="jxr_javadoccomment"> * Gets the comma separated list of effective include patterns.</em> +<a class="jxr_linenumber" name="L433" href="#L433">433</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L434" href="#L434">434</a> <em class="jxr_javadoccomment"> * @return The comma separated list of effective include patterns, never <code>null</code>.</em> +<a class="jxr_linenumber" name="L435" href="#L435">435</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L436" href="#L436">436</a> <strong class="jxr_keyword">private</strong> String getIncludes() +<a class="jxr_linenumber" name="L437" href="#L437">437</a> { +<a class="jxr_linenumber" name="L438" href="#L438">438</a> Collection<String> patterns = <strong class="jxr_keyword">new</strong> LinkedHashSet<>(); +<a class="jxr_linenumber" name="L439" href="#L439">439</a> <strong class="jxr_keyword">if</strong> ( includes != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L440" href="#L440">440</a> { +<a class="jxr_linenumber" name="L441" href="#L441">441</a> patterns.addAll( includes ); +<a class="jxr_linenumber" name="L442" href="#L442">442</a> } +<a class="jxr_linenumber" name="L443" href="#L443">443</a> <strong class="jxr_keyword">if</strong> ( patterns.isEmpty() ) +<a class="jxr_linenumber" name="L444" href="#L444">444</a> { +<a class="jxr_linenumber" name="L445" href="#L445">445</a> patterns.add( <span class="jxr_string">"**/*.java"</span> ); +<a class="jxr_linenumber" name="L446" href="#L446">446</a> } +<a class="jxr_linenumber" name="L447" href="#L447">447</a> <strong class="jxr_keyword">return</strong> StringUtils.join( patterns.iterator(), <span class="jxr_string">","</span> ); +<a class="jxr_linenumber" name="L448" href="#L448">448</a> } +<a class="jxr_linenumber" name="L449" href="#L449">449</a> +<a class="jxr_linenumber" name="L450" href="#L450">450</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L451" href="#L451">451</a> <em class="jxr_javadoccomment"> * Gets the comma separated list of effective exclude patterns.</em> +<a class="jxr_linenumber" name="L452" href="#L452">452</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L453" href="#L453">453</a> <em class="jxr_javadoccomment"> * @return The comma separated list of effective exclude patterns, never <code>null</code>.</em> +<a class="jxr_linenumber" name="L454" href="#L454">454</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L455" href="#L455">455</a> <strong class="jxr_keyword">private</strong> String getExcludes() +<a class="jxr_linenumber" name="L456" href="#L456">456</a> { +<a class="jxr_linenumber" name="L457" href="#L457">457</a> Collection<String> patterns = <strong class="jxr_keyword">new</strong> LinkedHashSet<>( FileUtils.getDefaultExcludesAsList() ); +<a class="jxr_linenumber" name="L458" href="#L458">458</a> <strong class="jxr_keyword">if</strong> ( excludes != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L459" href="#L459">459</a> { +<a class="jxr_linenumber" name="L460" href="#L460">460</a> patterns.addAll( excludes ); +<a class="jxr_linenumber" name="L461" href="#L461">461</a> } +<a class="jxr_linenumber" name="L462" href="#L462">462</a> <strong class="jxr_keyword">return</strong> StringUtils.join( patterns.iterator(), <span class="jxr_string">","</span> ); +<a class="jxr_linenumber" name="L463" href="#L463">463</a> } +<a class="jxr_linenumber" name="L464" href="#L464">464</a> +<a class="jxr_linenumber" name="L465" href="#L465">465</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isHtml() +<a class="jxr_linenumber" name="L466" href="#L466">466</a> { +<a class="jxr_linenumber" name="L467" href="#L467">467</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"html"</span>.equals( format ); +<a class="jxr_linenumber" name="L468" href="#L468">468</a> } +<a class="jxr_linenumber" name="L469" href="#L469">469</a> +<a class="jxr_linenumber" name="L470" href="#L470">470</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isXml() +<a class="jxr_linenumber" name="L471" href="#L471">471</a> { +<a class="jxr_linenumber" name="L472" href="#L472">472</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"xml"</span>.equals( format ); +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L476" href="#L476">476</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L477" href="#L477">477</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L478" href="#L478">478</a> @Override +<a class="jxr_linenumber" name="L479" href="#L479">479</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() +<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> ( aggregate && !project.isExecutionRoot() ) +<a class="jxr_linenumber" name="L482" href="#L482">482</a> { +<a class="jxr_linenumber" name="L483" href="#L483">483</a> <strong class="jxr_keyword">return</strong> false; +<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">if</strong> ( <span class="jxr_string">"pom"</span>.equals( project.getPackaging() ) && !aggregate ) +<a class="jxr_linenumber" name="L487" href="#L487">487</a> { +<a class="jxr_linenumber" name="L488" href="#L488">488</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L489" href="#L489">489</a> } +<a class="jxr_linenumber" name="L490" href="#L490">490</a> +<a class="jxr_linenumber" name="L491" href="#L491">491</a> <em class="jxr_comment">// if format is XML, we need to output it even if the file list is empty</em> +<a class="jxr_linenumber" name="L492" href="#L492">492</a> <em class="jxr_comment">// so the "check" goals can check for failures</em> +<a class="jxr_linenumber" name="L493" href="#L493">493</a> <strong class="jxr_keyword">if</strong> ( isXml() ) +<a class="jxr_linenumber" name="L494" href="#L494">494</a> { +<a class="jxr_linenumber" name="L495" href="#L495">495</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L496" href="#L496">496</a> } +<a class="jxr_linenumber" name="L497" href="#L497">497</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L498" href="#L498">498</a> { +<a class="jxr_linenumber" name="L499" href="#L499">499</a> filesToProcess = getFilesToProcess(); +<a class="jxr_linenumber" name="L500" href="#L500">500</a> <strong class="jxr_keyword">if</strong> ( filesToProcess.isEmpty() ) +<a class="jxr_linenumber" name="L501" href="#L501">501</a> { +<a class="jxr_linenumber" name="L502" href="#L502">502</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L503" href="#L503">503</a> } +<a class="jxr_linenumber" name="L504" href="#L504">504</a> } +<a class="jxr_linenumber" name="L505" href="#L505">505</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) +<a class="jxr_linenumber" name="L506" href="#L506">506</a> { +<a class="jxr_linenumber" name="L507" href="#L507">507</a> getLog().error( e ); +<a class="jxr_linenumber" name="L508" href="#L508">508</a> } +<a class="jxr_linenumber" name="L509" href="#L509">509</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L510" href="#L510">510</a> } +<a class="jxr_linenumber" name="L511" href="#L511">511</a> +<a class="jxr_linenumber" name="L512" href="#L512">512</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L513" href="#L513">513</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L514" href="#L514">514</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L515" href="#L515">515</a> @Override +<a class="jxr_linenumber" name="L516" href="#L516">516</a> <strong class="jxr_keyword">protected</strong> String getOutputDirectory() +<a class="jxr_linenumber" name="L517" href="#L517">517</a> { +<a class="jxr_linenumber" name="L518" href="#L518">518</a> <strong class="jxr_keyword">return</strong> outputDirectory.getAbsolutePath(); +<a class="jxr_linenumber" name="L519" href="#L519">519</a> } +<a class="jxr_linenumber" name="L520" href="#L520">520</a> +<a class="jxr_linenumber" name="L521" href="#L521">521</a> <strong class="jxr_keyword">protected</strong> String getSourceEncoding() +<a class="jxr_linenumber" name="L522" href="#L522">522</a> { +<a class="jxr_linenumber" name="L523" href="#L523">523</a> <strong class="jxr_keyword">return</strong> sourceEncoding; +<a class="jxr_linenumber" name="L524" href="#L524">524</a> } +<a class="jxr_linenumber" name="L525" href="#L525">525</a> +<a class="jxr_linenumber" name="L526" href="#L526">526</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L527" href="#L527">527</a> <em class="jxr_javadoccomment"> * Gets the effective reporting output files encoding.</em> +<a class="jxr_linenumber" name="L528" href="#L528">528</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L529" href="#L529">529</a> <em class="jxr_javadoccomment"> * @return The effective reporting output file encoding, never <code>null</code>.</em> +<a class="jxr_linenumber" name="L530" href="#L530">530</a> <em class="jxr_javadoccomment"> * @since 2.5</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> <strong class="jxr_keyword">protected</strong> String getOutputEncoding() +<a class="jxr_linenumber" name="L533" href="#L533">533</a> { +<a class="jxr_linenumber" name="L534" href="#L534">534</a> <strong class="jxr_keyword">return</strong> ( outputEncoding != <strong class="jxr_keyword">null</strong> ) ? outputEncoding : ReaderFactory.UTF_8; +<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> <strong class="jxr_keyword">static</strong> String getPmdVersion() +<a class="jxr_linenumber" name="L538" href="#L538">538</a> { +<a class="jxr_linenumber" name="L539" href="#L539">539</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L540" href="#L540">540</a> { +<a class="jxr_linenumber" name="L541" href="#L541">541</a> <strong class="jxr_keyword">return</strong> (String) PMD.<strong class="jxr_keyword">class</strong>.getField( <span class="jxr_string">"VERSION"</span> ).get( <strong class="jxr_keyword">null</strong> ); +<a class="jxr_linenumber" name="L542" href="#L542">542</a> } +<a class="jxr_linenumber" name="L543" href="#L543">543</a> <strong class="jxr_keyword">catch</strong> ( IllegalAccessException e ) +<a class="jxr_linenumber" name="L544" href="#L544">544</a> {
[... 16 lines stripped ...]