Modified: maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html (original) +++ maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html Wed Jul 10 19:21:17 2024 @@ -128,7 +128,7 @@ <a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">protected</strong> MavenProject project; <a class="jxr_linenumber" name="L121" href="#L121">121</a> <a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> executeCheck( -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">final</strong> String filename, <strong class="jxr_keyword">final</strong> String tagName, <strong class="jxr_keyword">final</strong> String key, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> failurePriority) +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">final</strong> String filename, <strong class="jxr_keyword">final</strong> String analyzerName, <strong class="jxr_keyword">final</strong> String failureName, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> failurePriority) <a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">throws</strong> MojoFailureException, MojoExecutionException { <a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">if</strong> (aggregate && !project.isExecutionRoot()) { <a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">return</strong>; @@ -142,165 +142,176 @@ <a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">final</strong> File outputFile = <strong class="jxr_keyword">new</strong> File(targetDirectory, filename); <a class="jxr_linenumber" name="L135" href="#L135">135</a> <a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">if</strong> (outputFile.exists()) { -<a class="jxr_linenumber" name="L137" href="#L137">137</a> getLog().info(<span class="jxr_string">"PMD version: "</span> + AbstractPmdReport.getPmdVersion()); -<a class="jxr_linenumber" name="L138" href="#L138">138</a> -<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">final</strong> ViolationDetails<D> violations = getViolations(outputFile, failurePriority); -<a class="jxr_linenumber" name="L141" href="#L141">141</a> -<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">final</strong> List<D> failures = violations.getFailureDetails(); -<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">final</strong> List<D> warnings = violations.getWarningDetails(); -<a class="jxr_linenumber" name="L144" href="#L144">144</a> -<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">if</strong> (verbose) { -<a class="jxr_linenumber" name="L146" href="#L146">146</a> printErrors(failures, warnings); -<a class="jxr_linenumber" name="L147" href="#L147">147</a> } -<a class="jxr_linenumber" name="L148" href="#L148">148</a> -<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> failureCount = failures.size(); -<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> warningCount = warnings.size(); +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">final</strong> ViolationDetails<D> violations = getViolations(outputFile, failurePriority); +<a class="jxr_linenumber" name="L139" href="#L139">139</a> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">final</strong> List<D> failures = violations.getFailureDetails(); +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">final</strong> List<D> warnings = violations.getWarningDetails(); +<a class="jxr_linenumber" name="L142" href="#L142">142</a> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">if</strong> (verbose) { +<a class="jxr_linenumber" name="L144" href="#L144">144</a> printErrors(failures, warnings); +<a class="jxr_linenumber" name="L145" href="#L145">145</a> } +<a class="jxr_linenumber" name="L146" href="#L146">146</a> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> failureCount = failures.size(); +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> warningCount = warnings.size(); +<a class="jxr_linenumber" name="L149" href="#L149">149</a> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">final</strong> String message = getMessage(failureCount, warningCount, analyzerName, failureName, outputFile); <a class="jxr_linenumber" name="L151" href="#L151">151</a> -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">final</strong> String message = getMessage(failureCount, warningCount, key, outputFile); -<a class="jxr_linenumber" name="L153" href="#L153">153</a> -<a class="jxr_linenumber" name="L154" href="#L154">154</a> getLog().debug(<span class="jxr_string">"PMD failureCount: "</span> + failureCount + <span class="jxr_string">", warningCount: "</span> + warningCount); +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">if</strong> (failureCount > getMaxAllowedViolations() && isFailOnViolation()) { +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException(message); +<a class="jxr_linenumber" name="L154" href="#L154">154</a> } <a class="jxr_linenumber" name="L155" href="#L155">155</a> -<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">if</strong> (failureCount > getMaxAllowedViolations() && isFailOnViolation()) { -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException(message); +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">if</strong> (!message.isEmpty()) { +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">this</strong>.getLog().warn(message); <a class="jxr_linenumber" name="L158" href="#L158">158</a> } <a class="jxr_linenumber" name="L159" href="#L159">159</a> -<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">this</strong>.getLog().info(message); -<a class="jxr_linenumber" name="L161" href="#L161">161</a> -<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">if</strong> (failureCount > 0 && isFailOnViolation() && failureCount <= getMaxAllowedViolations()) { -<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">this</strong>.getLog() -<a class="jxr_linenumber" name="L164" href="#L164">164</a> .info(<span class="jxr_string">"The build is not failed, since "</span> + getMaxAllowedViolations() -<a class="jxr_linenumber" name="L165" href="#L165">165</a> + <span class="jxr_string">" violations are allowed (maxAllowedViolations)."</span>); -<a class="jxr_linenumber" name="L166" href="#L166">166</a> } -<a class="jxr_linenumber" name="L167" href="#L167">167</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException | XmlPullParserException e) { -<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Unable to read PMD results xml: "</span> + outputFile.getAbsolutePath(), e); -<a class="jxr_linenumber" name="L169" href="#L169">169</a> } -<a class="jxr_linenumber" name="L170" href="#L170">170</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException(<span class="jxr_string">"Unable to perform check, "</span> + <span class="jxr_string">"unable to find "</span> + outputFile); -<a class="jxr_linenumber" name="L172" href="#L172">172</a> } -<a class="jxr_linenumber" name="L173" href="#L173">173</a> } -<a class="jxr_linenumber" name="L174" href="#L174">174</a> -<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * Method for collecting the violations found by the PMD tool</em> -<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * @param analysisFile</em> -<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * @param failurePriority</em> -<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * @return an int that specifies the number of violations found</em> -<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * @throws XmlPullParserException</em> -<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * @throws IOException</em> -<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">private</strong> ViolationDetails<D> getViolations(<strong class="jxr_keyword">final</strong> File analysisFile, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> failurePriority) -<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">throws</strong> XmlPullParserException, IOException { -<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">final</strong> List<D> failures = <strong class="jxr_keyword">new</strong> ArrayList<>(); -<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">final</strong> List<D> warnings = <strong class="jxr_keyword">new</strong> ArrayList<>(); -<a class="jxr_linenumber" name="L188" href="#L188">188</a> -<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">final</strong> List<D> violations = getErrorDetails(analysisFile); -<a class="jxr_linenumber" name="L190" href="#L190">190</a> -<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> D violation : violations) { -<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> priority = getPriority(violation); -<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">if</strong> (priority <= failurePriority && !excludeFromFile.isExcludedFromFailure(violation)) { -<a class="jxr_linenumber" name="L194" href="#L194">194</a> failures.add(violation); -<a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">if</strong> (printFailingErrors) { -<a class="jxr_linenumber" name="L196" href="#L196">196</a> printError(violation, <span class="jxr_string">"Failure"</span>); -<a class="jxr_linenumber" name="L197" href="#L197">197</a> } -<a class="jxr_linenumber" name="L198" href="#L198">198</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L199" href="#L199">199</a> warnings.add(violation); -<a class="jxr_linenumber" name="L200" href="#L200">200</a> } -<a class="jxr_linenumber" name="L201" href="#L201">201</a> } -<a class="jxr_linenumber" name="L202" href="#L202">202</a> -<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">final</strong> ViolationDetails<D> details = newViolationDetailsInstance(); -<a class="jxr_linenumber" name="L204" href="#L204">204</a> details.setFailureDetails(failures); -<a class="jxr_linenumber" name="L205" href="#L205">205</a> details.setWarningDetails(warnings); -<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">return</strong> details; -<a class="jxr_linenumber" name="L207" href="#L207">207</a> } -<a class="jxr_linenumber" name="L208" href="#L208">208</a> -<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong> getPriority(D errorDetail); -<a class="jxr_linenumber" name="L210" href="#L210">210</a> -<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> ViolationDetails<D> newViolationDetailsInstance(); -<a class="jxr_linenumber" name="L212" href="#L212">212</a> -<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * Prints the warnings and failures</em> -<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * @param failures list of failures</em> -<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * @param warnings list of warnings</em> -<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> printErrors(<strong class="jxr_keyword">final</strong> List<D> failures, <strong class="jxr_keyword">final</strong> List<D> warnings) { -<a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> D warning : warnings) { -<a class="jxr_linenumber" name="L221" href="#L221">221</a> printError(warning, <span class="jxr_string">"Warning"</span>); -<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">for</strong> (<strong class="jxr_keyword">final</strong> D failure : failures) { -<a class="jxr_linenumber" name="L225" href="#L225">225</a> printError(failure, <span class="jxr_string">"Failure"</span>); -<a class="jxr_linenumber" name="L226" href="#L226">226</a> } -<a class="jxr_linenumber" name="L227" href="#L227">227</a> } -<a class="jxr_linenumber" name="L228" href="#L228">228</a> -<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> * Gets the output message</em> -<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> * @param failureCount</em> -<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> * @param warningCount</em> -<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> * @param key</em> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">if</strong> (failureCount > 0 && isFailOnViolation() && failureCount <= getMaxAllowedViolations()) { +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">this</strong>.getLog() +<a class="jxr_linenumber" name="L162" href="#L162">162</a> .info(<span class="jxr_string">"The build has not failed because "</span> + getMaxAllowedViolations() +<a class="jxr_linenumber" name="L163" href="#L163">163</a> + <span class="jxr_string">" violations are allowed (maxAllowedViolations)."</span>); +<a class="jxr_linenumber" name="L164" href="#L164">164</a> } +<a class="jxr_linenumber" name="L165" href="#L165">165</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException | XmlPullParserException e) { +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <span class="jxr_string">"Unable to read "</span> + analyzerName + <span class="jxr_string">" results XML: "</span> + outputFile.getAbsolutePath(), e); +<a class="jxr_linenumber" name="L168" href="#L168">168</a> } +<a class="jxr_linenumber" name="L169" href="#L169">169</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException(<span class="jxr_string">"Unable to perform check, "</span> + <span class="jxr_string">"unable to find "</span> + outputFile); +<a class="jxr_linenumber" name="L171" href="#L171">171</a> } +<a class="jxr_linenumber" name="L172" href="#L172">172</a> } +<a class="jxr_linenumber" name="L173" href="#L173">173</a> +<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"> * Method for collecting the violations found by the PMD tool</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> <em class="jxr_javadoccomment"> * @param analysisFile</em> +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * @param failurePriority</em> +<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * @return an int that specifies the number of violations found</em> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * @throws XmlPullParserException</em> +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * @throws IOException</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> <strong class="jxr_keyword">private</strong> ViolationDetails<D> getViolations(<strong class="jxr_keyword">final</strong> File analysisFile, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> failurePriority) +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">throws</strong> XmlPullParserException, IOException { +<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">final</strong> List<D> failures = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">final</strong> List<D> warnings = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L187" href="#L187">187</a> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">final</strong> List<D> violations = getErrorDetails(analysisFile); +<a class="jxr_linenumber" name="L189" href="#L189">189</a> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> D violation : violations) { +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> priority = getPriority(violation); +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">if</strong> (priority <= failurePriority && !excludeFromFile.isExcludedFromFailure(violation)) { +<a class="jxr_linenumber" name="L193" href="#L193">193</a> failures.add(violation); +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">if</strong> (printFailingErrors) { +<a class="jxr_linenumber" name="L195" href="#L195">195</a> printError(violation, <span class="jxr_string">"Failure"</span>); +<a class="jxr_linenumber" name="L196" href="#L196">196</a> } +<a class="jxr_linenumber" name="L197" href="#L197">197</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L198" href="#L198">198</a> warnings.add(violation); +<a class="jxr_linenumber" name="L199" href="#L199">199</a> } +<a class="jxr_linenumber" name="L200" href="#L200">200</a> } +<a class="jxr_linenumber" name="L201" href="#L201">201</a> +<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">final</strong> ViolationDetails<D> details = newViolationDetailsInstance(); +<a class="jxr_linenumber" name="L203" href="#L203">203</a> details.setFailureDetails(failures); +<a class="jxr_linenumber" name="L204" href="#L204">204</a> details.setWarningDetails(warnings); +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">return</strong> details; +<a class="jxr_linenumber" name="L206" href="#L206">206</a> } +<a class="jxr_linenumber" name="L207" href="#L207">207</a> +<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">int</strong> getPriority(D errorDetail); +<a class="jxr_linenumber" name="L209" href="#L209">209</a> +<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> ViolationDetails<D> newViolationDetailsInstance(); +<a class="jxr_linenumber" name="L211" href="#L211">211</a> +<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"> * Prints the warnings and failures</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> <em class="jxr_javadoccomment"> * @param failures list of failures</em> +<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * @param warnings list of warnings</em> +<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> printErrors(<strong class="jxr_keyword">final</strong> List<D> failures, <strong class="jxr_keyword">final</strong> List<D> warnings) { +<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> D warning : warnings) { +<a class="jxr_linenumber" name="L220" href="#L220">220</a> printError(warning, <span class="jxr_string">"Warning"</span>); +<a class="jxr_linenumber" name="L221" href="#L221">221</a> } +<a class="jxr_linenumber" name="L222" href="#L222">222</a> +<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> D failure : failures) { +<a class="jxr_linenumber" name="L224" href="#L224">224</a> printError(failure, <span class="jxr_string">"Failure"</span>); +<a class="jxr_linenumber" name="L225" href="#L225">225</a> } +<a class="jxr_linenumber" name="L226" href="#L226">226</a> } +<a class="jxr_linenumber" name="L227" href="#L227">227</a> +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> * Gets the output message</em> +<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> * @param failureCount</em> +<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> * @param warningCount</em> +<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> * @param analyzerName</em> +<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> * @param failureName</em> <a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> * @param outputFile</em> <a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> * @return</em> <a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">private</strong> String getMessage(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> failureCount, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> warningCount, <strong class="jxr_keyword">final</strong> String key, <strong class="jxr_keyword">final</strong> File outputFile) { -<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">final</strong> StringBuilder message = <strong class="jxr_keyword">new</strong> StringBuilder(256); -<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">if</strong> (failureCount > 0 || warningCount > 0) { -<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">if</strong> (failureCount > 0) { -<a class="jxr_linenumber" name="L242" href="#L242">242</a> message.append(<span class="jxr_string">"You have "</span>) -<a class="jxr_linenumber" name="L243" href="#L243">243</a> .append(failureCount) -<a class="jxr_linenumber" name="L244" href="#L244">244</a> .append(<span class="jxr_string">" "</span>) -<a class="jxr_linenumber" name="L245" href="#L245">245</a> .append(key) -<a class="jxr_linenumber" name="L246" href="#L246">246</a> .append(failureCount > 1 ? <span class="jxr_string">"s"</span> : <span class="jxr_string">""</span>); -<a class="jxr_linenumber" name="L247" href="#L247">247</a> } -<a class="jxr_linenumber" name="L248" href="#L248">248</a> -<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">if</strong> (warningCount > 0) { -<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">if</strong> (failureCount > 0) { -<a class="jxr_linenumber" name="L251" href="#L251">251</a> message.append(<span class="jxr_string">" and "</span>); -<a class="jxr_linenumber" name="L252" href="#L252">252</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L253" href="#L253">253</a> message.append(<span class="jxr_string">"You have "</span>); -<a class="jxr_linenumber" name="L254" href="#L254">254</a> } -<a class="jxr_linenumber" name="L255" href="#L255">255</a> message.append(warningCount).append(<span class="jxr_string">" warning"</span>).append(warningCount > 1 ? <span class="jxr_string">"s"</span> : <span class="jxr_string">""</span>); -<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> message.append(<span class="jxr_string">". For more details see: "</span>).append(outputFile.getAbsolutePath()); -<a class="jxr_linenumber" name="L259" href="#L259">259</a> } -<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">return</strong> message.toString(); -<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> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> * Formats the failure details and prints them as an INFO message</em> -<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> * @param item either a {@link org.apache.maven.plugins.pmd.model.Violation} from PMD</em> -<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> * or a {@link org.apache.maven.plugins.pmd.model.Duplication} from CPD</em> -<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * @param severity the found issue is prefixed with the given severity, usually "Warning" or "Failure".</em> -<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L270" href="#L270">270</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> printError(D item, String severity); -<a class="jxr_linenumber" name="L271" href="#L271">271</a> -<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment"> * Gets the attributes and text for the violation tag and puts them in a HashMap</em> -<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment"> * @param analysisFile the xml output from PMD or CPD</em> -<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment"> * @return all PMD {@link org.apache.maven.plugins.pmd.model.Violation}s</em> -<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment"> * or CPD {@link org.apache.maven.plugins.pmd.model.Duplication}s.</em> -<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment"> * @throws XmlPullParserException if the analysis file contains invalid XML</em> -<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> * @throws IOException if the analysis file could be read</em> +<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">private</strong> String getMessage( +<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> failureCount, +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> warningCount, +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">final</strong> String analyzerName, +<a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">final</strong> String failureName, +<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">final</strong> File outputFile) { +<a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">final</strong> StringBuilder message = <strong class="jxr_keyword">new</strong> StringBuilder(256); +<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">if</strong> (failureCount > 0 || warningCount > 0) { +<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">if</strong> (failureCount > 0) { +<a class="jxr_linenumber" name="L247" href="#L247">247</a> message.append(analyzerName) +<a class="jxr_linenumber" name="L248" href="#L248">248</a> .append(<span class="jxr_string">" "</span>) +<a class="jxr_linenumber" name="L249" href="#L249">249</a> .append(AbstractPmdReport.getPmdVersion()) +<a class="jxr_linenumber" name="L250" href="#L250">250</a> .append(<span class="jxr_string">" has found "</span>) +<a class="jxr_linenumber" name="L251" href="#L251">251</a> .append(failureCount) +<a class="jxr_linenumber" name="L252" href="#L252">252</a> .append(<span class="jxr_string">" "</span>) +<a class="jxr_linenumber" name="L253" href="#L253">253</a> .append(failureName) +<a class="jxr_linenumber" name="L254" href="#L254">254</a> .append(failureCount > 1 ? <span class="jxr_string">"s"</span> : <span class="jxr_string">""</span>); +<a class="jxr_linenumber" name="L255" href="#L255">255</a> } +<a class="jxr_linenumber" name="L256" href="#L256">256</a> +<a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">if</strong> (warningCount > 0) { +<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">if</strong> (failureCount > 0) { +<a class="jxr_linenumber" name="L259" href="#L259">259</a> message.append(<span class="jxr_string">" and issued "</span>); +<a class="jxr_linenumber" name="L260" href="#L260">260</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L261" href="#L261">261</a> message.append(analyzerName) +<a class="jxr_linenumber" name="L262" href="#L262">262</a> .append(<span class="jxr_string">" "</span>) +<a class="jxr_linenumber" name="L263" href="#L263">263</a> .append(AbstractPmdReport.getPmdVersion()) +<a class="jxr_linenumber" name="L264" href="#L264">264</a> .append(<span class="jxr_string">" has issued "</span>); +<a class="jxr_linenumber" name="L265" href="#L265">265</a> } +<a class="jxr_linenumber" name="L266" href="#L266">266</a> message.append(warningCount).append(<span class="jxr_string">" warning"</span>).append(warningCount > 1 ? <span class="jxr_string">"s"</span> : <span class="jxr_string">""</span>); +<a class="jxr_linenumber" name="L267" href="#L267">267</a> } +<a class="jxr_linenumber" name="L268" href="#L268">268</a> +<a class="jxr_linenumber" name="L269" href="#L269">269</a> message.append(<span class="jxr_string">". For more details see: "</span>).append(outputFile.getAbsolutePath()); +<a class="jxr_linenumber" name="L270" href="#L270">270</a> } +<a class="jxr_linenumber" name="L271" href="#L271">271</a> <strong class="jxr_keyword">return</strong> message.toString(); +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment"> * Formats the failure details and prints them as an INFO message</em> +<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment"> * @param item either a {@link org.apache.maven.plugins.pmd.model.Violation} from PMD</em> +<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment"> * or a {@link org.apache.maven.plugins.pmd.model.Duplication} from CPD</em> +<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> * @param severity the found issue is prefixed with the given severity, usually "Warning" or "Failure".</em> <a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> List<D> getErrorDetails(File analysisFile) <strong class="jxr_keyword">throws</strong> XmlPullParserException, IOException; +<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> printError(D item, String severity); <a class="jxr_linenumber" name="L282" href="#L282">282</a> -<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isFailOnViolation() { -<a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong class="jxr_keyword">return</strong> failOnViolation; -<a class="jxr_linenumber" name="L285" href="#L285">285</a> } -<a class="jxr_linenumber" name="L286" href="#L286">286</a> -<a class="jxr_linenumber" name="L287" href="#L287">287</a> <strong class="jxr_keyword">public</strong> Integer getMaxAllowedViolations() { -<a class="jxr_linenumber" name="L288" href="#L288">288</a> <strong class="jxr_keyword">return</strong> maxAllowedViolations; -<a class="jxr_linenumber" name="L289" href="#L289">289</a> } -<a class="jxr_linenumber" name="L290" href="#L290">290</a> -<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isAggregator() { -<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_comment">// returning here aggregate for backwards compatibility</em> -<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">return</strong> aggregate; -<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="L283" href="#L283">283</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> * Gets the attributes and text for the violation tag and puts them in a HashMap</em> +<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> * @param analysisFile the xml output from PMD or CPD</em> +<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * @return all PMD {@link org.apache.maven.plugins.pmd.model.Violation}s</em> +<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> * or CPD {@link org.apache.maven.plugins.pmd.model.Duplication}s.</em> +<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> * @throws XmlPullParserException if the analysis file contains invalid XML</em> +<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> * @throws IOException if the analysis file could be read</em> +<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> List<D> getErrorDetails(File analysisFile) <strong class="jxr_keyword">throws</strong> XmlPullParserException, IOException; +<a class="jxr_linenumber" name="L293" href="#L293">293</a> +<a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isFailOnViolation() { +<a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">return</strong> failOnViolation; +<a class="jxr_linenumber" name="L296" href="#L296">296</a> } +<a class="jxr_linenumber" name="L297" href="#L297">297</a> +<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong class="jxr_keyword">public</strong> Integer getMaxAllowedViolations() { +<a class="jxr_linenumber" name="L299" href="#L299">299</a> <strong class="jxr_keyword">return</strong> maxAllowedViolations; +<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> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isAggregator() { +<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_comment">// returning here aggregate for backwards compatibility</em> +<a class="jxr_linenumber" name="L304" href="#L304">304</a> <strong class="jxr_keyword">return</strong> aggregate; +<a class="jxr_linenumber" name="L305" href="#L305">305</a> } +<a class="jxr_linenumber" name="L306" href="#L306">306</a> } </pre> <hr/> <div id="footer">Copyright © 2005–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
Modified: maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdReport.html ============================================================================== --- maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdReport.html (original) +++ maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdReport.html Wed Jul 10 19:21:17 2024 @@ -208,22 +208,21 @@ <a class="jxr_linenumber" name="L200" href="#L200">200</a> request.setJavaExecutable(javaExecutable); <a class="jxr_linenumber" name="L201" href="#L201">201</a> } <a class="jxr_linenumber" name="L202" href="#L202">202</a> -<a class="jxr_linenumber" name="L203" href="#L203">203</a> getLog().info(<span class="jxr_string">"PMD version: "</span> + AbstractPmdReport.getPmdVersion()); -<a class="jxr_linenumber" name="L204" href="#L204">204</a> cpdResult = CpdExecutor.execute(request); -<a class="jxr_linenumber" name="L205" href="#L205">205</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException e) { -<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(<span class="jxr_string">"Encoding '"</span> + getInputEncoding() + <span class="jxr_string">"' is not supported."</span>, e); -<a class="jxr_linenumber" name="L207" href="#L207">207</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { -<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(e.getMessage(), e); -<a class="jxr_linenumber" name="L209" href="#L209">209</a> } -<a class="jxr_linenumber" name="L210" href="#L210">210</a> } -<a class="jxr_linenumber" name="L211" href="#L211">211</a> -<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"> * {@inheritDoc}</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> <strong class="jxr_keyword">public</strong> String getOutputName() { -<a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"cpd"</span>; -<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="L203" href="#L203">203</a> cpdResult = CpdExecutor.execute(request); +<a class="jxr_linenumber" name="L204" href="#L204">204</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException e) { +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(<span class="jxr_string">"Encoding '"</span> + getInputEncoding() + <span class="jxr_string">"' is not supported."</span>, e); +<a class="jxr_linenumber" name="L206" href="#L206">206</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(e.getMessage(), e); +<a class="jxr_linenumber" name="L208" href="#L208">208</a> } +<a class="jxr_linenumber" name="L209" href="#L209">209</a> } +<a class="jxr_linenumber" name="L210" href="#L210">210</a> +<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">public</strong> String getOutputName() { +<a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"cpd"</span>; +<a class="jxr_linenumber" name="L216" href="#L216">216</a> } +<a class="jxr_linenumber" name="L217" href="#L217">217</a> } </pre> <hr/> <div id="footer">Copyright © 2005–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> Modified: maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdViolationCheckMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdViolationCheckMojo.html (original) +++ maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdViolationCheckMojo.html Wed Jul 10 19:21:17 2024 @@ -47,96 +47,95 @@ <a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment">/**</em> <a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * Fails the build if there were any CPD violations in the source code.</em> <a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * @version $Id$</em> -<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * @since 2.0</em> -<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L45" href="#L45">45</a> @Mojo(name = <span class="jxr_string">"cpd-check"</span>, defaultPhase = LifecyclePhase.VERIFY, threadSafe = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L46" href="#L46">46</a> @Execute(goal = <span class="jxr_string">"cpd"</span>) -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="CpdViolationCheckMojo" href="../../../../../org/apache/maven/plugins/pmd/CpdViolationCheckMojo.html#CpdViolationCheckMojo">CpdViolationCheckMojo</a> <strong class="jxr_keyword">extends</strong> AbstractPmdViolationCheckMojo<Duplication> { -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * Default constructor. Initializes with the correct {@link ExcludeDuplicationsFromFile}.</em> -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> <a name="CpdViolationCheckMojo" href="../../../../../org/apache/maven/plugins/pmd/CpdViolationCheckMojo.html#CpdViolationCheckMojo">CpdViolationCheckMojo</a>() { -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">super</strong>(<strong class="jxr_keyword">new</strong> <a name="ExcludeDuplicationsFromFile" href="../../../../../org/apache/maven/plugins/pmd/ExcludeDuplicationsFromFile.html#ExcludeDuplicationsFromFile">ExcludeDuplicationsFromFile</a>()); -<a class="jxr_linenumber" name="L53" href="#L53">53</a> } -<a class="jxr_linenumber" name="L54" href="#L54">54</a> -<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * Skip the CPD violation checks. Most useful on the command line via "-Dcpd.skip=true".</em> -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L58" href="#L58">58</a> @Parameter(property = <span class="jxr_string">"cpd.skip"</span>, defaultValue = <span class="jxr_string">"false"</span>) -<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip; -<a class="jxr_linenumber" name="L60" href="#L60">60</a> -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * Whether to fail the build if the validation check fails.</em> -<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * @since 3.0</em> -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L66" href="#L66">66</a> @Parameter(property = <span class="jxr_string">"cpd.failOnViolation"</span>, defaultValue = <span class="jxr_string">"true"</span>, required = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> failOnViolation; -<a class="jxr_linenumber" name="L68" href="#L68">68</a> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> -<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException { -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">if</strong> (skip) { -<a class="jxr_linenumber" name="L74" href="#L74">74</a> getLog().info(<span class="jxr_string">"Skipping CPD execution"</span>); -<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L76" href="#L76">76</a> } -<a class="jxr_linenumber" name="L77" href="#L77">77</a> -<a class="jxr_linenumber" name="L78" href="#L78">78</a> executeCheck(<span class="jxr_string">"cpd.xml"</span>, <span class="jxr_string">"duplication"</span>, <span class="jxr_string">"CPD duplication"</span>, 10); -<a class="jxr_linenumber" name="L79" href="#L79">79</a> } -<a class="jxr_linenumber" name="L80" href="#L80">80</a> -<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L84" href="#L84">84</a> @Override -<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> printError(Duplication item, String severity) { -<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">int</strong> lines = item.getLines(); -<a class="jxr_linenumber" name="L87" href="#L87">87</a> -<a class="jxr_linenumber" name="L88" href="#L88">88</a> StringBuilder buff = <strong class="jxr_keyword">new</strong> StringBuilder(100); -<a class="jxr_linenumber" name="L89" href="#L89">89</a> buff.append(<span class="jxr_string">"CPD "</span>).append(severity).append(<span class="jxr_string">": Found "</span>); -<a class="jxr_linenumber" name="L90" href="#L90">90</a> buff.append(lines).append(<span class="jxr_string">" lines of duplicated code at locations:"</span>); -<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">this</strong>.getLog().info(buff.toString()); -<a class="jxr_linenumber" name="L92" href="#L92">92</a> -<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">for</strong> (CpdFile file : item.getFiles()) { -<a class="jxr_linenumber" name="L94" href="#L94">94</a> buff.setLength(0); -<a class="jxr_linenumber" name="L95" href="#L95">95</a> buff.append(<span class="jxr_string">" "</span>); -<a class="jxr_linenumber" name="L96" href="#L96">96</a> buff.append(file.getPath()); -<a class="jxr_linenumber" name="L97" href="#L97">97</a> buff.append(<span class="jxr_string">" line "</span>).append(file.getLine()); -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">this</strong>.getLog().info(buff.toString()); -<a class="jxr_linenumber" name="L99" href="#L99">99</a> } -<a class="jxr_linenumber" name="L100" href="#L100">100</a> -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">this</strong>.getLog().debug(<span class="jxr_string">"CPD "</span> + severity + <span class="jxr_string">": Code Fragment "</span>); -<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">this</strong>.getLog().debug(item.getCodefragment()); -<a class="jxr_linenumber" name="L103" href="#L103">103</a> } -<a class="jxr_linenumber" name="L104" href="#L104">104</a> -<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> -<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> @Override -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">protected</strong> List<Duplication> getErrorDetails(File cpdFile) <strong class="jxr_keyword">throws</strong> XmlPullParserException, IOException { -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">try</strong> (InputStream in = <strong class="jxr_keyword">new</strong> FileInputStream(cpdFile)) { -<a class="jxr_linenumber" name="L111" href="#L111">111</a> CpdXpp3Reader reader = <strong class="jxr_keyword">new</strong> CpdXpp3Reader(); -<a class="jxr_linenumber" name="L112" href="#L112">112</a> CpdErrorDetail details = reader.read(in, false); -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">return</strong> details.getDuplications(); -<a class="jxr_linenumber" name="L114" href="#L114">114</a> } -<a class="jxr_linenumber" name="L115" href="#L115">115</a> } -<a class="jxr_linenumber" name="L116" href="#L116">116</a> -<a class="jxr_linenumber" name="L117" href="#L117">117</a> @Override -<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">int</strong> getPriority(Duplication errorDetail) { -<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">return</strong> 0; -<a class="jxr_linenumber" name="L120" href="#L120">120</a> } -<a class="jxr_linenumber" name="L121" href="#L121">121</a> -<a class="jxr_linenumber" name="L122" href="#L122">122</a> @Override -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">protected</strong> ViolationDetails<Duplication> newViolationDetailsInstance() { -<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> ViolationDetails<>(); -<a class="jxr_linenumber" name="L125" href="#L125">125</a> } -<a class="jxr_linenumber" name="L126" href="#L126">126</a> -<a class="jxr_linenumber" name="L127" href="#L127">127</a> @Override -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isFailOnViolation() { -<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">return</strong> failOnViolation; -<a class="jxr_linenumber" name="L130" href="#L130">130</a> } -<a class="jxr_linenumber" name="L131" href="#L131">131</a> } +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * @since 2.0</em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> @Mojo(name = <span class="jxr_string">"cpd-check"</span>, defaultPhase = LifecyclePhase.VERIFY, threadSafe = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L45" href="#L45">45</a> @Execute(goal = <span class="jxr_string">"cpd"</span>) +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="CpdViolationCheckMojo" href="../../../../../org/apache/maven/plugins/pmd/CpdViolationCheckMojo.html#CpdViolationCheckMojo">CpdViolationCheckMojo</a> <strong class="jxr_keyword">extends</strong> AbstractPmdViolationCheckMojo<Duplication> { +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * Default constructor. Initializes with the correct {@link ExcludeDuplicationsFromFile}.</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">public</strong> <a name="CpdViolationCheckMojo" href="../../../../../org/apache/maven/plugins/pmd/CpdViolationCheckMojo.html#CpdViolationCheckMojo">CpdViolationCheckMojo</a>() { +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">super</strong>(<strong class="jxr_keyword">new</strong> <a name="ExcludeDuplicationsFromFile" href="../../../../../org/apache/maven/plugins/pmd/ExcludeDuplicationsFromFile.html#ExcludeDuplicationsFromFile">ExcludeDuplicationsFromFile</a>()); +<a class="jxr_linenumber" name="L52" href="#L52">52</a> } +<a class="jxr_linenumber" name="L53" href="#L53">53</a> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * Skip the CPD violation checks. Most useful on the command line via "-Dcpd.skip=true".</em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> @Parameter(property = <span class="jxr_string">"cpd.skip"</span>, defaultValue = <span class="jxr_string">"false"</span>) +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip; +<a class="jxr_linenumber" name="L59" href="#L59">59</a> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * Whether to fail the build if the validation check fails.</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * @since 3.0</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> @Parameter(property = <span class="jxr_string">"cpd.failOnViolation"</span>, defaultValue = <span class="jxr_string">"true"</span>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> failOnViolation; +<a class="jxr_linenumber" name="L67" href="#L67">67</a> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException { +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">if</strong> (skip) { +<a class="jxr_linenumber" name="L73" href="#L73">73</a> getLog().info(<span class="jxr_string">"Skipping CPD execution"</span>); +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L75" href="#L75">75</a> } +<a class="jxr_linenumber" name="L76" href="#L76">76</a> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> executeCheck(<span class="jxr_string">"cpd.xml"</span>, <span class="jxr_string">"CPD"</span>, <span class="jxr_string">"duplication"</span>, 10); +<a class="jxr_linenumber" name="L78" href="#L78">78</a> } +<a class="jxr_linenumber" name="L79" href="#L79">79</a> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> @Override +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> printError(Duplication item, String severity) { +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">int</strong> lines = item.getLines(); +<a class="jxr_linenumber" name="L86" href="#L86">86</a> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> StringBuilder buff = <strong class="jxr_keyword">new</strong> StringBuilder(100); +<a class="jxr_linenumber" name="L88" href="#L88">88</a> buff.append(<span class="jxr_string">"CPD "</span>).append(severity).append(<span class="jxr_string">": Found "</span>); +<a class="jxr_linenumber" name="L89" href="#L89">89</a> buff.append(lines).append(<span class="jxr_string">" lines of duplicated code at locations:"</span>); +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">this</strong>.getLog().warn(buff.toString()); +<a class="jxr_linenumber" name="L91" href="#L91">91</a> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">for</strong> (CpdFile file : item.getFiles()) { +<a class="jxr_linenumber" name="L93" href="#L93">93</a> buff.setLength(0); +<a class="jxr_linenumber" name="L94" href="#L94">94</a> buff.append(<span class="jxr_string">" "</span>); +<a class="jxr_linenumber" name="L95" href="#L95">95</a> buff.append(file.getPath()); +<a class="jxr_linenumber" name="L96" href="#L96">96</a> buff.append(<span class="jxr_string">" line "</span>).append(file.getLine()); +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">this</strong>.getLog().warn(buff.toString()); +<a class="jxr_linenumber" name="L98" href="#L98">98</a> } +<a class="jxr_linenumber" name="L99" href="#L99">99</a> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">this</strong>.getLog().debug(<span class="jxr_string">"CPD "</span> + severity + <span class="jxr_string">": Code Fragment "</span>); +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">this</strong>.getLog().debug(item.getCodefragment()); +<a class="jxr_linenumber" name="L102" href="#L102">102</a> } +<a class="jxr_linenumber" name="L103" href="#L103">103</a> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> @Override +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">protected</strong> List<Duplication> getErrorDetails(File cpdFile) <strong class="jxr_keyword">throws</strong> XmlPullParserException, IOException { +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">try</strong> (InputStream in = <strong class="jxr_keyword">new</strong> FileInputStream(cpdFile)) { +<a class="jxr_linenumber" name="L110" href="#L110">110</a> CpdXpp3Reader reader = <strong class="jxr_keyword">new</strong> CpdXpp3Reader(); +<a class="jxr_linenumber" name="L111" href="#L111">111</a> CpdErrorDetail details = reader.read(in, false); +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">return</strong> details.getDuplications(); +<a class="jxr_linenumber" name="L113" href="#L113">113</a> } +<a class="jxr_linenumber" name="L114" href="#L114">114</a> } +<a class="jxr_linenumber" name="L115" href="#L115">115</a> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> @Override +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">int</strong> getPriority(Duplication errorDetail) { +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">return</strong> 0; +<a class="jxr_linenumber" name="L119" href="#L119">119</a> } +<a class="jxr_linenumber" name="L120" href="#L120">120</a> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> @Override +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">protected</strong> ViolationDetails<Duplication> newViolationDetailsInstance() { +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> ViolationDetails<>(); +<a class="jxr_linenumber" name="L124" href="#L124">124</a> } +<a class="jxr_linenumber" name="L125" href="#L125">125</a> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> @Override +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isFailOnViolation() { +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">return</strong> failOnViolation; +<a class="jxr_linenumber" name="L129" href="#L129">129</a> } +<a class="jxr_linenumber" name="L130" href="#L130">130</a> } </pre> <hr/> <div id="footer">Copyright © 2005–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> Modified: maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/PmdReport.html ============================================================================== --- maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/PmdReport.html (original) +++ maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/PmdReport.html Wed Jul 10 19:21:17 2024 @@ -356,7 +356,7 @@ <a class="jxr_linenumber" name="L348" href="#L348">348</a> filesToProcess = getFilesToProcess(); <a class="jxr_linenumber" name="L349" href="#L349">349</a> <a class="jxr_linenumber" name="L350" href="#L350">350</a> <strong class="jxr_keyword">if</strong> (filesToProcess.isEmpty() && !<span class="jxr_string">"java"</span>.equals(language)) { -<a class="jxr_linenumber" name="L351" href="#L351">351</a> getLog().warn(<span class="jxr_string">"No files found to process. Did you add your additional source folders like javascript?"</span> +<a class="jxr_linenumber" name="L351" href="#L351">351</a> getLog().warn(<span class="jxr_string">"No files found to process. Did you forget to add additional source directories?"</span> <a class="jxr_linenumber" name="L352" href="#L352">352</a> + <span class="jxr_string">" (see also build-helper-maven-plugin)"</span>); <a class="jxr_linenumber" name="L353" href="#L353">353</a> } <a class="jxr_linenumber" name="L354" href="#L354">354</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { @@ -521,62 +521,50 @@ <a class="jxr_linenumber" name="L513" href="#L513">513</a> resolvedArtifact.getArtifact().getFile().toString()); <a class="jxr_linenumber" name="L514" href="#L514">514</a> } <a class="jxr_linenumber" name="L515" href="#L515">515</a> -<a class="jxr_linenumber" name="L516" href="#L516">516</a> List<String> projectClasspath = includeTests -<a class="jxr_linenumber" name="L517" href="#L517">517</a> ? localProject.getTestClasspathElements() -<a class="jxr_linenumber" name="L518" href="#L518">518</a> : localProject.getCompileClasspathElements(); -<a class="jxr_linenumber" name="L519" href="#L519">519</a> -<a class="jxr_linenumber" name="L520" href="#L520">520</a> <em class="jxr_comment">// Add the project's target folder first</em> -<a class="jxr_linenumber" name="L521" href="#L521">521</a> classpath.addAll(projectClasspath); -<a class="jxr_linenumber" name="L522" href="#L522">522</a> <strong class="jxr_keyword">if</strong> (!localProject.isExecutionRoot()) { -<a class="jxr_linenumber" name="L523" href="#L523">523</a> <strong class="jxr_keyword">for</strong> (String path : projectClasspath) { -<a class="jxr_linenumber" name="L524" href="#L524">524</a> File pathFile = <strong class="jxr_keyword">new</strong> File(path); -<a class="jxr_linenumber" name="L525" href="#L525">525</a> String[] children = pathFile.list(); -<a class="jxr_linenumber" name="L526" href="#L526">526</a> -<a class="jxr_linenumber" name="L527" href="#L527">527</a> <strong class="jxr_keyword">if</strong> (!pathFile.exists() || (children != <strong class="jxr_keyword">null</strong> && children.length == 0)) { -<a class="jxr_linenumber" name="L528" href="#L528">528</a> getLog().warn(<span class="jxr_string">"The project "</span> + localProject.getArtifactId() -<a class="jxr_linenumber" name="L529" href="#L529">529</a> + <span class="jxr_string">" does not seem to be compiled. PMD results might be inaccurate."</span>); -<a class="jxr_linenumber" name="L530" href="#L530">530</a> } -<a class="jxr_linenumber" name="L531" href="#L531">531</a> } -<a class="jxr_linenumber" name="L532" href="#L532">532</a> } -<a class="jxr_linenumber" name="L533" href="#L533">533</a> } -<a class="jxr_linenumber" name="L534" href="#L534">534</a> -<a class="jxr_linenumber" name="L535" href="#L535">535</a> <em class="jxr_comment">// Add the dependencies as last entries</em> -<a class="jxr_linenumber" name="L536" href="#L536">536</a> classpath.addAll(dependencies); -<a class="jxr_linenumber" name="L537" href="#L537">537</a> -<a class="jxr_linenumber" name="L538" href="#L538">538</a> getLog().debug(<span class="jxr_string">"Using aggregated aux classpath: "</span> + classpath); -<a class="jxr_linenumber" name="L539" href="#L539">539</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L540" href="#L540">540</a> classpath.addAll( -<a class="jxr_linenumber" name="L541" href="#L541">541</a> includeTests ? project.getTestClasspathElements() : project.getCompileClasspathElements()); -<a class="jxr_linenumber" name="L542" href="#L542">542</a> -<a class="jxr_linenumber" name="L543" href="#L543">543</a> getLog().debug(<span class="jxr_string">"Using aux classpath: "</span> + classpath); -<a class="jxr_linenumber" name="L544" href="#L544">544</a> } -<a class="jxr_linenumber" name="L545" href="#L545">545</a> String path = StringUtils.join(classpath.iterator(), File.pathSeparator); -<a class="jxr_linenumber" name="L546" href="#L546">546</a> <strong class="jxr_keyword">return</strong> path; -<a class="jxr_linenumber" name="L547" href="#L547">547</a> } <strong class="jxr_keyword">catch</strong> (Exception e) { -<a class="jxr_linenumber" name="L548" href="#L548">548</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(e.getMessage(), e); -<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> -<a class="jxr_linenumber" name="L552" href="#L552">552</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L553" href="#L553">553</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L516" href="#L516">516</a> <em class="jxr_comment">// Add the project's classes first</em> +<a class="jxr_linenumber" name="L517" href="#L517">517</a> classpath.addAll( +<a class="jxr_linenumber" name="L518" href="#L518">518</a> includeTests +<a class="jxr_linenumber" name="L519" href="#L519">519</a> ? localProject.getTestClasspathElements() +<a class="jxr_linenumber" name="L520" href="#L520">520</a> : localProject.getCompileClasspathElements()); +<a class="jxr_linenumber" name="L521" href="#L521">521</a> } +<a class="jxr_linenumber" name="L522" href="#L522">522</a> +<a class="jxr_linenumber" name="L523" href="#L523">523</a> <em class="jxr_comment">// Add the dependencies as last entries</em> +<a class="jxr_linenumber" name="L524" href="#L524">524</a> classpath.addAll(dependencies); +<a class="jxr_linenumber" name="L525" href="#L525">525</a> +<a class="jxr_linenumber" name="L526" href="#L526">526</a> getLog().debug(<span class="jxr_string">"Using aggregated aux classpath: "</span> + classpath); +<a class="jxr_linenumber" name="L527" href="#L527">527</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L528" href="#L528">528</a> classpath.addAll( +<a class="jxr_linenumber" name="L529" href="#L529">529</a> includeTests ? project.getTestClasspathElements() : project.getCompileClasspathElements()); +<a class="jxr_linenumber" name="L530" href="#L530">530</a> +<a class="jxr_linenumber" name="L531" href="#L531">531</a> getLog().debug(<span class="jxr_string">"Using aux classpath: "</span> + classpath); +<a class="jxr_linenumber" name="L532" href="#L532">532</a> } +<a class="jxr_linenumber" name="L533" href="#L533">533</a> String path = StringUtils.join(classpath.iterator(), File.pathSeparator); +<a class="jxr_linenumber" name="L534" href="#L534">534</a> <strong class="jxr_keyword">return</strong> path; +<a class="jxr_linenumber" name="L535" href="#L535">535</a> } <strong class="jxr_keyword">catch</strong> (Exception e) { +<a class="jxr_linenumber" name="L536" href="#L536">536</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(e.getMessage(), e); +<a class="jxr_linenumber" name="L537" href="#L537">537</a> } +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L541" href="#L541">541</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L542" href="#L542">542</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L543" href="#L543">543</a> @Override +<a class="jxr_linenumber" name="L544" href="#L544">544</a> <strong class="jxr_keyword">public</strong> String getOutputName() { +<a class="jxr_linenumber" name="L545" href="#L545">545</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"pmd"</span>; +<a class="jxr_linenumber" name="L546" href="#L546">546</a> } +<a class="jxr_linenumber" name="L547" href="#L547">547</a> +<a class="jxr_linenumber" name="L548" href="#L548">548</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L549" href="#L549">549</a> <em class="jxr_javadoccomment"> * Create and return the correct renderer for the output type.</em> +<a class="jxr_linenumber" name="L550" href="#L550">550</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L551" href="#L551">551</a> <em class="jxr_javadoccomment"> * @return the renderer based on the configured output</em> +<a class="jxr_linenumber" name="L552" href="#L552">552</a> <em class="jxr_javadoccomment"> * @throws org.apache.maven.reporting.MavenReportException if no renderer found for the output type</em> +<a class="jxr_linenumber" name="L553" href="#L553">553</a> <em class="jxr_javadoccomment"> * @deprecated Use {@link PmdExecutor#createRenderer(String, String)} instead.</em> <a class="jxr_linenumber" name="L554" href="#L554">554</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L555" href="#L555">555</a> @Override -<a class="jxr_linenumber" name="L556" href="#L556">556</a> <strong class="jxr_keyword">public</strong> String getOutputName() { -<a class="jxr_linenumber" name="L557" href="#L557">557</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"pmd"</span>; +<a class="jxr_linenumber" name="L555" href="#L555">555</a> @Deprecated +<a class="jxr_linenumber" name="L556" href="#L556">556</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> Renderer createRenderer() <strong class="jxr_keyword">throws</strong> MavenReportException { +<a class="jxr_linenumber" name="L557" href="#L557">557</a> <strong class="jxr_keyword">return</strong> PmdExecutor.createRenderer(format, getOutputEncoding()); <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> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L561" href="#L561">561</a> <em class="jxr_javadoccomment"> * Create and return the correct renderer for the output type.</em> -<a class="jxr_linenumber" name="L562" href="#L562">562</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L563" href="#L563">563</a> <em class="jxr_javadoccomment"> * @return the renderer based on the configured output</em> -<a class="jxr_linenumber" name="L564" href="#L564">564</a> <em class="jxr_javadoccomment"> * @throws org.apache.maven.reporting.MavenReportException if no renderer found for the output type</em> -<a class="jxr_linenumber" name="L565" href="#L565">565</a> <em class="jxr_javadoccomment"> * @deprecated Use {@link PmdExecutor#createRenderer(String, String)} instead.</em> -<a class="jxr_linenumber" name="L566" href="#L566">566</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L567" href="#L567">567</a> @Deprecated -<a class="jxr_linenumber" name="L568" href="#L568">568</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> Renderer createRenderer() <strong class="jxr_keyword">throws</strong> MavenReportException { -<a class="jxr_linenumber" name="L569" href="#L569">569</a> <strong class="jxr_keyword">return</strong> PmdExecutor.createRenderer(format, getOutputEncoding()); -<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="L559" href="#L559">559</a> } </pre> <hr/> <div id="footer">Copyright © 2005–2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>