Modified: maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/PmdViolationCheckMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/PmdViolationCheckMojo.html (original) +++ maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/PmdViolationCheckMojo.html Fri May 12 20:25:56 2023 @@ -6,187 +6,164 @@ </head> <body> <div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/pmd/PmdViolationCheckMojo.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="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></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.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></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.FileReader; -<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> +<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.pmd; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.File; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream; +<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.io.InputStream; <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.List; <a class="jxr_linenumber" name="L27" href="#L27">27</a> <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.pmd.model.PmdErrorDetail; -<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.model.PmdFile; -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.model.Violation; -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.model.io.xpp3.PmdXpp3Reader; -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Execute; -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.LifecyclePhase; -<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; -<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; -<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.pull.XmlPullParserException; -<a class="jxr_linenumber" name="L40" href="#L40">40</a> -<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"> * Fails the build if there were any PMD violations in the source code.</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> <em class="jxr_javadoccomment"> * @version $Id$</em> -<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * @since 2.0</em> -<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L47" href="#L47">47</a> @Mojo( name = <span class="jxr_string">"check"</span>, defaultPhase = LifecyclePhase.VERIFY, threadSafe = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L48" href="#L48">48</a> @Execute( goal = <span class="jxr_string">"pmd"</span> ) -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="PmdViolationCheckMojo" href="../../../../../org/apache/maven/plugins/pmd/PmdViolationCheckMojo.html#PmdViolationCheckMojo">PmdViolationCheckMojo</a> -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">extends</strong> AbstractPmdViolationCheckMojo<Violation> -<a class="jxr_linenumber" name="L51" href="#L51">51</a> { -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * Default constructor. Initializes with the correct {@link ExcludeViolationsFromFile}.</em> -<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> <strong class="jxr_keyword">public</strong> <a name="PmdViolationCheckMojo" href="../../../../../org/apache/maven/plugins/pmd/PmdViolationCheckMojo.html#PmdViolationCheckMojo">PmdViolationCheckMojo</a>() -<a class="jxr_linenumber" name="L56" href="#L56">56</a> { -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">super</strong>( <strong class="jxr_keyword">new</strong> <a name="ExcludeViolationsFromFile" href="../../../../../org/apache/maven/plugins/pmd/ExcludeViolationsFromFile.html#ExcludeViolationsFromFile">ExcludeViolationsFromFile</a>() ); -<a class="jxr_linenumber" name="L58" href="#L58">58</a> } -<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"> * What priority level to fail the build on.</em> -<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * PMD violations are assigned a priority from 1 (most severe) to 5 (least severe) according the</em> -<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * the rule's priority.</em> -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * Violations at or less than this priority level are considered failures and will fail</em> -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * the build if {@code failOnViolation=true} and the count exceeds {@code maxAllowedViolations}.</em> -<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * The other violations will be regarded as warnings and will be displayed in the build output</em> -<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * if {@code verbose=true}.</em> -<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * Setting a value of 5 will treat all violations as failures, which may cause the build to fail.</em> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * Setting a value of 1 will treat all violations as warnings.</em> -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * Only values from 1 to 5 are valid.</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> @Parameter( property = <span class="jxr_string">"pmd.failurePriority"</span>, defaultValue = <span class="jxr_string">"5"</span>, required = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> failurePriority = 5; -<a class="jxr_linenumber" name="L74" href="#L74">74</a> -<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> <em class="jxr_javadoccomment"> * Skip the PMD checks. Most useful on the command line via "-Dpmd.skip=true".</em> -<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L78" href="#L78">78</a> @Parameter( property = <span class="jxr_string">"pmd.skip"</span>, defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip; -<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() -<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException -<a class="jxr_linenumber" name="L86" href="#L86">86</a> { -<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">if</strong> ( skip ) -<a class="jxr_linenumber" name="L88" href="#L88">88</a> { -<a class="jxr_linenumber" name="L89" href="#L89">89</a> getLog().info( <span class="jxr_string">"Skipping PMD execution"</span> ); -<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L91" href="#L91">91</a> } -<a class="jxr_linenumber" name="L92" href="#L92">92</a> -<a class="jxr_linenumber" name="L93" href="#L93">93</a> executeCheck( <span class="jxr_string">"pmd.xml"</span>, <span class="jxr_string">"violation"</span>, <span class="jxr_string">"PMD violation"</span>, failurePriority ); -<a class="jxr_linenumber" name="L94" href="#L94">94</a> } -<a class="jxr_linenumber" name="L95" href="#L95">95</a> -<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> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> printError( Violation item, String severity ) -<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> StringBuilder buff = <strong class="jxr_keyword">new</strong> StringBuilder( 100 ); -<a class="jxr_linenumber" name="L103" href="#L103">103</a> buff.append( <span class="jxr_string">"PMD "</span> ).append( severity ).append( <span class="jxr_string">": "</span> ); -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">if</strong> ( item.getViolationClass() != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L105" href="#L105">105</a> { -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">if</strong> ( item.getViolationPackage() != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L107" href="#L107">107</a> { -<a class="jxr_linenumber" name="L108" href="#L108">108</a> buff.append( item.getViolationPackage() ); -<a class="jxr_linenumber" name="L109" href="#L109">109</a> buff.append( <span class="jxr_string">"."</span> ); -<a class="jxr_linenumber" name="L110" href="#L110">110</a> } -<a class="jxr_linenumber" name="L111" href="#L111">111</a> buff.append( item.getViolationClass() ); -<a class="jxr_linenumber" name="L112" href="#L112">112</a> } -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">else</strong> -<a class="jxr_linenumber" name="L114" href="#L114">114</a> { -<a class="jxr_linenumber" name="L115" href="#L115">115</a> buff.append( item.getFileName() ); -<a class="jxr_linenumber" name="L116" href="#L116">116</a> } -<a class="jxr_linenumber" name="L117" href="#L117">117</a> buff.append( <span class="jxr_string">":"</span> ); -<a class="jxr_linenumber" name="L118" href="#L118">118</a> buff.append( item.getBeginline() ); -<a class="jxr_linenumber" name="L119" href="#L119">119</a> buff.append( <span class="jxr_string">" Rule:"</span> ).append( item.getRule() ); -<a class="jxr_linenumber" name="L120" href="#L120">120</a> buff.append( <span class="jxr_string">" Priority:"</span> ).append( item.getPriority() ); -<a class="jxr_linenumber" name="L121" href="#L121">121</a> buff.append( <span class="jxr_string">" "</span> ).append( item.getText() ).append( <span class="jxr_string">"."</span> ); +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Execute; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.LifecyclePhase; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.model.PmdErrorDetail; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.model.PmdFile; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.model.Violation; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.model.io.xpp3.PmdXpp3Reader; +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.pull.XmlPullParserException; +<a class="jxr_linenumber" name="L39" href="#L39">39</a> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * Fails the build if there were any PMD violations in the source code.</em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * @version $Id$</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * @since 2.0</em> +<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> @Mojo(name = <span class="jxr_string">"check"</span>, defaultPhase = LifecyclePhase.VERIFY, threadSafe = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L47" href="#L47">47</a> @Execute(goal = <span class="jxr_string">"pmd"</span>) +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="PmdViolationCheckMojo" href="../../../../../org/apache/maven/plugins/pmd/PmdViolationCheckMojo.html#PmdViolationCheckMojo">PmdViolationCheckMojo</a> <strong class="jxr_keyword">extends</strong> AbstractPmdViolationCheckMojo<Violation> { +<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> <em class="jxr_javadoccomment"> * Default constructor. Initializes with the correct {@link ExcludeViolationsFromFile}.</em> +<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> <strong class="jxr_keyword">public</strong> <a name="PmdViolationCheckMojo" href="../../../../../org/apache/maven/plugins/pmd/PmdViolationCheckMojo.html#PmdViolationCheckMojo">PmdViolationCheckMojo</a>() { +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">super</strong>(<strong class="jxr_keyword">new</strong> <a name="ExcludeViolationsFromFile" href="../../../../../org/apache/maven/plugins/pmd/ExcludeViolationsFromFile.html#ExcludeViolationsFromFile">ExcludeViolationsFromFile</a>()); +<a class="jxr_linenumber" name="L54" href="#L54">54</a> } +<a class="jxr_linenumber" name="L55" href="#L55">55</a> +<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> <em class="jxr_javadoccomment"> * What priority level to fail the build on.</em> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * PMD violations are assigned a priority from 1 (most severe) to 5 (least severe) according the</em> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * the rule's priority.</em> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * Violations at or less than this priority level are considered failures and will fail</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * the build if {@code failOnViolation=true} and the count exceeds {@code maxAllowedViolations}.</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * The other violations will be regarded as warnings and will be displayed in the build output</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * if {@code verbose=true}.</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * Setting a value of 5 will treat all violations as failures, which may cause the build to fail.</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * Setting a value of 1 will treat all violations as warnings.</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * Only values from 1 to 5 are valid.</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.failurePriority"</span>, defaultValue = <span class="jxr_string">"5"</span>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> failurePriority = 5; +<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"> * Skip the PMD checks. Most useful on the command line via "-Dpmd.skip=true".</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> @Parameter(property = <span class="jxr_string">"pmd.skip"</span>, defaultValue = <span class="jxr_string">"false"</span>) +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip; +<a class="jxr_linenumber" name="L76" href="#L76">76</a> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<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> <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="L81" href="#L81">81</a> <strong class="jxr_keyword">if</strong> (skip) { +<a class="jxr_linenumber" name="L82" href="#L82">82</a> getLog().info(<span class="jxr_string">"Skipping PMD execution"</span>); +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L84" href="#L84">84</a> } +<a class="jxr_linenumber" name="L85" href="#L85">85</a> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> executeCheck(<span class="jxr_string">"pmd.xml"</span>, <span class="jxr_string">"violation"</span>, <span class="jxr_string">"PMD violation"</span>, failurePriority); +<a class="jxr_linenumber" name="L87" href="#L87">87</a> } +<a class="jxr_linenumber" name="L88" href="#L88">88</a> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> printError(Violation item, String severity) { +<a class="jxr_linenumber" name="L93" href="#L93">93</a> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> StringBuilder buff = <strong class="jxr_keyword">new</strong> StringBuilder(100); +<a class="jxr_linenumber" name="L95" href="#L95">95</a> buff.append(<span class="jxr_string">"PMD "</span>).append(severity).append(<span class="jxr_string">": "</span>); +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">if</strong> (item.getViolationClass() != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">if</strong> (item.getViolationPackage() != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L98" href="#L98">98</a> buff.append(item.getViolationPackage()); +<a class="jxr_linenumber" name="L99" href="#L99">99</a> buff.append(<span class="jxr_string">"."</span>); +<a class="jxr_linenumber" name="L100" href="#L100">100</a> } +<a class="jxr_linenumber" name="L101" href="#L101">101</a> buff.append(item.getViolationClass()); +<a class="jxr_linenumber" name="L102" href="#L102">102</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L103" href="#L103">103</a> buff.append(item.getFileName()); +<a class="jxr_linenumber" name="L104" href="#L104">104</a> } +<a class="jxr_linenumber" name="L105" href="#L105">105</a> buff.append(<span class="jxr_string">":"</span>); +<a class="jxr_linenumber" name="L106" href="#L106">106</a> buff.append(item.getBeginline()); +<a class="jxr_linenumber" name="L107" href="#L107">107</a> buff.append(<span class="jxr_string">" Rule:"</span>).append(item.getRule()); +<a class="jxr_linenumber" name="L108" href="#L108">108</a> buff.append(<span class="jxr_string">" Priority:"</span>).append(item.getPriority()); +<a class="jxr_linenumber" name="L109" href="#L109">109</a> buff.append(<span class="jxr_string">" "</span>).append(item.getText()).append(<span class="jxr_string">"."</span>); +<a class="jxr_linenumber" name="L110" href="#L110">110</a> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">this</strong>.getLog().info(buff.toString()); +<a class="jxr_linenumber" name="L112" href="#L112">112</a> } +<a class="jxr_linenumber" name="L113" href="#L113">113</a> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> @Override +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">protected</strong> List<Violation> getErrorDetails(File pmdFile) <strong class="jxr_keyword">throws</strong> XmlPullParserException, IOException { +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">try</strong> (InputStream in = <strong class="jxr_keyword">new</strong> FileInputStream(pmdFile)) { +<a class="jxr_linenumber" name="L117" href="#L117">117</a> PmdXpp3Reader reader = <strong class="jxr_keyword">new</strong> PmdXpp3Reader(); +<a class="jxr_linenumber" name="L118" href="#L118">118</a> PmdErrorDetail details = reader.read(in, false); +<a class="jxr_linenumber" name="L119" href="#L119">119</a> List<Violation> violations = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">for</strong> (PmdFile file : details.getFiles()) { +<a class="jxr_linenumber" name="L121" href="#L121">121</a> String fullPath = file.getName(); <a class="jxr_linenumber" name="L122" href="#L122">122</a> -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">this</strong>.getLog().info( buff.toString() ); -<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">protected</strong> List<Violation> getErrorDetails( File pmdFile ) -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">throws</strong> XmlPullParserException, IOException -<a class="jxr_linenumber" name="L129" href="#L129">129</a> { -<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">try</strong> ( FileReader reader1 = <strong class="jxr_keyword">new</strong> FileReader( pmdFile ) ) -<a class="jxr_linenumber" name="L131" href="#L131">131</a> { -<a class="jxr_linenumber" name="L132" href="#L132">132</a> PmdXpp3Reader reader = <strong class="jxr_keyword">new</strong> PmdXpp3Reader(); -<a class="jxr_linenumber" name="L133" href="#L133">133</a> PmdErrorDetail details = reader.read( reader1, false ); -<a class="jxr_linenumber" name="L134" href="#L134">134</a> -<a class="jxr_linenumber" name="L135" href="#L135">135</a> List<Violation> violations = <strong class="jxr_keyword">new</strong> ArrayList<>(); -<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">for</strong> ( PmdFile file : details.getFiles() ) -<a class="jxr_linenumber" name="L137" href="#L137">137</a> { -<a class="jxr_linenumber" name="L138" href="#L138">138</a> String fullPath = file.getName(); -<a class="jxr_linenumber" name="L139" href="#L139">139</a> -<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">for</strong> ( Violation violation : file.getViolations() ) -<a class="jxr_linenumber" name="L141" href="#L141">141</a> { -<a class="jxr_linenumber" name="L142" href="#L142">142</a> violation.setFileName( getFilename( fullPath, violation.getViolationPackage() ) ); -<a class="jxr_linenumber" name="L143" href="#L143">143</a> violations.add( violation ); -<a class="jxr_linenumber" name="L144" href="#L144">144</a> } -<a class="jxr_linenumber" name="L145" href="#L145">145</a> } -<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">return</strong> violations; -<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="L123" href="#L123">123</a> <strong class="jxr_keyword">for</strong> (Violation violation : file.getViolations()) { +<a class="jxr_linenumber" name="L124" href="#L124">124</a> violation.setFileName(getFilename(fullPath, violation.getViolationPackage())); +<a class="jxr_linenumber" name="L125" href="#L125">125</a> violations.add(violation); +<a class="jxr_linenumber" name="L126" href="#L126">126</a> } +<a class="jxr_linenumber" name="L127" href="#L127">127</a> } +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">return</strong> violations; +<a class="jxr_linenumber" name="L129" href="#L129">129</a> } +<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="L132" href="#L132">132</a> @Override +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">int</strong> getPriority(Violation errorDetail) { +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">return</strong> errorDetail.getPriority(); +<a class="jxr_linenumber" name="L135" href="#L135">135</a> } +<a class="jxr_linenumber" name="L136" href="#L136">136</a> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> @Override +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">protected</strong> ViolationDetails<Violation> newViolationDetailsInstance() { +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> ViolationDetails<>(); +<a class="jxr_linenumber" name="L140" href="#L140">140</a> } +<a class="jxr_linenumber" name="L141" href="#L141">141</a> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">private</strong> String getFilename(String fullpath, String pkg) { +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">int</strong> index = fullpath.lastIndexOf(File.separatorChar); +<a class="jxr_linenumber" name="L144" href="#L144">144</a> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">while</strong> (pkg != <strong class="jxr_keyword">null</strong> && !pkg.isEmpty()) { +<a class="jxr_linenumber" name="L146" href="#L146">146</a> index = fullpath.substring(0, index).lastIndexOf(File.separatorChar); +<a class="jxr_linenumber" name="L147" href="#L147">147</a> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">int</strong> dot = pkg.indexOf('.'); <a class="jxr_linenumber" name="L149" href="#L149">149</a> -<a class="jxr_linenumber" name="L150" href="#L150">150</a> @Override -<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">int</strong> getPriority( Violation errorDetail ) -<a class="jxr_linenumber" name="L152" href="#L152">152</a> { -<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">return</strong> errorDetail.getPriority(); -<a class="jxr_linenumber" name="L154" href="#L154">154</a> } +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">if</strong> (dot < 0) { +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">break</strong>; +<a class="jxr_linenumber" name="L152" href="#L152">152</a> } +<a class="jxr_linenumber" name="L153" href="#L153">153</a> pkg = pkg.substring(dot + 1); +<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> @Override -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">protected</strong> ViolationDetails<Violation> newViolationDetailsInstance() -<a class="jxr_linenumber" name="L158" href="#L158">158</a> { -<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> ViolationDetails<>(); -<a class="jxr_linenumber" name="L160" href="#L160">160</a> } -<a class="jxr_linenumber" name="L161" href="#L161">161</a> -<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">private</strong> String getFilename( String fullpath, String pkg ) -<a class="jxr_linenumber" name="L163" href="#L163">163</a> { -<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">int</strong> index = fullpath.lastIndexOf( File.separatorChar ); -<a class="jxr_linenumber" name="L165" href="#L165">165</a> -<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">while</strong> ( StringUtils.isNotEmpty( pkg ) ) -<a class="jxr_linenumber" name="L167" href="#L167">167</a> { -<a class="jxr_linenumber" name="L168" href="#L168">168</a> index = fullpath.substring( 0, index ).lastIndexOf( File.separatorChar ); -<a class="jxr_linenumber" name="L169" href="#L169">169</a> -<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">int</strong> dot = pkg.indexOf( '.' ); -<a class="jxr_linenumber" name="L171" href="#L171">171</a> -<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">if</strong> ( dot < 0 ) -<a class="jxr_linenumber" name="L173" href="#L173">173</a> { -<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">break</strong>; -<a class="jxr_linenumber" name="L175" href="#L175">175</a> } -<a class="jxr_linenumber" name="L176" href="#L176">176</a> pkg = pkg.substring( dot + 1 ); -<a class="jxr_linenumber" name="L177" href="#L177">177</a> } -<a class="jxr_linenumber" name="L178" href="#L178">178</a> -<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">return</strong> fullpath.substring( index + 1 ); -<a class="jxr_linenumber" name="L180" href="#L180">180</a> } -<a class="jxr_linenumber" name="L181" href="#L181">181</a> } +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">return</strong> fullpath.substring(index + 1); +<a class="jxr_linenumber" name="L157" href="#L157">157</a> } +<a class="jxr_linenumber" name="L158" href="#L158">158</a> } </pre> <hr/> <div id="footer">Copyright © 2005–2023 <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/ViolationDetails.html ============================================================================== --- maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/ViolationDetails.html (original) +++ maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/ViolationDetails.html Fri May 12 20:25:56 2023 @@ -6,76 +6,70 @@ </head> <body> <div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/pmd/ViolationDetails.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="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></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.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></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.util.ArrayList; -<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.List; -<a class="jxr_linenumber" name="L24" href="#L24">24</a> -<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * Collector of warnings and failures.</em> -<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L28" href="#L28">28</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="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * or {@link org.apache.maven.plugins.pmd.model.Duplication}.</em> -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * @author Robert Scholte</em> -<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * @since 2.7</em> -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> ViolationDetails<D> -<a class="jxr_linenumber" name="L34" href="#L34">34</a> { -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">private</strong> List<D> warningDetails = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> +<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.pmd; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment"> * Collector of warnings and failures.</em> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L27" href="#L27">27</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="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * or {@link org.apache.maven.plugins.pmd.model.Duplication}.</em> +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * @author Robert Scholte</em> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * @since 2.7</em> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> ViolationDetails<D> { +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">private</strong> List<D> warningDetails = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L34" href="#L34">34</a> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">private</strong> List<D> failureDetails = <strong class="jxr_keyword">new</strong> ArrayList<>(); <a class="jxr_linenumber" name="L36" href="#L36">36</a> -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">private</strong> List<D> failureDetails = <strong class="jxr_keyword">new</strong> ArrayList<>(); -<a class="jxr_linenumber" name="L38" href="#L38">38</a> -<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"> * @return the warningDetails, never {@code null}</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> List<D> getWarningDetails() -<a class="jxr_linenumber" name="L43" href="#L43">43</a> { -<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">return</strong> warningDetails; -<a class="jxr_linenumber" name="L45" href="#L45">45</a> } -<a class="jxr_linenumber" name="L46" href="#L46">46</a> -<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"> * @param warningDetails the warningDetails to set</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> <strong class="jxr_keyword">void</strong> setWarningDetails( List<D> warningDetails ) -<a class="jxr_linenumber" name="L51" href="#L51">51</a> { -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">this</strong>.warningDetails = warningDetails; -<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"> * @return the failureDetails, never {@code null}</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> <strong class="jxr_keyword">public</strong> List<D> getFailureDetails() -<a class="jxr_linenumber" name="L59" href="#L59">59</a> { -<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">return</strong> failureDetails; -<a class="jxr_linenumber" name="L61" href="#L61">61</a> } -<a class="jxr_linenumber" name="L62" href="#L62">62</a> -<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"> * @param failureDetails the failureDetails to set</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFailureDetails( List<D> failureDetails ) -<a class="jxr_linenumber" name="L67" href="#L67">67</a> { -<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">this</strong>.failureDetails = failureDetails; -<a class="jxr_linenumber" name="L69" href="#L69">69</a> } -<a class="jxr_linenumber" name="L70" href="#L70">70</a> } +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * @return the warningDetails, never {@code null}</em> +<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> <strong class="jxr_keyword">public</strong> List<D> getWarningDetails() { +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">return</strong> warningDetails; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> } +<a class="jxr_linenumber" name="L43" href="#L43">43</a> +<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> <em class="jxr_javadoccomment"> * @param warningDetails the warningDetails to set</em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setWarningDetails(List<D> warningDetails) { +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">this</strong>.warningDetails = warningDetails; +<a class="jxr_linenumber" name="L49" href="#L49">49</a> } +<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"> * @return the failureDetails, never {@code null}</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> <strong class="jxr_keyword">public</strong> List<D> getFailureDetails() { +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">return</strong> failureDetails; +<a class="jxr_linenumber" name="L56" href="#L56">56</a> } +<a class="jxr_linenumber" name="L57" href="#L57">57</a> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * @param failureDetails the failureDetails to set</em> +<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFailureDetails(List<D> failureDetails) { +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">this</strong>.failureDetails = failureDetails; +<a class="jxr_linenumber" name="L63" href="#L63">63</a> } +<a class="jxr_linenumber" name="L64" href="#L64">64</a> } </pre> <hr/> <div id="footer">Copyright © 2005–2023 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div>
