Added: websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdViolationCheckMojo.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdViolationCheckMojo.html (added) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdViolationCheckMojo.html Sun Jan 21 17:23:18 2018 @@ -0,0 +1,155 @@ +<!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>CpdViolationCheckMojo xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/pmd/CpdViolationCheckMojo.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.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="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.MojoExecutionException; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.model.CpdErrorDetail; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.model.CpdFile; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.model.Duplication; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.model.io.xpp3.CpdXpp3Reader; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Execute; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.LifecyclePhase; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.pull.XmlPullParserException; +<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"> * Fail the build if there were any CPD violations in the source code.</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * @version $Id$</em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * @since 2.0</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> @Mojo( name = <span class="jxr_string">"cpd-check"</span>, defaultPhase = LifecyclePhase.VERIFY, threadSafe = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L46" href="#L46">46</a> @Execute( goal = <span class="jxr_string">"cpd"</span> ) +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/pmd/CpdViolationCheckMojo.html">CpdViolationCheckMojo</a> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">extends</strong> AbstractPmdViolationCheckMojo<Duplication> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> { +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * Default constructor. Initializes with the correct {@link ExcludeDuplicationsFromFile}.</em> +<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> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/maven/plugins/pmd/CpdViolationCheckMojo.html">CpdViolationCheckMojo</a>() +<a class="jxr_linenumber" name="L54" href="#L54">54</a> { +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">super</strong>( <strong class="jxr_keyword">new</strong> ExcludeDuplicationsFromFile() ); +<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"> * Skip the CPD violation checks. Most useful on the command line via "-Dcpd.skip=true".</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> @Parameter( property = <span class="jxr_string">"cpd.skip"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip; +<a class="jxr_linenumber" name="L63" href="#L63">63</a> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * Whether to fail the build if the validation check fails.</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * @since 3.0</em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> @Parameter( property = <span class="jxr_string">"cpd.failOnViolation"</span>, defaultValue = <span class="jxr_string">"true"</span>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> failOnViolation; +<a class="jxr_linenumber" name="L71" href="#L71">71</a> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException +<a class="jxr_linenumber" name="L77" href="#L77">77</a> { +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">if</strong> ( !skip ) +<a class="jxr_linenumber" name="L79" href="#L79">79</a> { +<a class="jxr_linenumber" name="L80" href="#L80">80</a> executeCheck( <span class="jxr_string">"cpd.xml"</span>, <span class="jxr_string">"duplication"</span>, <span class="jxr_string">"CPD duplication"</span>, 10 ); +<a class="jxr_linenumber" name="L81" href="#L81">81</a> } +<a class="jxr_linenumber" name="L82" href="#L82">82</a> } +<a class="jxr_linenumber" name="L83" href="#L83">83</a> +<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"> * {@inheritDoc}</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> @Override +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> printError( Duplication item, String severity ) +<a class="jxr_linenumber" name="L89" href="#L89">89</a> { +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">int</strong> lines = item.getLines(); +<a class="jxr_linenumber" name="L91" href="#L91">91</a> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> StringBuilder buff = <strong class="jxr_keyword">new</strong> StringBuilder( 100 ); +<a class="jxr_linenumber" name="L93" href="#L93">93</a> buff.append( <span class="jxr_string">"CPD "</span> ).append( severity ).append( <span class="jxr_string">": Found "</span> ); +<a class="jxr_linenumber" name="L94" href="#L94">94</a> buff.append( lines ).append( <span class="jxr_string">" lines of duplicated code at locations:"</span> ); +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">this</strong>.getLog().info( buff.toString() ); +<a class="jxr_linenumber" name="L96" href="#L96">96</a> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">for</strong> ( CpdFile file : item.getFiles() ) +<a class="jxr_linenumber" name="L98" href="#L98">98</a> { +<a class="jxr_linenumber" name="L99" href="#L99">99</a> buff.setLength( 0 ); +<a class="jxr_linenumber" name="L100" href="#L100">100</a> buff.append( <span class="jxr_string">" "</span> ); +<a class="jxr_linenumber" name="L101" href="#L101">101</a> buff.append( file.getPath() ); +<a class="jxr_linenumber" name="L102" href="#L102">102</a> buff.append( <span class="jxr_string">" line "</span> ).append( file.getLine() ); +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">this</strong>.getLog().info( buff.toString() ); +<a class="jxr_linenumber" name="L104" href="#L104">104</a> } +<a class="jxr_linenumber" name="L105" href="#L105">105</a> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">this</strong>.getLog().debug( <span class="jxr_string">"CPD "</span> + severity + <span class="jxr_string">": Code Fragment "</span> ); +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">this</strong>.getLog().debug( item.getCodefragment() ); +<a class="jxr_linenumber" name="L108" href="#L108">108</a> } +<a class="jxr_linenumber" name="L109" href="#L109">109</a> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> @Override +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">protected</strong> List<Duplication> getErrorDetails( File cpdFile ) +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">throws</strong> XmlPullParserException, IOException +<a class="jxr_linenumber" name="L116" href="#L116">116</a> { +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">try</strong> ( FileReader fileReader = <strong class="jxr_keyword">new</strong> FileReader( cpdFile ) ) +<a class="jxr_linenumber" name="L118" href="#L118">118</a> { +<a class="jxr_linenumber" name="L119" href="#L119">119</a> CpdXpp3Reader reader = <strong class="jxr_keyword">new</strong> CpdXpp3Reader(); +<a class="jxr_linenumber" name="L120" href="#L120">120</a> CpdErrorDetail details = reader.read( fileReader, false ); +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">return</strong> details.getDuplications(); +<a class="jxr_linenumber" name="L122" href="#L122">122</a> } +<a class="jxr_linenumber" name="L123" href="#L123">123</a> } +<a class="jxr_linenumber" name="L124" href="#L124">124</a> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> @Override +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">int</strong> getPriority( Duplication errorDetail ) +<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> 0; +<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> @Override +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">protected</strong> ViolationDetails<Duplication> newViolationDetailsInstance() +<a class="jxr_linenumber" name="L133" href="#L133">133</a> { +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> ViolationDetails<>(); +<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">public</strong> <strong class="jxr_keyword">boolean</strong> isFailOnViolation() +<a class="jxr_linenumber" name="L139" href="#L139">139</a> { +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">return</strong> failOnViolation; +<a class="jxr_linenumber" name="L141" href="#L141">141</a> } +<a class="jxr_linenumber" name="L142" href="#L142">142</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
Added: websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/ExcludeDuplicationsFromFile.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/ExcludeDuplicationsFromFile.html (added) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/ExcludeDuplicationsFromFile.html Sun Jan 21 17:23:18 2018 @@ -0,0 +1,170 @@ +<!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>ExcludeDuplicationsFromFile xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/pmd/ExcludeDuplicationsFromFile.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.FileReader; +<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.LineNumberReader; +<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.HashSet; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.Set; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang3.StringUtils; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.model.CpdFile; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.model.Duplication; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.cpd.Mark; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.cpd.Match; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * This class contains utility methods to load property files which define which files</em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * should be excluded from the CPD duplication results.</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * See property <code>pmd.excludeFromFailureFile</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"> * @author Andreas Dangel</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/pmd/ExcludeDuplicationsFromFile.html">ExcludeDuplicationsFromFile</a> <strong class="jxr_keyword">implements</strong> ExcludeFromFile<Duplication> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> { +<a class="jxr_linenumber" name="L47" href="#L47">47</a> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List<Set<String>> exclusionList = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L49" href="#L49">49</a> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> @Override +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isExcludedFromFailure( <strong class="jxr_keyword">final</strong> Duplication errorDetail ) +<a class="jxr_linenumber" name="L52" href="#L52">52</a> { +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">final</strong> Set<String> uniquePaths = <strong class="jxr_keyword">new</strong> HashSet<>(); +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">final</strong> CpdFile cpdFile : errorDetail.getFiles() ) +<a class="jxr_linenumber" name="L55" href="#L55">55</a> { +<a class="jxr_linenumber" name="L56" href="#L56">56</a> uniquePaths.add( cpdFile.getPath() ); +<a class="jxr_linenumber" name="L57" href="#L57">57</a> } +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">return</strong> isExcludedFromFailure( uniquePaths ); +<a class="jxr_linenumber" name="L59" href="#L59">59</a> } +<a class="jxr_linenumber" name="L60" href="#L60">60</a> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * Checks whether the given {@link Match} is excluded.</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * Note: The exclusion must have been loaded before via {@link #loadExcludeFromFailuresData(String)}.</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * </em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * @param errorDetail the duplication to check</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the given duplication should be excluded, <code>false</code> otherwise.</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isExcludedFromFailure( <strong class="jxr_keyword">final</strong> Match errorDetail ) +<a class="jxr_linenumber" name="L69" href="#L69">69</a> { +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">final</strong> Set<String> uniquePaths = <strong class="jxr_keyword">new</strong> HashSet<>(); +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">for</strong> ( Mark mark : errorDetail.getMarkSet() ) +<a class="jxr_linenumber" name="L72" href="#L72">72</a> { +<a class="jxr_linenumber" name="L73" href="#L73">73</a> uniquePaths.add( mark.getFilename() ); +<a class="jxr_linenumber" name="L74" href="#L74">74</a> } +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">return</strong> isExcludedFromFailure( uniquePaths ); +<a class="jxr_linenumber" name="L76" href="#L76">76</a> } +<a class="jxr_linenumber" name="L77" href="#L77">77</a> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isExcludedFromFailure( Set<String> uniquePaths ) +<a class="jxr_linenumber" name="L79" href="#L79">79</a> { +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">final</strong> Set<String> singleExclusionGroup : exclusionList ) +<a class="jxr_linenumber" name="L81" href="#L81">81</a> { +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">if</strong> ( uniquePaths.size() == singleExclusionGroup.size() +<a class="jxr_linenumber" name="L83" href="#L83">83</a> && duplicationExcludedByGroup( uniquePaths, singleExclusionGroup ) ) +<a class="jxr_linenumber" name="L84" href="#L84">84</a> { +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L86" href="#L86">86</a> } +<a class="jxr_linenumber" name="L87" href="#L87">87</a> } +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L89" href="#L89">89</a> } +<a class="jxr_linenumber" name="L90" href="#L90">90</a> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> duplicationExcludedByGroup( <strong class="jxr_keyword">final</strong> Set<String> uniquePaths, <strong class="jxr_keyword">final</strong> Set<String> singleExclusionGroup ) +<a class="jxr_linenumber" name="L92" href="#L92">92</a> { +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">final</strong> String path : uniquePaths ) +<a class="jxr_linenumber" name="L94" href="#L94">94</a> { +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">if</strong> ( !fileExcludedByGroup( path, singleExclusionGroup ) ) +<a class="jxr_linenumber" name="L96" href="#L96">96</a> { +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L98" href="#L98">98</a> } +<a class="jxr_linenumber" name="L99" href="#L99">99</a> } +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L101" href="#L101">101</a> } +<a class="jxr_linenumber" name="L102" href="#L102">102</a> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> fileExcludedByGroup( <strong class="jxr_keyword">final</strong> String path, <strong class="jxr_keyword">final</strong> Set<String> singleExclusionGroup ) +<a class="jxr_linenumber" name="L104" href="#L104">104</a> { +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">final</strong> String formattedPath = path.replace( '\\', '.' ).replace( '/', '.' ); +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">final</strong> String className : singleExclusionGroup ) +<a class="jxr_linenumber" name="L107" href="#L107">107</a> { +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">if</strong> ( formattedPath.contains( className ) ) +<a class="jxr_linenumber" name="L109" href="#L109">109</a> { +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L111" href="#L111">111</a> } +<a class="jxr_linenumber" name="L112" href="#L112">112</a> } +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L114" href="#L114">114</a> } +<a class="jxr_linenumber" name="L115" href="#L115">115</a> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> @Override +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> loadExcludeFromFailuresData( <strong class="jxr_keyword">final</strong> String excludeFromFailureFile ) +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException +<a class="jxr_linenumber" name="L119" href="#L119">119</a> { +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( excludeFromFailureFile ) ) +<a class="jxr_linenumber" name="L121" href="#L121">121</a> { +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L123" href="#L123">123</a> } +<a class="jxr_linenumber" name="L124" href="#L124">124</a> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">try</strong> ( LineNumberReader reader = <strong class="jxr_keyword">new</strong> LineNumberReader( <strong class="jxr_keyword">new</strong> FileReader( excludeFromFailureFile ) ) ) +<a class="jxr_linenumber" name="L126" href="#L126">126</a> { +<a class="jxr_linenumber" name="L127" href="#L127">127</a> String line; +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">while</strong> ( ( line = reader.readLine() ) != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L129" href="#L129">129</a> { +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">if</strong> ( !line.startsWith( <span class="jxr_string">"#"</span> ) ) +<a class="jxr_linenumber" name="L131" href="#L131">131</a> { +<a class="jxr_linenumber" name="L132" href="#L132">132</a> exclusionList.add( createSetFromExclusionLine( line ) ); +<a class="jxr_linenumber" name="L133" href="#L133">133</a> } +<a class="jxr_linenumber" name="L134" href="#L134">134</a> } +<a class="jxr_linenumber" name="L135" href="#L135">135</a> } +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">catch</strong> ( <strong class="jxr_keyword">final</strong> IOException e ) +<a class="jxr_linenumber" name="L137" href="#L137">137</a> { +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Cannot load file "</span> + excludeFromFailureFile, e ); +<a class="jxr_linenumber" name="L139" href="#L139">139</a> } +<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> Set<String> createSetFromExclusionLine( <strong class="jxr_keyword">final</strong> String line ) +<a class="jxr_linenumber" name="L143" href="#L143">143</a> { +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">final</strong> Set<String> result = <strong class="jxr_keyword">new</strong> HashSet<>(); +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">final</strong> String className : line.split( <span class="jxr_string">","</span> ) ) +<a class="jxr_linenumber" name="L146" href="#L146">146</a> { +<a class="jxr_linenumber" name="L147" href="#L147">147</a> result.add( className.trim() ); +<a class="jxr_linenumber" name="L148" href="#L148">148</a> } +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">return</strong> result; +<a class="jxr_linenumber" name="L150" href="#L150">150</a> } +<a class="jxr_linenumber" name="L151" href="#L151">151</a> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> @Override +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> countExclusions() +<a class="jxr_linenumber" name="L154" href="#L154">154</a> { +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">return</strong> exclusionList.size(); +<a class="jxr_linenumber" name="L156" href="#L156">156</a> } +<a class="jxr_linenumber" name="L157" href="#L157">157</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 Added: websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/ExcludeFromFile.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/ExcludeFromFile.html (added) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/ExcludeFromFile.html Sun Jan 21 17:23:18 2018 @@ -0,0 +1,67 @@ +<!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>ExcludeFromFile xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/pmd/ExcludeFromFile.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> org.apache.maven.plugin.MojoExecutionException; +<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"> * @param <D> type of violation to exclude, e.g. {@link org.apache.maven.plugins.pmd.model.Violation}</em> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * or {@link org.apache.maven.plugins.pmd.model.Duplication}.</em> +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * @author Andreas Dangel</em> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> ExcludeFromFile<D> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> { +<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> <em class="jxr_javadoccomment"> * Loads the exclude definitions from the given file.</em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * @param excludeFromFailureFile the path to the properties file</em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if the properties file couldn't be loaded</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> <strong class="jxr_keyword">void</strong> loadExcludeFromFailuresData( String excludeFromFailureFile ) <strong class="jxr_keyword">throws</strong> MojoExecutionException; +<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"> * Determines how many exclusions are considered.</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * @return the number of active exclusions</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> <strong class="jxr_keyword">int</strong> countExclusions(); +<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"> * Checks whether the given violation is excluded. Note: the exclusions must have been</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * loaded before via {@link #loadExcludeFromFailuresData(String)}.</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * @param errorDetail the violation to check</em> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the violation should be excluded, <code>false</code> otherwise.</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">boolean</strong> isExcludedFromFailure( D errorDetail ); +<a class="jxr_linenumber" name="L53" href="#L53">53</a> +<a class="jxr_linenumber" name="L54" href="#L54">54</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 Added: websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/ExcludeViolationsFromFile.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/ExcludeViolationsFromFile.html (added) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/ExcludeViolationsFromFile.html Sun Jan 21 17:23:18 2018 @@ -0,0 +1,160 @@ +<!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>ExcludeViolationsFromFile xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/pmd/ExcludeViolationsFromFile.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.FileInputStream; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.HashMap; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.HashSet; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.Map; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.Map.Entry; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.util.Properties; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.util.Set; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang3.StringUtils; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.model.Violation; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.RuleViolation; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * This class contains utility for loading property files, which define which PMD violations</em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * from which classes should be ignored and not cause a failure.</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * See property <code>pmd.excludeFromFailureFile</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"> * @author Andreas Dangel</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/pmd/ExcludeViolationsFromFile.html">ExcludeViolationsFromFile</a> <strong class="jxr_keyword">implements</strong> ExcludeFromFile<Violation> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> { +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">private</strong> Map<String, Set<String>> excludeFromFailureClasses = <strong class="jxr_keyword">new</strong> HashMap<>(); +<a class="jxr_linenumber" name="L48" href="#L48">48</a> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> @Override +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> loadExcludeFromFailuresData( <strong class="jxr_keyword">final</strong> String excludeFromFailureFile ) +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException +<a class="jxr_linenumber" name="L52" href="#L52">52</a> { +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( excludeFromFailureFile ) ) +<a class="jxr_linenumber" name="L54" href="#L54">54</a> { +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">return</strong>; +<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> File file = <strong class="jxr_keyword">new</strong> File( excludeFromFailureFile ); +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">if</strong> ( !file.exists() ) +<a class="jxr_linenumber" name="L60" href="#L60">60</a> { +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L62" href="#L62">62</a> } +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">final</strong> Properties props = <strong class="jxr_keyword">new</strong> Properties(); +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">try</strong> ( FileInputStream fileInputStream = <strong class="jxr_keyword">new</strong> FileInputStream( <strong class="jxr_keyword">new</strong> File( excludeFromFailureFile ) ) ) +<a class="jxr_linenumber" name="L65" href="#L65">65</a> { +<a class="jxr_linenumber" name="L66" href="#L66">66</a> props.load( fileInputStream ); +<a class="jxr_linenumber" name="L67" href="#L67">67</a> } +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">catch</strong> ( <strong class="jxr_keyword">final</strong> IOException e ) +<a class="jxr_linenumber" name="L69" href="#L69">69</a> { +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Cannot load properties file "</span> + excludeFromFailureFile, e ); +<a class="jxr_linenumber" name="L71" href="#L71">71</a> } +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">final</strong> Entry<Object, Object> propEntry : props.entrySet() ) +<a class="jxr_linenumber" name="L73" href="#L73">73</a> { +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">final</strong> Set<String> excludedRuleSet = <strong class="jxr_keyword">new</strong> HashSet<>(); +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">final</strong> String className = propEntry.getKey().toString(); +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">final</strong> String[] excludedRules = propEntry.getValue().toString().split( <span class="jxr_string">","</span> ); +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">final</strong> String excludedRule : excludedRules ) +<a class="jxr_linenumber" name="L78" href="#L78">78</a> { +<a class="jxr_linenumber" name="L79" href="#L79">79</a> excludedRuleSet.add( excludedRule.trim() ); +<a class="jxr_linenumber" name="L80" href="#L80">80</a> } +<a class="jxr_linenumber" name="L81" href="#L81">81</a> excludeFromFailureClasses.put( className, excludedRuleSet ); +<a class="jxr_linenumber" name="L82" href="#L82">82</a> } +<a class="jxr_linenumber" name="L83" href="#L83">83</a> } +<a class="jxr_linenumber" name="L84" href="#L84">84</a> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> @Override +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isExcludedFromFailure( <strong class="jxr_keyword">final</strong> Violation errorDetail ) +<a class="jxr_linenumber" name="L87" href="#L87">87</a> { +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">final</strong> String className = extractClassName( errorDetail.getViolationPackage(), errorDetail.getViolationClass(), +<a class="jxr_linenumber" name="L89" href="#L89">89</a> errorDetail.getFileName() ); +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">return</strong> isExcludedFromFailure( className, errorDetail.getRule() ); +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * Checks whether the given {@link RuleViolation} is excluded. Note: the exclusions must have been</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * loaded before via {@link #loadExcludeFromFailuresData(String)}.</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> <em class="jxr_javadoccomment"> * @param errorDetail the violation to check</em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the violation should be excluded, <code>false</code> otherwise.</em> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isExcludedFromFailure( <strong class="jxr_keyword">final</strong> RuleViolation errorDetail ) +<a class="jxr_linenumber" name="L101" href="#L101">101</a> { +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">final</strong> String className = extractClassName( errorDetail.getPackageName(), errorDetail.getClassName(), +<a class="jxr_linenumber" name="L103" href="#L103">103</a> errorDetail.getFilename() ); +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">return</strong> isExcludedFromFailure( className, errorDetail.getRule().getName() ); +<a class="jxr_linenumber" name="L105" href="#L105">105</a> } +<a class="jxr_linenumber" name="L106" href="#L106">106</a> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> @Override +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> countExclusions() +<a class="jxr_linenumber" name="L109" href="#L109">109</a> { +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">int</strong> result = 0; +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">for</strong> ( Set<String> rules : excludeFromFailureClasses.values() ) +<a class="jxr_linenumber" name="L112" href="#L112">112</a> { +<a class="jxr_linenumber" name="L113" href="#L113">113</a> result += rules.size(); +<a class="jxr_linenumber" name="L114" href="#L114">114</a> } +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">return</strong> result; +<a class="jxr_linenumber" name="L116" href="#L116">116</a> } +<a class="jxr_linenumber" name="L117" href="#L117">117</a> +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isExcludedFromFailure( String className, String ruleName ) +<a class="jxr_linenumber" name="L119" href="#L119">119</a> { +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">final</strong> Set<String> excludedRuleSet = excludeFromFailureClasses.get( className ); +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">return</strong> excludedRuleSet != <strong class="jxr_keyword">null</strong> && excludedRuleSet.contains( ruleName ); +<a class="jxr_linenumber" name="L122" href="#L122">122</a> } +<a class="jxr_linenumber" name="L123" href="#L123">123</a> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">private</strong> String extractClassName( String packageName, String className, String fullPath ) +<a class="jxr_linenumber" name="L125" href="#L125">125</a> { +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_comment">// for some reason, some violations don't contain the package name, so we have to guess the full class name</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_comment">// this looks like a bug in PMD - at least for UnusedImport rule.</em> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isNotEmpty( packageName ) && StringUtils.isNotEmpty( className ) ) +<a class="jxr_linenumber" name="L129" href="#L129">129</a> { +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">return</strong> packageName + <span class="jxr_string">"."</span> + className; +<a class="jxr_linenumber" name="L131" href="#L131">131</a> } +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( StringUtils.isNotEmpty( packageName ) ) +<a class="jxr_linenumber" name="L133" href="#L133">133</a> { +<a class="jxr_linenumber" name="L134" href="#L134">134</a> String fileName = fullPath; +<a class="jxr_linenumber" name="L135" href="#L135">135</a> fileName = fileName.substring( fileName.lastIndexOf( File.separatorChar ) + 1 ); +<a class="jxr_linenumber" name="L136" href="#L136">136</a> fileName = fileName.substring( 0, fileName.length() - 5 ); +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">return</strong> packageName + <span class="jxr_string">"."</span> + fileName; +<a class="jxr_linenumber" name="L138" href="#L138">138</a> } +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> { +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">final</strong> String fileName = fullPath; +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> javaIdx = fileName.indexOf( File.separator + <span class="jxr_string">"java"</span> + File.separator ); +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">return</strong> fileName.substring( javaIdx >= 0 ? javaIdx + 6 : 0, fileName.length() - 5 ).replace( +<a class="jxr_linenumber" name="L144" href="#L144">144</a> File.separatorChar, '.' ); +<a class="jxr_linenumber" name="L145" href="#L145">145</a> } +<a class="jxr_linenumber" name="L146" href="#L146">146</a> } +<a class="jxr_linenumber" name="L147" href="#L147">147</a> } +</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
