Modified: maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdReport.html ============================================================================== --- maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdReport.html (original) +++ maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdReport.html Fri May 12 20:25:56 2023 @@ -6,281 +6,250 @@ </head> <body> <div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/pmd/CpdReport.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.IOException; -<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException; -<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.Locale; -<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.Properties; -<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.ResourceBundle; -<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.plugins.annotations.Mojo; -<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.exec.CpdExecutor; -<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.exec.CpdRequest; -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.exec.CpdResult; -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReportException; -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.toolchain.Toolchain; -<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.cpd.JavaTokenizer; -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.cpd.renderer.CPDRenderer; -<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"> * Creates a report for PMD's Copy/Paste Detector (CPD) tool.</em> -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * It can also generate a cpd results file in any of these formats: xml, csv or txt.</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"> * <p>See <a href="<a href="https://pmd.github.io/latest/pmd_userdocs_cpd.html"; target="alexandria_uri">https://pmd.github.io/latest/pmd_userdocs_cpd.html</a>">Finding duplicated code</a></em> -<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * for more details.</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> <em class="jxr_javadoccomment"> * @author Mike Perham</em> -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * @version $Id$</em> -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * @since 2.0</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> @Mojo( name = <span class="jxr_string">"cpd"</span>, threadSafe = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="CpdReport" href="../../../../../org/apache/maven/plugins/pmd/CpdReport.html#CpdReport">CpdReport</a> -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractPmdReport" href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#AbstractPmdReport">AbstractPmdReport</a> -<a class="jxr_linenumber" name="L53" href="#L53">53</a> { -<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * The programming language to be analyzed by CPD. Valid values are currently <code>java</code>,</em> -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * <code>javascript</code> or <code>jsp</code>.</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> <em class="jxr_javadoccomment"> * @since 3.5</em> -<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L60" href="#L60">60</a> @Parameter( defaultValue = <span class="jxr_string">"java"</span> ) -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">private</strong> String language; -<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"> * The minimum number of tokens that need to be duplicated before it causes a violation.</em> -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L66" href="#L66">66</a> @Parameter( property = <span class="jxr_string">"minimumTokens"</span>, defaultValue = <span class="jxr_string">"100"</span> ) -<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> minimumTokens; -<a class="jxr_linenumber" name="L68" href="#L68">68</a> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * Skip the CPD report generation. Most useful on the command line via "-Dcpd.skip=true".</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> <em class="jxr_javadoccomment"> * @since 2.1</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">"cpd.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"> * If true, CPD ignores literal value differences when evaluating a duplicate block. This means that</em> -<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * <code>foo=42;</code> and <code>foo=43;</code> will be seen as equivalent. You may want to run PMD with this</em> -<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * option off to start with and then switch it on to see what it turns up.</em> -<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"> * @since 2.5</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> @Parameter( property = <span class="jxr_string">"cpd.ignoreLiterals"</span>, defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> ignoreLiterals; -<a class="jxr_linenumber" name="L86" href="#L86">86</a> -<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * Similar to <code>ignoreLiterals</code> but for identifiers; i.e., variable names, methods names, and so forth.</em> -<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"> * @since 2.5</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> @Parameter( property = <span class="jxr_string">"cpd.ignoreIdentifiers"</span>, defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> ignoreIdentifiers; -<a class="jxr_linenumber" name="L94" href="#L94">94</a> -<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * If true, CPD ignores annotations.</em> -<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * @since 3.11.0</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> @Parameter( property = <span class="jxr_string">"cpd.ignoreAnnotations"</span>, defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> ignoreAnnotations; -<a class="jxr_linenumber" name="L102" href="#L102">102</a> -<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * Contains the result of the last CPD execution.</em> -<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * It might be <code>null</code> which means, that CPD</em> -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * has not been executed yet.</em> -<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">private</strong> <a name="CpdResult" href="../../../../../org/apache/maven/plugins/pmd/exec/CpdResult.html#CpdResult">CpdResult</a> cpdResult; -<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> <strong class="jxr_keyword">public</strong> String getName( Locale locale ) -<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> getBundle( locale ).getString( <span class="jxr_string">"report.cpd.name"</span> ); +<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.IOException; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.Locale; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.Properties; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.cpd.JavaTokenizer; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.cpd.renderer.CPDRenderer; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.exec.CpdExecutor; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.exec.CpdRequest; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.exec.CpdResult; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReportException; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.toolchain.Toolchain; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.i18n.I18N; +<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"> * Creates a report for PMD's Copy/Paste Detector (CPD) tool.</em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * It can also generate a cpd results file in any of these formats: xml, csv or txt.</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"> * <p>See <a href="<a href="https://pmd.github.io/latest/pmd_userdocs_cpd.html"; target="alexandria_uri">https://pmd.github.io/latest/pmd_userdocs_cpd.html</a>">Finding duplicated code</a></em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * for more details.</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> <em class="jxr_javadoccomment"> * @author Mike Perham</em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * @version $Id$</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * @since 2.0</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> @Mojo(name = <span class="jxr_string">"cpd"</span>, threadSafe = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="CpdReport" href="../../../../../org/apache/maven/plugins/pmd/CpdReport.html#CpdReport">CpdReport</a> <strong class="jxr_keyword">extends</strong> <a name="AbstractPmdReport" href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#AbstractPmdReport">AbstractPmdReport</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"> * The programming language to be analyzed by CPD. Valid values are currently <code>java</code>,</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * <code>javascript</code> or <code>jsp</code>.</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> <em class="jxr_javadoccomment"> * @since 3.5</em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> @Parameter(defaultValue = <span class="jxr_string">"java"</span>) +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">private</strong> String language; +<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"> * The minimum number of tokens that need to be duplicated before it causes a violation.</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> @Parameter(property = <span class="jxr_string">"minimumTokens"</span>, defaultValue = <span class="jxr_string">"100"</span>) +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> minimumTokens; +<a class="jxr_linenumber" name="L65" href="#L65">65</a> +<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"> * Skip the CPD report generation. Most useful on the command line via "-Dcpd.skip=true".</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> <em class="jxr_javadoccomment"> * @since 2.1</em> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> @Parameter(property = <span class="jxr_string">"cpd.skip"</span>, defaultValue = <span class="jxr_string">"false"</span>) +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip; +<a class="jxr_linenumber" name="L73" href="#L73">73</a> +<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> <em class="jxr_javadoccomment"> * If true, CPD ignores literal value differences when evaluating a duplicate block. This means that</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * <code>foo=42;</code> and <code>foo=43;</code> will be seen as equivalent. You may want to run PMD with this</em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * option off to start with and then switch it on to see what it turns up.</em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * @since 2.5</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> @Parameter(property = <span class="jxr_string">"cpd.ignoreLiterals"</span>, defaultValue = <span class="jxr_string">"false"</span>) +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> ignoreLiterals; +<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"> * Similar to <code>ignoreLiterals</code> but for identifiers; i.e., variable names, methods names, and so forth.</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> <em class="jxr_javadoccomment"> * @since 2.5</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> @Parameter(property = <span class="jxr_string">"cpd.ignoreIdentifiers"</span>, defaultValue = <span class="jxr_string">"false"</span>) +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> ignoreIdentifiers; +<a class="jxr_linenumber" name="L91" href="#L91">91</a> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * If true, CPD ignores annotations.</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * @since 3.11.0</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> @Parameter(property = <span class="jxr_string">"cpd.ignoreAnnotations"</span>, defaultValue = <span class="jxr_string">"false"</span>) +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> ignoreAnnotations; +<a class="jxr_linenumber" name="L99" href="#L99">99</a> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * Internationalization component</em> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> @Component +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">private</strong> I18N i18n; +<a class="jxr_linenumber" name="L105" href="#L105">105</a> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * Contains the result of the last CPD execution.</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * It might be <code>null</code> which means, that CPD</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * has not been executed yet.</em> +<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> <strong class="jxr_keyword">private</strong> <a name="CpdResult" href="../../../../../org/apache/maven/plugins/pmd/exec/CpdResult.html#CpdResult">CpdResult</a> cpdResult; +<a class="jxr_linenumber" name="L112" href="#L112">112</a> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">public</strong> String getName(Locale locale) { +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">return</strong> getI18nString(locale, <span class="jxr_string">"name"</span>); <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> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> -<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">public</strong> String getDescription( Locale locale ) -<a class="jxr_linenumber" name="L122" href="#L122">122</a> { -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">return</strong> getBundle( locale ).getString( <span class="jxr_string">"report.cpd.description"</span> ); -<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> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L129" href="#L129">129</a> @Override -<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> executeReport( Locale locale ) -<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">throws</strong> MavenReportException -<a class="jxr_linenumber" name="L132" href="#L132">132</a> { -<a class="jxr_linenumber" name="L133" href="#L133">133</a> ClassLoader origLoader = Thread.currentThread().getContextClassLoader(); -<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L135" href="#L135">135</a> { -<a class="jxr_linenumber" name="L136" href="#L136">136</a> Thread.currentThread().setContextClassLoader( <strong class="jxr_keyword">this</strong>.getClass().getClassLoader() ); -<a class="jxr_linenumber" name="L137" href="#L137">137</a> -<a class="jxr_linenumber" name="L138" href="#L138">138</a> generateMavenSiteReport( locale ); -<a class="jxr_linenumber" name="L139" href="#L139">139</a> } -<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">finally</strong> -<a class="jxr_linenumber" name="L141" href="#L141">141</a> { -<a class="jxr_linenumber" name="L142" href="#L142">142</a> Thread.currentThread().setContextClassLoader( origLoader ); -<a class="jxr_linenumber" name="L143" href="#L143">143</a> } -<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> @Override -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() -<a class="jxr_linenumber" name="L148" href="#L148">148</a> { -<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">if</strong> ( skip ) -<a class="jxr_linenumber" name="L150" href="#L150">150</a> { -<a class="jxr_linenumber" name="L151" href="#L151">151</a> getLog().info( <span class="jxr_string">"Skipping CPD execution"</span> ); -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">return</strong> false; -<a class="jxr_linenumber" name="L153" href="#L153">153</a> } -<a class="jxr_linenumber" name="L154" href="#L154">154</a> -<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">boolean</strong> result = <strong class="jxr_keyword">super</strong>.canGenerateReport(); -<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">if</strong> ( result ) -<a class="jxr_linenumber" name="L157" href="#L157">157</a> { -<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L159" href="#L159">159</a> { -<a class="jxr_linenumber" name="L160" href="#L160">160</a> executeCpd(); -<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">if</strong> ( skipEmptyReport ) -<a class="jxr_linenumber" name="L162" href="#L162">162</a> { -<a class="jxr_linenumber" name="L163" href="#L163">163</a> result = cpdResult.hasDuplications(); -<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">if</strong> ( !result ) -<a class="jxr_linenumber" name="L165" href="#L165">165</a> { -<a class="jxr_linenumber" name="L166" href="#L166">166</a> getLog().debug( <span class="jxr_string">"Skipping report since skipEmptyReport is true and there are no CPD issues."</span> ); -<a class="jxr_linenumber" name="L167" href="#L167">167</a> } -<a class="jxr_linenumber" name="L168" href="#L168">168</a> } -<a class="jxr_linenumber" name="L169" href="#L169">169</a> } -<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">catch</strong> ( MavenReportException e ) -<a class="jxr_linenumber" name="L171" href="#L171">171</a> { -<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException( e ); -<a class="jxr_linenumber" name="L173" href="#L173">173</a> } -<a class="jxr_linenumber" name="L174" href="#L174">174</a> } -<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">return</strong> result; -<a class="jxr_linenumber" name="L176" href="#L176">176</a> } -<a class="jxr_linenumber" name="L177" href="#L177">177</a> -<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> executeCpd() -<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">throws</strong> MavenReportException -<a class="jxr_linenumber" name="L180" href="#L180">180</a> { -<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">if</strong> ( cpdResult != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L182" href="#L182">182</a> { -<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_comment">// CPD has already been run</em> -<a class="jxr_linenumber" name="L184" href="#L184">184</a> getLog().debug( <span class="jxr_string">"CPD has already been run - skipping redundant execution."</span> ); -<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">public</strong> String getDescription(Locale locale) { +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">return</strong> getI18nString(locale, <span class="jxr_string">"description"</span>); +<a class="jxr_linenumber" name="L121" href="#L121">121</a> } +<a class="jxr_linenumber" name="L122" href="#L122">122</a> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * @param locale The locale</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * @param key The key to search for</em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @return The text appropriate for the locale.</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">protected</strong> String getI18nString(Locale locale, String key) { +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">return</strong> i18n.getString(<span class="jxr_string">"cpd-report"</span>, locale, <span class="jxr_string">"report.cpd."</span> + key); +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> @Override +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> executeReport(Locale locale) <strong class="jxr_keyword">throws</strong> MavenReportException { +<a class="jxr_linenumber" name="L137" href="#L137">137</a> ClassLoader origLoader = Thread.currentThread().getContextClassLoader(); +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L139" href="#L139">139</a> Thread.currentThread().setContextClassLoader(<strong class="jxr_keyword">this</strong>.getClass().getClassLoader()); +<a class="jxr_linenumber" name="L140" href="#L140">140</a> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <a name="CpdReportRenderer" href="../../../../../org/apache/maven/plugins/pmd/CpdReportRenderer.html#CpdReportRenderer">CpdReportRenderer</a> r = <strong class="jxr_keyword">new</strong> <a name="CpdReportRenderer" href="../../../../../org/apache/maven/plugins/pmd/CpdReportRenderer.html#CpdReportRenderer">CpdReportRenderer</a>( +<a class="jxr_linenumber" name="L142" href="#L142">142</a> getSink(), i18n, locale, filesToProcess, cpdResult.getDuplications(), isAggregator()); +<a class="jxr_linenumber" name="L143" href="#L143">143</a> r.render(); +<a class="jxr_linenumber" name="L144" href="#L144">144</a> } <strong class="jxr_keyword">finally</strong> { +<a class="jxr_linenumber" name="L145" href="#L145">145</a> Thread.currentThread().setContextClassLoader(origLoader); +<a class="jxr_linenumber" name="L146" href="#L146">146</a> } +<a class="jxr_linenumber" name="L147" href="#L147">147</a> } +<a class="jxr_linenumber" name="L148" href="#L148">148</a> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> @Override +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() { +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">if</strong> (skip) { +<a class="jxr_linenumber" name="L152" href="#L152">152</a> getLog().info(<span class="jxr_string">"Skipping CPD execution"</span>); +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L154" href="#L154">154</a> } +<a class="jxr_linenumber" name="L155" href="#L155">155</a> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">boolean</strong> result = <strong class="jxr_keyword">super</strong>.canGenerateReport(); +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">if</strong> (result) { +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L159" href="#L159">159</a> executeCpd(); +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">if</strong> (skipEmptyReport) { +<a class="jxr_linenumber" name="L161" href="#L161">161</a> result = cpdResult.hasDuplications(); +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">if</strong> (!result) { +<a class="jxr_linenumber" name="L163" href="#L163">163</a> getLog().debug(<span class="jxr_string">"Skipping report since skipEmptyReport is true and there are no CPD issues."</span>); +<a class="jxr_linenumber" name="L164" href="#L164">164</a> } +<a class="jxr_linenumber" name="L165" href="#L165">165</a> } +<a class="jxr_linenumber" name="L166" href="#L166">166</a> } <strong class="jxr_keyword">catch</strong> (MavenReportException e) { +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException(e); +<a class="jxr_linenumber" name="L168" href="#L168">168</a> } +<a class="jxr_linenumber" name="L169" href="#L169">169</a> } +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">return</strong> result; +<a class="jxr_linenumber" name="L171" href="#L171">171</a> } +<a class="jxr_linenumber" name="L172" href="#L172">172</a> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> executeCpd() <strong class="jxr_keyword">throws</strong> MavenReportException { +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">if</strong> (cpdResult != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_comment">// CPD has already been run</em> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> getLog().debug(<span class="jxr_string">"CPD has already been run - skipping redundant execution."</span>); +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L178" href="#L178">178</a> } +<a class="jxr_linenumber" name="L179" href="#L179">179</a> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> Properties languageProperties = <strong class="jxr_keyword">new</strong> Properties(); +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">if</strong> (ignoreLiterals) { +<a class="jxr_linenumber" name="L182" href="#L182">182</a> languageProperties.setProperty(JavaTokenizer.IGNORE_LITERALS, <span class="jxr_string">"true"</span>); +<a class="jxr_linenumber" name="L183" href="#L183">183</a> } +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">if</strong> (ignoreIdentifiers) { +<a class="jxr_linenumber" name="L185" href="#L185">185</a> languageProperties.setProperty(JavaTokenizer.IGNORE_IDENTIFIERS, <span class="jxr_string">"true"</span>); <a class="jxr_linenumber" name="L186" href="#L186">186</a> } -<a class="jxr_linenumber" name="L187" href="#L187">187</a> -<a class="jxr_linenumber" name="L188" href="#L188">188</a> Properties languageProperties = <strong class="jxr_keyword">new</strong> Properties(); -<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">if</strong> ( ignoreLiterals ) -<a class="jxr_linenumber" name="L190" href="#L190">190</a> { -<a class="jxr_linenumber" name="L191" href="#L191">191</a> languageProperties.setProperty( JavaTokenizer.IGNORE_LITERALS, <span class="jxr_string">"true"</span> ); -<a class="jxr_linenumber" name="L192" href="#L192">192</a> } -<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">if</strong> ( ignoreIdentifiers ) -<a class="jxr_linenumber" name="L194" href="#L194">194</a> { -<a class="jxr_linenumber" name="L195" href="#L195">195</a> languageProperties.setProperty( JavaTokenizer.IGNORE_IDENTIFIERS, <span class="jxr_string">"true"</span> ); -<a class="jxr_linenumber" name="L196" href="#L196">196</a> } -<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">if</strong> ( ignoreAnnotations ) -<a class="jxr_linenumber" name="L198" href="#L198">198</a> { -<a class="jxr_linenumber" name="L199" href="#L199">199</a> languageProperties.setProperty( JavaTokenizer.IGNORE_ANNOTATIONS, <span class="jxr_string">"true"</span> ); -<a class="jxr_linenumber" name="L200" href="#L200">200</a> } -<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L202" href="#L202">202</a> { -<a class="jxr_linenumber" name="L203" href="#L203">203</a> filesToProcess = getFilesToProcess(); -<a class="jxr_linenumber" name="L204" href="#L204">204</a> -<a class="jxr_linenumber" name="L205" href="#L205">205</a> <a name="CpdRequest" href="../../../../../org/apache/maven/plugins/pmd/exec/CpdRequest.html#CpdRequest">CpdRequest</a> request = <strong class="jxr_keyword">new</strong> <a name="CpdRequest" href="../../../../../org/apache/maven/plugins/pmd/exec/CpdRequest.html#CpdRequest">CpdRequest</a>(); -<a class="jxr_linenumber" name="L206" href="#L206">206</a> request.setMinimumTokens( minimumTokens ); -<a class="jxr_linenumber" name="L207" href="#L207">207</a> request.setLanguage( language ); -<a class="jxr_linenumber" name="L208" href="#L208">208</a> request.setLanguageProperties( languageProperties ); -<a class="jxr_linenumber" name="L209" href="#L209">209</a> request.setSourceEncoding( getInputEncoding() ); -<a class="jxr_linenumber" name="L210" href="#L210">210</a> request.addFiles( filesToProcess.keySet() ); -<a class="jxr_linenumber" name="L211" href="#L211">211</a> -<a class="jxr_linenumber" name="L212" href="#L212">212</a> request.setShowPmdLog( showPmdLog ); -<a class="jxr_linenumber" name="L213" href="#L213">213</a> request.setLogLevel( determineCurrentRootLogLevel() ); -<a class="jxr_linenumber" name="L214" href="#L214">214</a> -<a class="jxr_linenumber" name="L215" href="#L215">215</a> request.setExcludeFromFailureFile( excludeFromFailureFile ); -<a class="jxr_linenumber" name="L216" href="#L216">216</a> request.setTargetDirectory( targetDirectory.getAbsolutePath() ); -<a class="jxr_linenumber" name="L217" href="#L217">217</a> request.setOutputEncoding( getOutputEncoding() ); -<a class="jxr_linenumber" name="L218" href="#L218">218</a> request.setFormat( format ); -<a class="jxr_linenumber" name="L219" href="#L219">219</a> request.setIncludeXmlInSite( includeXmlInSite ); -<a class="jxr_linenumber" name="L220" href="#L220">220</a> request.setReportOutputDirectory( getReportOutputDirectory().getAbsolutePath() ); -<a class="jxr_linenumber" name="L221" href="#L221">221</a> -<a class="jxr_linenumber" name="L222" href="#L222">222</a> Toolchain tc = getToolchain(); -<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">if</strong> ( tc != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L224" href="#L224">224</a> { -<a class="jxr_linenumber" name="L225" href="#L225">225</a> getLog().info( <span class="jxr_string">"Toolchain in maven-pmd-plugin: "</span> + tc ); -<a class="jxr_linenumber" name="L226" href="#L226">226</a> String javaExecutable = tc.findTool( <span class="jxr_string">"java"</span> ); <em class="jxr_comment">//NOI18N</em> -<a class="jxr_linenumber" name="L227" href="#L227">227</a> request.setJavaExecutable( javaExecutable ); -<a class="jxr_linenumber" name="L228" href="#L228">228</a> } -<a class="jxr_linenumber" name="L229" href="#L229">229</a> -<a class="jxr_linenumber" name="L230" href="#L230">230</a> getLog().info( <span class="jxr_string">"PMD version: "</span> + AbstractPmdReport.getPmdVersion() ); -<a class="jxr_linenumber" name="L231" href="#L231">231</a> cpdResult = CpdExecutor.execute( request ); -<a class="jxr_linenumber" name="L232" href="#L232">232</a> } -<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">catch</strong> ( UnsupportedEncodingException e ) -<a class="jxr_linenumber" name="L234" href="#L234">234</a> { -<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Encoding '"</span> + getInputEncoding() + <span class="jxr_string">"' is not supported."</span>, e ); -<a class="jxr_linenumber" name="L236" href="#L236">236</a> } -<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) -<a class="jxr_linenumber" name="L238" href="#L238">238</a> { -<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e ); -<a class="jxr_linenumber" name="L240" href="#L240">240</a> } -<a class="jxr_linenumber" name="L241" href="#L241">241</a> } -<a class="jxr_linenumber" name="L242" href="#L242">242</a> -<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> generateMavenSiteReport( Locale locale ) -<a class="jxr_linenumber" name="L244" href="#L244">244</a> { -<a class="jxr_linenumber" name="L245" href="#L245">245</a> <a name="CpdReportGenerator" href="../../../../../org/apache/maven/plugins/pmd/CpdReportGenerator.html#CpdReportGenerator">CpdReportGenerator</a> gen = <strong class="jxr_keyword">new</strong> <a name="CpdReportGenerator" href="../../../../../org/apache/maven/plugins/pmd/CpdReportGenerator.html#CpdReportGenerator">CpdReportGenerator</a>( getSink(), filesToProcess, getBundle( locale ), -<a class="jxr_linenumber" name="L246" href="#L246">246</a> isAggregator() ); -<a class="jxr_linenumber" name="L247" href="#L247">247</a> gen.generate( cpdResult.getDuplications() ); -<a class="jxr_linenumber" name="L248" href="#L248">248</a> } -<a class="jxr_linenumber" name="L249" href="#L249">249</a> -<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> -<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">public</strong> String getOutputName() -<a class="jxr_linenumber" name="L254" href="#L254">254</a> { -<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"cpd"</span>; -<a class="jxr_linenumber" name="L256" href="#L256">256</a> } -<a class="jxr_linenumber" name="L257" href="#L257">257</a> -<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> ResourceBundle getBundle( Locale locale ) -<a class="jxr_linenumber" name="L259" href="#L259">259</a> { -<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">return</strong> ResourceBundle.getBundle( <span class="jxr_string">"cpd-report"</span>, locale, CpdReport.<strong class="jxr_keyword">class</strong>.getClassLoader() ); -<a class="jxr_linenumber" name="L261" href="#L261">261</a> } -<a class="jxr_linenumber" name="L262" href="#L262">262</a> -<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> * Create and return the correct renderer for the output type.</em> -<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> * @return the renderer based on the configured output</em> -<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> * @throws org.apache.maven.reporting.MavenReportException if no renderer found for the output type</em> -<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment"> * @deprecated Use {@link CpdExecutor#createRenderer(String, String)} instead.</em> -<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L270" href="#L270">270</a> @Deprecated -<a class="jxr_linenumber" name="L271" href="#L271">271</a> <strong class="jxr_keyword">public</strong> CPDRenderer createRenderer() <strong class="jxr_keyword">throws</strong> MavenReportException -<a class="jxr_linenumber" name="L272" href="#L272">272</a> { -<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">return</strong> CpdExecutor.createRenderer( format, getOutputEncoding() ); -<a class="jxr_linenumber" name="L274" href="#L274">274</a> } -<a class="jxr_linenumber" name="L275" href="#L275">275</a> } +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">if</strong> (ignoreAnnotations) { +<a class="jxr_linenumber" name="L188" href="#L188">188</a> languageProperties.setProperty(JavaTokenizer.IGNORE_ANNOTATIONS, <span class="jxr_string">"true"</span>); +<a class="jxr_linenumber" name="L189" href="#L189">189</a> } +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L191" href="#L191">191</a> filesToProcess = getFilesToProcess(); +<a class="jxr_linenumber" name="L192" href="#L192">192</a> +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <a name="CpdRequest" href="../../../../../org/apache/maven/plugins/pmd/exec/CpdRequest.html#CpdRequest">CpdRequest</a> request = <strong class="jxr_keyword">new</strong> <a name="CpdRequest" href="../../../../../org/apache/maven/plugins/pmd/exec/CpdRequest.html#CpdRequest">CpdRequest</a>(); +<a class="jxr_linenumber" name="L194" href="#L194">194</a> request.setMinimumTokens(minimumTokens); +<a class="jxr_linenumber" name="L195" href="#L195">195</a> request.setLanguage(language); +<a class="jxr_linenumber" name="L196" href="#L196">196</a> request.setLanguageProperties(languageProperties); +<a class="jxr_linenumber" name="L197" href="#L197">197</a> request.setSourceEncoding(getInputEncoding()); +<a class="jxr_linenumber" name="L198" href="#L198">198</a> request.addFiles(filesToProcess.keySet()); +<a class="jxr_linenumber" name="L199" href="#L199">199</a> +<a class="jxr_linenumber" name="L200" href="#L200">200</a> request.setShowPmdLog(showPmdLog); +<a class="jxr_linenumber" name="L201" href="#L201">201</a> request.setLogLevel(determineCurrentRootLogLevel()); +<a class="jxr_linenumber" name="L202" href="#L202">202</a> +<a class="jxr_linenumber" name="L203" href="#L203">203</a> request.setExcludeFromFailureFile(excludeFromFailureFile); +<a class="jxr_linenumber" name="L204" href="#L204">204</a> request.setTargetDirectory(targetDirectory.getAbsolutePath()); +<a class="jxr_linenumber" name="L205" href="#L205">205</a> request.setOutputEncoding(getOutputEncoding()); +<a class="jxr_linenumber" name="L206" href="#L206">206</a> request.setFormat(format); +<a class="jxr_linenumber" name="L207" href="#L207">207</a> request.setIncludeXmlInSite(includeXmlInSite); +<a class="jxr_linenumber" name="L208" href="#L208">208</a> request.setReportOutputDirectory(getReportOutputDirectory().getAbsolutePath()); +<a class="jxr_linenumber" name="L209" href="#L209">209</a> +<a class="jxr_linenumber" name="L210" href="#L210">210</a> Toolchain tc = getToolchain(); +<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">if</strong> (tc != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L212" href="#L212">212</a> getLog().info(<span class="jxr_string">"Toolchain in maven-pmd-plugin: "</span> + tc); +<a class="jxr_linenumber" name="L213" href="#L213">213</a> String javaExecutable = tc.findTool(<span class="jxr_string">"java"</span>); <em class="jxr_comment">// NOI18N</em> +<a class="jxr_linenumber" name="L214" href="#L214">214</a> request.setJavaExecutable(javaExecutable); +<a class="jxr_linenumber" name="L215" href="#L215">215</a> } +<a class="jxr_linenumber" name="L216" href="#L216">216</a> +<a class="jxr_linenumber" name="L217" href="#L217">217</a> getLog().info(<span class="jxr_string">"PMD version: "</span> + AbstractPmdReport.getPmdVersion()); +<a class="jxr_linenumber" name="L218" href="#L218">218</a> cpdResult = CpdExecutor.execute(request); +<a class="jxr_linenumber" name="L219" href="#L219">219</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException e) { +<a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(<span class="jxr_string">"Encoding '"</span> + getInputEncoding() + <span class="jxr_string">"' is not supported."</span>, e); +<a class="jxr_linenumber" name="L221" href="#L221">221</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { +<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(e.getMessage(), e); +<a class="jxr_linenumber" name="L223" href="#L223">223</a> } +<a class="jxr_linenumber" name="L224" href="#L224">224</a> } +<a class="jxr_linenumber" name="L225" href="#L225">225</a> +<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">public</strong> String getOutputName() { +<a class="jxr_linenumber" name="L230" href="#L230">230</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"cpd"</span>; +<a class="jxr_linenumber" name="L231" href="#L231">231</a> } +<a class="jxr_linenumber" name="L232" href="#L232">232</a> +<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> * Create and return the correct renderer for the output type.</em> +<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> * @return the renderer based on the configured output</em> +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> * @throws org.apache.maven.reporting.MavenReportException if no renderer found for the output type</em> +<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * @deprecated Use {@link CpdExecutor#createRenderer(String, String)} instead.</em> +<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L240" href="#L240">240</a> @Deprecated +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">public</strong> CPDRenderer createRenderer() <strong class="jxr_keyword">throws</strong> MavenReportException { +<a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">return</strong> CpdExecutor.createRenderer(format, getOutputEncoding()); +<a class="jxr_linenumber" name="L243" href="#L243">243</a> } +<a class="jxr_linenumber" name="L244" href="#L244">244</a> } </pre> <hr/> <div id="footer">Copyright © 2005–2023 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div>
Added: maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdReportRenderer.html ============================================================================== --- maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdReportRenderer.html (added) +++ maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdReportRenderer.html Fri May 12 20:25:56 2023 @@ -0,0 +1,192 @@ +<!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>CpdReportRenderer xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/pmd/CpdReportRenderer.html">View Javadoc</a></div><pre> +<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"> * 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> javax.swing.text.html.HTML.Attribute; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.File; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.Collection; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.Locale; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.Map; +<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.doxia.sink.Sink; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.SinkEventAttributes; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.impl.SinkEventAttributeSet; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.model.CpdFile; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.pmd.model.Duplication; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.AbstractMavenReportRenderer; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.i18n.I18N; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; +<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"> * Class that generated the CPD report.</em> +<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"> * @author mperham</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"> */</em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="CpdReportRenderer" href="../../../../../org/apache/maven/plugins/pmd/CpdReportRenderer.html#CpdReportRenderer">CpdReportRenderer</a> <strong class="jxr_keyword">extends</strong> AbstractMavenReportRenderer { +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> I18N i18n; +<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> <strong class="jxr_keyword">final</strong> Locale locale; +<a class="jxr_linenumber" name="L48" href="#L48">48</a> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map<File, PmdFileInfo> files; +<a class="jxr_linenumber" name="L50" href="#L50">50</a> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Collection<Duplication> duplications; +<a class="jxr_linenumber" name="L52" href="#L52">52</a> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> aggregate; +<a class="jxr_linenumber" name="L54" href="#L54">54</a> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">public</strong> <a name="CpdReportRenderer" href="../../../../../org/apache/maven/plugins/pmd/CpdReportRenderer.html#CpdReportRenderer">CpdReportRenderer</a>( +<a class="jxr_linenumber" name="L56" href="#L56">56</a> Sink sink, +<a class="jxr_linenumber" name="L57" href="#L57">57</a> I18N i18n, +<a class="jxr_linenumber" name="L58" href="#L58">58</a> Locale locale, +<a class="jxr_linenumber" name="L59" href="#L59">59</a> Map<File, PmdFileInfo> files, +<a class="jxr_linenumber" name="L60" href="#L60">60</a> Collection<Duplication> duplications, +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">boolean</strong> aggregate) { +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">super</strong>(sink); +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">this</strong>.i18n = i18n; +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">this</strong>.locale = locale; +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">this</strong>.files = files; +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">this</strong>.duplications = duplications; +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">this</strong>.aggregate = aggregate; +<a class="jxr_linenumber" name="L68" href="#L68">68</a> } +<a class="jxr_linenumber" name="L69" href="#L69">69</a> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> @Override +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">public</strong> String getTitle() { +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">return</strong> getI18nString(<span class="jxr_string">"title"</span>); +<a class="jxr_linenumber" name="L73" href="#L73">73</a> } +<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"> * @param key The key.</em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * @return The translated string.</em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">private</strong> String getI18nString(String key) { +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">return</strong> i18n.getString(<span class="jxr_string">"cpd-report"</span>, locale, <span class="jxr_string">"report.cpd."</span> + key); +<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> @Override +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> renderBody() { +<a class="jxr_linenumber" name="L85" href="#L85">85</a> startSection(getTitle()); +<a class="jxr_linenumber" name="L86" href="#L86">86</a> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> sink.paragraph(); +<a class="jxr_linenumber" name="L88" href="#L88">88</a> sink.text(getI18nString(<span class="jxr_string">"cpdlink"</span>) + <span class="jxr_string">" "</span>); +<a class="jxr_linenumber" name="L89" href="#L89">89</a> link(<span class="jxr_string">"https://pmd.github.io/latest/pmd_userdocs_cpd.html";</span>, <span class="jxr_string">"CPD"</span>); +<a class="jxr_linenumber" name="L90" href="#L90">90</a> sink.text(<span class="jxr_string">" "</span> + AbstractPmdReport.getPmdVersion() + <span class="jxr_string">"."</span>); +<a class="jxr_linenumber" name="L91" href="#L91">91</a> sink.paragraph_(); +<a class="jxr_linenumber" name="L92" href="#L92">92</a> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_comment">// TODO overall summary</em> +<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> (!duplications.isEmpty()) { +<a class="jxr_linenumber" name="L96" href="#L96">96</a> renderDuplications(); +<a class="jxr_linenumber" name="L97" href="#L97">97</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L98" href="#L98">98</a> paragraph(getI18nString(<span class="jxr_string">"noProblems"</span>)); +<a class="jxr_linenumber" name="L99" href="#L99">99</a> } +<a class="jxr_linenumber" name="L100" href="#L100">100</a> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_comment">// TODO files summary</em> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> endSection(); +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * Method that generates a line of CPD report according to a TokenEntry.</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> generateFileLine(CpdFile duplicationMark) { +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_comment">// Get information for report generation</em> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> String filename = duplicationMark.getPath(); +<a class="jxr_linenumber" name="L112" href="#L112">112</a> File file = <strong class="jxr_keyword">new</strong> File(filename); +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <a name="PmdFileInfo" href="../../../../../org/apache/maven/plugins/pmd/PmdFileInfo.html#PmdFileInfo">PmdFileInfo</a> fileInfo = files.get(file); +<a class="jxr_linenumber" name="L114" href="#L114">114</a> File sourceDirectory = fileInfo.getSourceDirectory(); +<a class="jxr_linenumber" name="L115" href="#L115">115</a> filename = StringUtils.substring( +<a class="jxr_linenumber" name="L116" href="#L116">116</a> filename, sourceDirectory.getAbsolutePath().length() + 1); +<a class="jxr_linenumber" name="L117" href="#L117">117</a> String xrefLocation = fileInfo.getXrefLocation(); +<a class="jxr_linenumber" name="L118" href="#L118">118</a> MavenProject projectFile = fileInfo.getProject(); +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">int</strong> line = duplicationMark.getLine(); +<a class="jxr_linenumber" name="L120" href="#L120">120</a> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> sink.tableRow(); +<a class="jxr_linenumber" name="L122" href="#L122">122</a> tableCell(filename); +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">if</strong> (aggregate) { +<a class="jxr_linenumber" name="L124" href="#L124">124</a> tableCell(projectFile.getName()); +<a class="jxr_linenumber" name="L125" href="#L125">125</a> } +<a class="jxr_linenumber" name="L126" href="#L126">126</a> sink.tableCell(); +<a class="jxr_linenumber" name="L127" href="#L127">127</a> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">if</strong> (xrefLocation != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L129" href="#L129">129</a> sink.link(xrefLocation + <span class="jxr_string">"/"</span> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> + filename.replaceAll(<span class="jxr_string">"\\.java$"</span>, <span class="jxr_string">".html"</span>).replace('\\', '/') + <span class="jxr_string">"#L"</span> + line); +<a class="jxr_linenumber" name="L131" href="#L131">131</a> } +<a class="jxr_linenumber" name="L132" href="#L132">132</a> sink.text(String.valueOf(line)); +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">if</strong> (xrefLocation != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L134" href="#L134">134</a> sink.link_(); +<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> sink.tableCell_(); +<a class="jxr_linenumber" name="L138" href="#L138">138</a> sink.tableRow_(); +<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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> renderDuplications() { +<a class="jxr_linenumber" name="L142" href="#L142">142</a> startSection(getI18nString(<span class="jxr_string">"dupes"</span>)); +<a class="jxr_linenumber" name="L143" href="#L143">143</a> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">for</strong> (Duplication duplication : duplications) { +<a class="jxr_linenumber" name="L145" href="#L145">145</a> String code = duplication.getCodefragment(); +<a class="jxr_linenumber" name="L146" href="#L146">146</a> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> startTable(); +<a class="jxr_linenumber" name="L148" href="#L148">148</a> sink.tableRow(); +<a class="jxr_linenumber" name="L149" href="#L149">149</a> tableHeaderCell(getI18nString(<span class="jxr_string">"column.file"</span>)); +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">if</strong> (aggregate) { +<a class="jxr_linenumber" name="L151" href="#L151">151</a> tableHeaderCell(getI18nString(<span class="jxr_string">"column.project"</span>)); +<a class="jxr_linenumber" name="L152" href="#L152">152</a> } +<a class="jxr_linenumber" name="L153" href="#L153">153</a> tableHeaderCell(getI18nString(<span class="jxr_string">"column.line"</span>)); +<a class="jxr_linenumber" name="L154" href="#L154">154</a> sink.tableRow_(); +<a class="jxr_linenumber" name="L155" href="#L155">155</a> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_comment">// Iterating on every token entry</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">for</strong> (CpdFile mark : duplication.getFiles()) { +<a class="jxr_linenumber" name="L158" href="#L158">158</a> generateFileLine(mark); +<a class="jxr_linenumber" name="L159" href="#L159">159</a> } +<a class="jxr_linenumber" name="L160" href="#L160">160</a> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_comment">// Source snippet</em> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> sink.tableRow(); +<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> colspan = 2; +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">if</strong> (aggregate) { +<a class="jxr_linenumber" name="L166" href="#L166">166</a> colspan = 3; +<a class="jxr_linenumber" name="L167" href="#L167">167</a> } +<a class="jxr_linenumber" name="L168" href="#L168">168</a> SinkEventAttributes att = <strong class="jxr_keyword">new</strong> SinkEventAttributeSet(); +<a class="jxr_linenumber" name="L169" href="#L169">169</a> att.addAttribute(Attribute.COLSPAN, colspan); +<a class="jxr_linenumber" name="L170" href="#L170">170</a> sink.tableCell(att); +<a class="jxr_linenumber" name="L171" href="#L171">171</a> verbatimText(code); +<a class="jxr_linenumber" name="L172" href="#L172">172</a> sink.tableCell_(); +<a class="jxr_linenumber" name="L173" href="#L173">173</a> sink.tableRow_(); +<a class="jxr_linenumber" name="L174" href="#L174">174</a> endTable(); +<a class="jxr_linenumber" name="L175" href="#L175">175</a> } +<a class="jxr_linenumber" name="L176" href="#L176">176</a> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> endSection(); +<a class="jxr_linenumber" name="L178" href="#L178">178</a> } +<a class="jxr_linenumber" name="L179" href="#L179">179</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2005–2023 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html> \ No newline at end of file
