Added: websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html (added) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html Sun Jan 21 17:23:18 2018 @@ -0,0 +1,311 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> +<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> +<title>AbstractPmdViolationCheckMojo xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html">View Javadoc</a></div><pre> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.pmd; +<a class="jxr_linenumber" name="L2" href="#L2">2</a> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2."; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> +<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> * under the License.</em> +<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.File; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.pull.XmlPullParserException; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * Base class for mojos that check if there were any PMD violations.</em> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * @param <D> type of the check, e.g. {@link org.apache.maven.plugins.pmd.model.Violation}</em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * or {@link org.apache.maven.plugins.pmd.model.Duplication}.</em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:br...@apache.org"; target="alexandria_uri">mailto:br...@apache.org</a>">Brett Porter</a></em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * @version $Id$</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> AbstractPmdViolationCheckMojo<D> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">extends</strong> AbstractMojo +<a class="jxr_linenumber" name="L44" href="#L44">44</a> { +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * The location of the XML report to check, as generated by the PMD report.</em> +<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> @Parameter( property = <span class="jxr_string">"project.build.directory"</span>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">private</strong> File targetDirectory; +<a class="jxr_linenumber" name="L50" href="#L50">50</a> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * Whether to fail the build if the validation check fails.</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> @Parameter( property = <span class="jxr_string">"pmd.failOnViolation"</span>, defaultValue = <span class="jxr_string">"true"</span>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> failOnViolation; +<a class="jxr_linenumber" name="L56" href="#L56">56</a> +<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> <em class="jxr_javadoccomment"> * Whether to build an aggregated report at the root, or build individual reports.</em> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * @since 2.2</em> +<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> @Parameter( property = <span class="jxr_string">"aggregate"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> aggregate; +<a class="jxr_linenumber" name="L64" href="#L64">64</a> +<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> <em class="jxr_javadoccomment"> * Print details of check failures to build output.</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> @Parameter( property = <span class="jxr_string">"pmd.verbose"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> verbose; +<a class="jxr_linenumber" name="L70" href="#L70">70</a> +<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> <em class="jxr_javadoccomment"> * Print details of errors that cause build failure</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * @since 3.0</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> @Parameter( property = <span class="jxr_string">"pmd.printFailingErrors"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> printFailingErrors; +<a class="jxr_linenumber" name="L78" href="#L78">78</a> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * File that lists classes and rules to be excluded from failures.</em> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * For PMD, this is a properties file. For CPD, this</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * is a text file that contains comma-separated lists of classes</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * that are allowed to duplicate.</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * @since 3.0</em> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> @Parameter( property = <span class="jxr_string">"pmd.excludeFromFailureFile"</span>, defaultValue = <span class="jxr_string">""</span> ) +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">private</strong> String excludeFromFailureFile; +<a class="jxr_linenumber" name="L89" href="#L89">89</a> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment">/** Helper to exclude violations from the result. */</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> ExcludeFromFile<D> excludeFromFile; +<a class="jxr_linenumber" name="L92" href="#L92">92</a> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * Initialize this abstact check mojo by giving the correct ExcludeFromFile helper.</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * @param excludeFromFile the needed helper, for the specific violation type</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html">AbstractPmdViolationCheckMojo</a>( ExcludeFromFile<D> excludeFromFile ) +<a class="jxr_linenumber" name="L98" href="#L98">98</a> { +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">this</strong>.excludeFromFile = excludeFromFile; +<a class="jxr_linenumber" name="L100" href="#L100">100</a> } +<a class="jxr_linenumber" name="L101" href="#L101">101</a> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * The project to analyze.</em> +<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> @Parameter( defaultValue = <span class="jxr_string">"${project}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">protected</strong> MavenProject project; +<a class="jxr_linenumber" name="L107" href="#L107">107</a> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> executeCheck( <strong class="jxr_keyword">final</strong> String filename, <strong class="jxr_keyword">final</strong> String tagName, <strong class="jxr_keyword">final</strong> String key, +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> failurePriority ) +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">throws</strong> MojoFailureException, MojoExecutionException +<a class="jxr_linenumber" name="L111" href="#L111">111</a> { +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">if</strong> ( aggregate && !project.isExecutionRoot() ) +<a class="jxr_linenumber" name="L113" href="#L113">113</a> { +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">return</strong>; +<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> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"pom"</span>.equals( project.getPackaging() ) && !aggregate ) +<a class="jxr_linenumber" name="L118" href="#L118">118</a> { +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">return</strong>; +<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> excludeFromFile.loadExcludeFromFailuresData( excludeFromFailureFile ); +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">final</strong> File outputFile = <strong class="jxr_keyword">new</strong> File( targetDirectory, filename ); +<a class="jxr_linenumber" name="L124" href="#L124">124</a> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">if</strong> ( outputFile.exists() ) +<a class="jxr_linenumber" name="L126" href="#L126">126</a> { +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> { +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">final</strong> ViolationDetails<D> violations = getViolations( outputFile, failurePriority ); +<a class="jxr_linenumber" name="L130" href="#L130">130</a> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">final</strong> List<D> failures = violations.getFailureDetails(); +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">final</strong> List<D> warnings = violations.getWarningDetails(); +<a class="jxr_linenumber" name="L133" href="#L133">133</a> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">if</strong> ( verbose ) +<a class="jxr_linenumber" name="L135" href="#L135">135</a> { +<a class="jxr_linenumber" name="L136" href="#L136">136</a> printErrors( failures, warnings ); +<a class="jxr_linenumber" name="L137" href="#L137">137</a> } +<a class="jxr_linenumber" name="L138" href="#L138">138</a> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> failureCount = failures.size(); +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> warningCount = warnings.size(); +<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> String message = getMessage( failureCount, warningCount, key, outputFile ); +<a class="jxr_linenumber" name="L143" href="#L143">143</a> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> getLog().debug( <span class="jxr_string">"PMD failureCount: "</span> + failureCount + <span class="jxr_string">", warningCount: "</span> + warningCount ); +<a class="jxr_linenumber" name="L145" href="#L145">145</a> +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">if</strong> ( failureCount > 0 && isFailOnViolation() ) +<a class="jxr_linenumber" name="L147" href="#L147">147</a> { +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException( message ); +<a class="jxr_linenumber" name="L149" href="#L149">149</a> } +<a class="jxr_linenumber" name="L150" href="#L150">150</a> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">this</strong>.getLog().info( message ); +<a class="jxr_linenumber" name="L152" href="#L152">152</a> } +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">catch</strong> ( <strong class="jxr_keyword">final</strong> IOException e ) +<a class="jxr_linenumber" name="L154" href="#L154">154</a> { +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <span class="jxr_string">"Unable to read PMD results xml: "</span> + outputFile.getAbsolutePath(), +<a class="jxr_linenumber" name="L157" href="#L157">157</a> e ); +<a class="jxr_linenumber" name="L158" href="#L158">158</a> } +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">catch</strong> ( <strong class="jxr_keyword">final</strong> XmlPullParserException e ) +<a class="jxr_linenumber" name="L160" href="#L160">160</a> { +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <span class="jxr_string">"Unable to read PMD results xml: "</span> + outputFile.getAbsolutePath(), +<a class="jxr_linenumber" name="L163" href="#L163">163</a> e ); +<a class="jxr_linenumber" name="L164" href="#L164">164</a> } +<a class="jxr_linenumber" name="L165" href="#L165">165</a> } +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="L167" href="#L167">167</a> { +<a class="jxr_linenumber" name="L168" href="#L168">168</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="L169" href="#L169">169</a> } +<a class="jxr_linenumber" name="L170" href="#L170">170</a> } +<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"> * Method for collecting the violations found by the PMD tool</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"> * @param analysisFile</em> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * @param failurePriority</em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * @return an int that specifies the number of violations found</em> +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * @throws XmlPullParserException</em> +<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * @throws IOException</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> <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="L182" href="#L182">182</a> <strong class="jxr_keyword">throws</strong> XmlPullParserException, IOException +<a class="jxr_linenumber" name="L183" href="#L183">183</a> { +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">final</strong> List<D> failures = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">final</strong> List<D> warnings = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L186" href="#L186">186</a> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">final</strong> List<D> violations = getErrorDetails( analysisFile ); +<a class="jxr_linenumber" name="L188" href="#L188">188</a> +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">final</strong> D violation : violations ) +<a class="jxr_linenumber" name="L190" href="#L190">190</a> { +<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> { +<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> { +<a class="jxr_linenumber" name="L197" href="#L197">197</a> printError( violation, <span class="jxr_string">"Failure"</span> ); +<a class="jxr_linenumber" name="L198" href="#L198">198</a> } +<a class="jxr_linenumber" name="L199" href="#L199">199</a> } +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="L201" href="#L201">201</a> { +<a class="jxr_linenumber" name="L202" href="#L202">202</a> warnings.add( violation ); +<a class="jxr_linenumber" name="L203" href="#L203">203</a> } +<a class="jxr_linenumber" name="L204" href="#L204">204</a> } +<a class="jxr_linenumber" name="L205" href="#L205">205</a> +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">final</strong> ViolationDetails<D> details = newViolationDetailsInstance(); +<a class="jxr_linenumber" name="L207" href="#L207">207</a> details.setFailureDetails( failures ); +<a class="jxr_linenumber" name="L208" href="#L208">208</a> details.setWarningDetails( warnings ); +<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">return</strong> details; +<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> <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="L213" href="#L213">213</a> +<a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> ViolationDetails<D> newViolationDetailsInstance(); +<a class="jxr_linenumber" name="L215" href="#L215">215</a> +<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * Prints the warnings and failures</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> <em class="jxr_javadoccomment"> * @param failures list of failures</em> +<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * @param warnings list of warnings</em> +<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L222" href="#L222">222</a> <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="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 warning : warnings ) +<a class="jxr_linenumber" name="L225" href="#L225">225</a> { +<a class="jxr_linenumber" name="L226" href="#L226">226</a> printError( warning, <span class="jxr_string">"Warning"</span> ); +<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> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">final</strong> D failure : failures ) +<a class="jxr_linenumber" name="L230" href="#L230">230</a> { +<a class="jxr_linenumber" name="L231" href="#L231">231</a> printError( failure, <span class="jxr_string">"Failure"</span> ); +<a class="jxr_linenumber" name="L232" href="#L232">232</a> } +<a class="jxr_linenumber" name="L233" href="#L233">233</a> } +<a class="jxr_linenumber" name="L234" href="#L234">234</a> +<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> * Gets the output message</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> <em class="jxr_javadoccomment"> * @param failureCount</em> +<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> * @param warningCount</em> +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> * @param key</em> +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> * @param outputFile</em> +<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> * @return</em> +<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L244" href="#L244">244</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="L245" href="#L245">245</a> { +<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">final</strong> StringBuilder message = <strong class="jxr_keyword">new</strong> StringBuilder( 256 ); +<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">if</strong> ( failureCount > 0 || warningCount > 0 ) +<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> ( failureCount > 0 ) +<a class="jxr_linenumber" name="L250" href="#L250">250</a> { +<a class="jxr_linenumber" name="L251" href="#L251">251</a> message.append( <span class="jxr_string">"You have "</span> ).append( failureCount ).append( <span class="jxr_string">" "</span> ).append( key ). +<a class="jxr_linenumber" name="L252" href="#L252">252</a> append( failureCount > 1 ? <span class="jxr_string">"s"</span> : <span class="jxr_string">""</span> ); +<a class="jxr_linenumber" name="L253" href="#L253">253</a> } +<a class="jxr_linenumber" name="L254" href="#L254">254</a> +<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">if</strong> ( warningCount > 0 ) +<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> ( failureCount > 0 ) +<a class="jxr_linenumber" name="L258" href="#L258">258</a> { +<a class="jxr_linenumber" name="L259" href="#L259">259</a> message.append( <span class="jxr_string">" and "</span> ); +<a class="jxr_linenumber" name="L260" href="#L260">260</a> } +<a class="jxr_linenumber" name="L261" href="#L261">261</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="L262" href="#L262">262</a> { +<a class="jxr_linenumber" name="L263" href="#L263">263</a> message.append( <span class="jxr_string">"You have "</span> ); +<a class="jxr_linenumber" name="L264" href="#L264">264</a> } +<a class="jxr_linenumber" name="L265" href="#L265">265</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="L266" href="#L266">266</a> } +<a class="jxr_linenumber" name="L267" href="#L267">267</a> +<a class="jxr_linenumber" name="L268" href="#L268">268</a> message.append( <span class="jxr_string">". For more details see: "</span> ).append( outputFile.getAbsolutePath() ); +<a class="jxr_linenumber" name="L269" href="#L269">269</a> } +<a class="jxr_linenumber" name="L270" href="#L270">270</a> <strong class="jxr_keyword">return</strong> message.toString(); +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> * Formats the failure details and prints them as an INFO message</em> +<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment"> * @param item either a {@link org.apache.maven.plugins.pmd.model.Violation} from PMD</em> +<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment"> * or a {@link org.apache.maven.plugins.pmd.model.Duplication} from CPD</em> +<a class="jxr_linenumber" name="L278" href="#L278">278</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="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L280" href="#L280">280</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="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"> * Gets the attributes and text for the violation tag and puts them in a HashMap</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"> * @param analysisFile the xml output from PMD or CPD</em> +<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> * @return all PMD {@link org.apache.maven.plugins.pmd.model.Violation}s</em> +<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * or CPD {@link org.apache.maven.plugins.pmd.model.Duplication}s.</em> +<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> * @throws XmlPullParserException if the analysis file contains invalid XML</em> +<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> * @throws IOException if the analysis file could be read</em> +<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> List<D> getErrorDetails( File analysisFile ) +<a class="jxr_linenumber" name="L292" href="#L292">292</a> <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> { +<a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong class="jxr_keyword">return</strong> failOnViolation; +<a class="jxr_linenumber" name="L297" href="#L297">297</a> } +<a class="jxr_linenumber" name="L298" href="#L298">298</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2005–2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html> \ No newline at end of file
