Added: websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdReport.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdReport.html (added) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdReport.html Sun Jan 21 17:23:18 2018 @@ -0,0 +1,455 @@ +<!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>CpdReport xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</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="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.ByteArrayOutputStream; +<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.io.FileOutputStream; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.io.OutputStreamWriter; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.io.Writer; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.util.Locale; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> java.util.Properties; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> java.util.ResourceBundle; +<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> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReportException; +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.FileUtils; +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.WriterFactory; +<a class="jxr_linenumber" name="L43" href="#L43">43</a> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.cpd.CPD; +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.cpd.CPDConfiguration; +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.cpd.CSVRenderer; +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.cpd.EcmascriptLanguage; +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.cpd.JSPLanguage; +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.cpd.JavaLanguage; +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.cpd.JavaTokenizer; +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.cpd.Language; +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.cpd.LanguageFactory; +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.cpd.Match; +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.cpd.Renderer; +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.cpd.XMLRenderer; +<a class="jxr_linenumber" name="L56" href="#L56">56</a> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * Creates a report for PMD's CPD tool. See</em> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * <a href="https://pmd.github.io/latest/pmd_userdocs_cpd.html">Finding duplicated code</a></em> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * for more details.</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * @author Mike Perham</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * @version $Id$</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * @since 2.0</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> @Mojo( name = <span class="jxr_string">"cpd"</span>, threadSafe = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/pmd/CpdReport.html">CpdReport</a> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html">AbstractPmdReport</a> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> { +<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> <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="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * <code>javascript</code> or <code>jsp</code>.</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * @since 3.5</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> @Parameter( defaultValue = <span class="jxr_string">"java"</span> ) +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">private</strong> String language; +<a class="jxr_linenumber" name="L78" href="#L78">78</a> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * The minimum number of tokens that need to be duplicated before it causes a violation.</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> @Parameter( property = <span class="jxr_string">"minimumTokens"</span>, defaultValue = <span class="jxr_string">"100"</span> ) +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> minimumTokens; +<a class="jxr_linenumber" name="L84" href="#L84">84</a> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L86" href="#L86">86</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="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * @since 2.1</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> @Parameter( property = <span class="jxr_string">"cpd.skip"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip; +<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"> * If true, CPD ignores literal value differences when evaluating a duplicate block. This means that</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</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="L96" href="#L96">96</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="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 2.5</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.ignoreLiterals"</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> ignoreLiterals; +<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"> * Similar to <code>ignoreLiterals</code> but for identifiers; i.e., variable names, methods names, and so forth.</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * @since 2.5</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> @Parameter( property = <span class="jxr_string">"cpd.ignoreIdentifiers"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> ignoreIdentifiers; +<a class="jxr_linenumber" name="L110" href="#L110">110</a> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment">/** The CPD instance used to analyze the files. Will itself collect the duplicated code matches. */</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">private</strong> CPD cpd; +<a class="jxr_linenumber" name="L113" href="#L113">113</a> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment">/** Helper to exclude duplications from the result. */</em> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/maven/plugins/pmd/ExcludeDuplicationsFromFile.html">ExcludeDuplicationsFromFile</a> excludeDuplicationsFromFile = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugins/pmd/ExcludeDuplicationsFromFile.html">ExcludeDuplicationsFromFile</a>(); +<a class="jxr_linenumber" name="L116" href="#L116">116</a> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment">/**</em> +<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> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">public</strong> String getName( Locale locale ) +<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> getBundle( locale ).getString( <span class="jxr_string">"report.cpd.name"</span> ); +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</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">public</strong> String getDescription( Locale locale ) +<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> getBundle( locale ).getString( <span class="jxr_string">"report.cpd.description"</span> ); +<a class="jxr_linenumber" name="L131" href="#L131">131</a> } +<a class="jxr_linenumber" name="L132" href="#L132">132</a> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> @Override +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> executeReport( Locale locale ) +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">throws</strong> MavenReportException +<a class="jxr_linenumber" name="L139" href="#L139">139</a> { +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> { +<a class="jxr_linenumber" name="L142" href="#L142">142</a> execute( locale ); +<a class="jxr_linenumber" name="L143" href="#L143">143</a> } +<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> { +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">if</strong> ( getSink() != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L147" href="#L147">147</a> { +<a class="jxr_linenumber" name="L148" href="#L148">148</a> getSink().close(); +<a class="jxr_linenumber" name="L149" href="#L149">149</a> } +<a class="jxr_linenumber" name="L150" href="#L150">150</a> } +<a class="jxr_linenumber" name="L151" href="#L151">151</a> } +<a class="jxr_linenumber" name="L152" href="#L152">152</a> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> execute( Locale locale ) +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">throws</strong> MavenReportException +<a class="jxr_linenumber" name="L155" href="#L155">155</a> { +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">if</strong> ( !skip && canGenerateReport() ) +<a class="jxr_linenumber" name="L157" href="#L157">157</a> { +<a class="jxr_linenumber" name="L158" href="#L158">158</a> ClassLoader origLoader = Thread.currentThread().getContextClassLoader(); +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> { +<a class="jxr_linenumber" name="L161" href="#L161">161</a> Thread.currentThread().setContextClassLoader( <strong class="jxr_keyword">this</strong>.getClass().getClassLoader() ); +<a class="jxr_linenumber" name="L162" href="#L162">162</a> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> generateReport( locale ); +<a class="jxr_linenumber" name="L164" href="#L164">164</a> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">if</strong> ( !isHtml() && !isXml() ) +<a class="jxr_linenumber" name="L166" href="#L166">166</a> { +<a class="jxr_linenumber" name="L167" href="#L167">167</a> writeNonHtml( cpd ); +<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">finally</strong> +<a class="jxr_linenumber" name="L171" href="#L171">171</a> { +<a class="jxr_linenumber" name="L172" href="#L172">172</a> Thread.currentThread().setContextClassLoader( origLoader ); +<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> } +<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> @Override +<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() +<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> ( skip ) +<a class="jxr_linenumber" name="L182" href="#L182">182</a> { +<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L184" href="#L184">184</a> } +<a class="jxr_linenumber" name="L185" href="#L185">185</a> +<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">boolean</strong> result = <strong class="jxr_keyword">super</strong>.canGenerateReport(); +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">if</strong> ( result ) +<a class="jxr_linenumber" name="L188" href="#L188">188</a> { +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> { +<a class="jxr_linenumber" name="L191" href="#L191">191</a> executeCpdWithClassloader(); +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">if</strong> ( skipEmptyReport ) +<a class="jxr_linenumber" name="L193" href="#L193">193</a> { +<a class="jxr_linenumber" name="L194" href="#L194">194</a> result = cpd.getMatches().hasNext(); +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">if</strong> ( result ) +<a class="jxr_linenumber" name="L196" href="#L196">196</a> { +<a class="jxr_linenumber" name="L197" href="#L197">197</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="L198" href="#L198">198</a> } +<a class="jxr_linenumber" name="L199" href="#L199">199</a> } +<a class="jxr_linenumber" name="L200" href="#L200">200</a> } +<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong class="jxr_keyword">catch</strong> ( MavenReportException e ) +<a class="jxr_linenumber" name="L202" href="#L202">202</a> { +<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException( e ); +<a class="jxr_linenumber" name="L204" href="#L204">204</a> } +<a class="jxr_linenumber" name="L205" href="#L205">205</a> } +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">return</strong> result; +<a class="jxr_linenumber" name="L207" href="#L207">207</a> } +<a class="jxr_linenumber" name="L208" href="#L208">208</a> +<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> executeCpdWithClassloader() +<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">throws</strong> MavenReportException +<a class="jxr_linenumber" name="L211" href="#L211">211</a> { +<a class="jxr_linenumber" name="L212" href="#L212">212</a> ClassLoader origLoader = Thread.currentThread().getContextClassLoader(); +<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L214" href="#L214">214</a> { +<a class="jxr_linenumber" name="L215" href="#L215">215</a> Thread.currentThread().setContextClassLoader( <strong class="jxr_keyword">this</strong>.getClass().getClassLoader() ); +<a class="jxr_linenumber" name="L216" href="#L216">216</a> executeCpd(); +<a class="jxr_linenumber" name="L217" href="#L217">217</a> } +<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">finally</strong> +<a class="jxr_linenumber" name="L219" href="#L219">219</a> { +<a class="jxr_linenumber" name="L220" href="#L220">220</a> Thread.currentThread().setContextClassLoader( origLoader ); +<a class="jxr_linenumber" name="L221" href="#L221">221</a> } +<a class="jxr_linenumber" name="L222" href="#L222">222</a> } +<a class="jxr_linenumber" name="L223" href="#L223">223</a> +<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> executeCpd() +<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">throws</strong> MavenReportException +<a class="jxr_linenumber" name="L226" href="#L226">226</a> { +<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">if</strong> ( cpd != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L228" href="#L228">228</a> { +<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_comment">// CPD has already been run</em> +<a class="jxr_linenumber" name="L230" href="#L230">230</a> getLog().debug( <span class="jxr_string">"CPD has already been run - skipping redundant execution."</span> ); +<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L232" href="#L232">232</a> } +<a class="jxr_linenumber" name="L233" href="#L233">233</a> +<a class="jxr_linenumber" name="L234" href="#L234">234</a> setupPmdLogging(); +<a class="jxr_linenumber" name="L235" href="#L235">235</a> +<a class="jxr_linenumber" name="L236" href="#L236">236</a> Properties p = <strong class="jxr_keyword">new</strong> Properties(); +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">if</strong> ( ignoreLiterals ) +<a class="jxr_linenumber" name="L238" href="#L238">238</a> { +<a class="jxr_linenumber" name="L239" href="#L239">239</a> p.setProperty( JavaTokenizer.IGNORE_LITERALS, <span class="jxr_string">"true"</span> ); +<a class="jxr_linenumber" name="L240" href="#L240">240</a> } +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">if</strong> ( ignoreIdentifiers ) +<a class="jxr_linenumber" name="L242" href="#L242">242</a> { +<a class="jxr_linenumber" name="L243" href="#L243">243</a> p.setProperty( JavaTokenizer.IGNORE_IDENTIFIERS, <span class="jxr_string">"true"</span> ); +<a class="jxr_linenumber" name="L244" href="#L244">244</a> } +<a class="jxr_linenumber" name="L245" href="#L245">245</a> +<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L247" href="#L247">247</a> { +<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong class="jxr_keyword">if</strong> ( filesToProcess == <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L249" href="#L249">249</a> { +<a class="jxr_linenumber" name="L250" href="#L250">250</a> filesToProcess = getFilesToProcess(); +<a class="jxr_linenumber" name="L251" href="#L251">251</a> } +<a class="jxr_linenumber" name="L252" href="#L252">252</a> +<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L254" href="#L254">254</a> { +<a class="jxr_linenumber" name="L255" href="#L255">255</a> excludeDuplicationsFromFile.loadExcludeFromFailuresData( excludeFromFailureFile ); +<a class="jxr_linenumber" name="L256" href="#L256">256</a> } +<a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong class="jxr_keyword">catch</strong> ( MojoExecutionException e ) +<a class="jxr_linenumber" name="L258" href="#L258">258</a> { +<a class="jxr_linenumber" name="L259" href="#L259">259</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Error loading exclusions"</span>, e ); +<a class="jxr_linenumber" name="L260" href="#L260">260</a> } +<a class="jxr_linenumber" name="L261" href="#L261">261</a> +<a class="jxr_linenumber" name="L262" href="#L262">262</a> String encoding = determineEncoding( !filesToProcess.isEmpty() ); +<a class="jxr_linenumber" name="L263" href="#L263">263</a> Language cpdLanguage; +<a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"java"</span>.equals ( language ) || <strong class="jxr_keyword">null</strong> == language ) +<a class="jxr_linenumber" name="L265" href="#L265">265</a> { +<a class="jxr_linenumber" name="L266" href="#L266">266</a> cpdLanguage = <strong class="jxr_keyword">new</strong> JavaLanguage( p ); +<a class="jxr_linenumber" name="L267" href="#L267">267</a> } +<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"javascript"</span>.equals( language ) ) +<a class="jxr_linenumber" name="L269" href="#L269">269</a> { +<a class="jxr_linenumber" name="L270" href="#L270">270</a> cpdLanguage = <strong class="jxr_keyword">new</strong> EcmascriptLanguage(); +<a class="jxr_linenumber" name="L271" href="#L271">271</a> } +<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"jsp"</span>.equals( language ) ) +<a class="jxr_linenumber" name="L273" href="#L273">273</a> { +<a class="jxr_linenumber" name="L274" href="#L274">274</a> cpdLanguage = <strong class="jxr_keyword">new</strong> JSPLanguage(); +<a class="jxr_linenumber" name="L275" href="#L275">275</a> } +<a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="L277" href="#L277">277</a> { +<a class="jxr_linenumber" name="L278" href="#L278">278</a> cpdLanguage = LanguageFactory.createLanguage( language, p ); +<a class="jxr_linenumber" name="L279" href="#L279">279</a> } +<a class="jxr_linenumber" name="L280" href="#L280">280</a> +<a class="jxr_linenumber" name="L281" href="#L281">281</a> CPDConfiguration cpdConfiguration = <strong class="jxr_keyword">new</strong> CPDConfiguration(); +<a class="jxr_linenumber" name="L282" href="#L282">282</a> cpdConfiguration.setMinimumTileSize( minimumTokens ); +<a class="jxr_linenumber" name="L283" href="#L283">283</a> cpdConfiguration.setLanguage( cpdLanguage ); +<a class="jxr_linenumber" name="L284" href="#L284">284</a> cpdConfiguration.setSourceEncoding( encoding ); +<a class="jxr_linenumber" name="L285" href="#L285">285</a> +<a class="jxr_linenumber" name="L286" href="#L286">286</a> cpd = <strong class="jxr_keyword">new</strong> CPD( cpdConfiguration ); +<a class="jxr_linenumber" name="L287" href="#L287">287</a> +<a class="jxr_linenumber" name="L288" href="#L288">288</a> <strong class="jxr_keyword">for</strong> ( File file : filesToProcess.keySet() ) +<a class="jxr_linenumber" name="L289" href="#L289">289</a> { +<a class="jxr_linenumber" name="L290" href="#L290">290</a> cpd.add( file ); +<a class="jxr_linenumber" name="L291" href="#L291">291</a> } +<a class="jxr_linenumber" name="L292" href="#L292">292</a> } +<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">catch</strong> ( UnsupportedEncodingException e ) +<a class="jxr_linenumber" name="L294" href="#L294">294</a> { +<a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Encoding '"</span> + getSourceEncoding() + <span class="jxr_string">"' is not supported."</span>, e ); +<a class="jxr_linenumber" name="L296" href="#L296">296</a> } +<a class="jxr_linenumber" name="L297" href="#L297">297</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) +<a class="jxr_linenumber" name="L298" href="#L298">298</a> { +<a class="jxr_linenumber" name="L299" href="#L299">299</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e ); +<a class="jxr_linenumber" name="L300" href="#L300">300</a> } +<a class="jxr_linenumber" name="L301" href="#L301">301</a> getLog().debug( <span class="jxr_string">"Executing CPD..."</span> ); +<a class="jxr_linenumber" name="L302" href="#L302">302</a> cpd.go(); +<a class="jxr_linenumber" name="L303" href="#L303">303</a> getLog().debug( <span class="jxr_string">"CPD finished."</span> ); +<a class="jxr_linenumber" name="L304" href="#L304">304</a> +<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_comment">// if format is XML, we need to output it even if the file list is empty or we have no duplications</em> +<a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_comment">// so the "check" goals can check for violations</em> +<a class="jxr_linenumber" name="L307" href="#L307">307</a> <strong class="jxr_keyword">if</strong> ( isXml() ) +<a class="jxr_linenumber" name="L308" href="#L308">308</a> { +<a class="jxr_linenumber" name="L309" href="#L309">309</a> writeNonHtml( cpd ); +<a class="jxr_linenumber" name="L310" href="#L310">310</a> } +<a class="jxr_linenumber" name="L311" href="#L311">311</a> } +<a class="jxr_linenumber" name="L312" href="#L312">312</a> +<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">private</strong> Iterator<Match> filterMatches( Iterator<Match> matches ) +<a class="jxr_linenumber" name="L314" href="#L314">314</a> { +<a class="jxr_linenumber" name="L315" href="#L315">315</a> getLog().debug( <span class="jxr_string">"Filtering duplications. Using "</span> + excludeDuplicationsFromFile.countExclusions() +<a class="jxr_linenumber" name="L316" href="#L316">316</a> + <span class="jxr_string">" configured exclusions."</span> ); +<a class="jxr_linenumber" name="L317" href="#L317">317</a> +<a class="jxr_linenumber" name="L318" href="#L318">318</a> List<Match> filteredMatches = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L319" href="#L319">319</a> <strong class="jxr_keyword">int</strong> excludedDuplications = 0; +<a class="jxr_linenumber" name="L320" href="#L320">320</a> <strong class="jxr_keyword">while</strong> ( matches.hasNext() ) +<a class="jxr_linenumber" name="L321" href="#L321">321</a> { +<a class="jxr_linenumber" name="L322" href="#L322">322</a> Match match = matches.next(); +<a class="jxr_linenumber" name="L323" href="#L323">323</a> <strong class="jxr_keyword">if</strong> ( excludeDuplicationsFromFile.isExcludedFromFailure( match ) ) +<a class="jxr_linenumber" name="L324" href="#L324">324</a> { +<a class="jxr_linenumber" name="L325" href="#L325">325</a> excludedDuplications++; +<a class="jxr_linenumber" name="L326" href="#L326">326</a> } +<a class="jxr_linenumber" name="L327" href="#L327">327</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="L328" href="#L328">328</a> { +<a class="jxr_linenumber" name="L329" href="#L329">329</a> filteredMatches.add( match ); +<a class="jxr_linenumber" name="L330" href="#L330">330</a> } +<a class="jxr_linenumber" name="L331" href="#L331">331</a> } +<a class="jxr_linenumber" name="L332" href="#L332">332</a> +<a class="jxr_linenumber" name="L333" href="#L333">333</a> getLog().debug( <span class="jxr_string">"Excluded "</span> + excludedDuplications + <span class="jxr_string">" duplications."</span> ); +<a class="jxr_linenumber" name="L334" href="#L334">334</a> <strong class="jxr_keyword">return</strong> filteredMatches.iterator(); +<a class="jxr_linenumber" name="L335" href="#L335">335</a> } +<a class="jxr_linenumber" name="L336" href="#L336">336</a> +<a class="jxr_linenumber" name="L337" href="#L337">337</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> generateReport( Locale locale ) +<a class="jxr_linenumber" name="L338" href="#L338">338</a> { +<a class="jxr_linenumber" name="L339" href="#L339">339</a> <a href="../../../../../org/apache/maven/plugins/pmd/CpdReportGenerator.html">CpdReportGenerator</a> gen = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugins/pmd/CpdReportGenerator.html">CpdReportGenerator</a>( getSink(), filesToProcess, getBundle( locale ), aggregate ); +<a class="jxr_linenumber" name="L340" href="#L340">340</a> Iterator<Match> matches = cpd.getMatches(); +<a class="jxr_linenumber" name="L341" href="#L341">341</a> gen.generate( filterMatches( matches ) ); +<a class="jxr_linenumber" name="L342" href="#L342">342</a> } +<a class="jxr_linenumber" name="L343" href="#L343">343</a> +<a class="jxr_linenumber" name="L344" href="#L344">344</a> <strong class="jxr_keyword">private</strong> String determineEncoding( <strong class="jxr_keyword">boolean</strong> showWarn ) +<a class="jxr_linenumber" name="L345" href="#L345">345</a> <strong class="jxr_keyword">throws</strong> UnsupportedEncodingException +<a class="jxr_linenumber" name="L346" href="#L346">346</a> { +<a class="jxr_linenumber" name="L347" href="#L347">347</a> String encoding = WriterFactory.FILE_ENCODING; +<a class="jxr_linenumber" name="L348" href="#L348">348</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isNotEmpty( getSourceEncoding() ) ) +<a class="jxr_linenumber" name="L349" href="#L349">349</a> { +<a class="jxr_linenumber" name="L350" href="#L350">350</a> +<a class="jxr_linenumber" name="L351" href="#L351">351</a> encoding = getSourceEncoding(); +<a class="jxr_linenumber" name="L352" href="#L352">352</a> <em class="jxr_comment">// test encoding as CPD will convert exception into a RuntimeException</em> +<a class="jxr_linenumber" name="L353" href="#L353">353</a> WriterFactory.newWriter( <strong class="jxr_keyword">new</strong> ByteArrayOutputStream(), encoding ); +<a class="jxr_linenumber" name="L354" href="#L354">354</a> +<a class="jxr_linenumber" name="L355" href="#L355">355</a> } +<a class="jxr_linenumber" name="L356" href="#L356">356</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( showWarn ) +<a class="jxr_linenumber" name="L357" href="#L357">357</a> { +<a class="jxr_linenumber" name="L358" href="#L358">358</a> getLog().warn( <span class="jxr_string">"File encoding has not been set, using platform encoding "</span> + WriterFactory.FILE_ENCODING +<a class="jxr_linenumber" name="L359" href="#L359">359</a> + <span class="jxr_string">", i.e. build is platform dependent!"</span> ); +<a class="jxr_linenumber" name="L360" href="#L360">360</a> encoding = WriterFactory.FILE_ENCODING; +<a class="jxr_linenumber" name="L361" href="#L361">361</a> } +<a class="jxr_linenumber" name="L362" href="#L362">362</a> <strong class="jxr_keyword">return</strong> encoding; +<a class="jxr_linenumber" name="L363" href="#L363">363</a> } +<a class="jxr_linenumber" name="L364" href="#L364">364</a> +<a class="jxr_linenumber" name="L365" href="#L365">365</a> <strong class="jxr_keyword">void</strong> writeNonHtml( CPD cpd ) +<a class="jxr_linenumber" name="L366" href="#L366">366</a> <strong class="jxr_keyword">throws</strong> MavenReportException +<a class="jxr_linenumber" name="L367" href="#L367">367</a> { +<a class="jxr_linenumber" name="L368" href="#L368">368</a> Renderer r = createRenderer(); +<a class="jxr_linenumber" name="L369" href="#L369">369</a> +<a class="jxr_linenumber" name="L370" href="#L370">370</a> <strong class="jxr_keyword">if</strong> ( r == <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L371" href="#L371">371</a> { +<a class="jxr_linenumber" name="L372" href="#L372">372</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L373" href="#L373">373</a> } +<a class="jxr_linenumber" name="L374" href="#L374">374</a> +<a class="jxr_linenumber" name="L375" href="#L375">375</a> String buffer = r.render( filterMatches( cpd.getMatches() ) ); +<a class="jxr_linenumber" name="L376" href="#L376">376</a> File targetFile = <strong class="jxr_keyword">new</strong> File( targetDirectory, <span class="jxr_string">"cpd."</span> + format ); +<a class="jxr_linenumber" name="L377" href="#L377">377</a> targetDirectory.mkdirs(); +<a class="jxr_linenumber" name="L378" href="#L378">378</a> <strong class="jxr_keyword">try</strong> ( Writer writer = <strong class="jxr_keyword">new</strong> OutputStreamWriter( <strong class="jxr_keyword">new</strong> FileOutputStream( targetFile ), getOutputEncoding() ) ) +<a class="jxr_linenumber" name="L379" href="#L379">379</a> { +<a class="jxr_linenumber" name="L380" href="#L380">380</a> writer.write( buffer ); +<a class="jxr_linenumber" name="L381" href="#L381">381</a> writer.flush(); +<a class="jxr_linenumber" name="L382" href="#L382">382</a> +<a class="jxr_linenumber" name="L383" href="#L383">383</a> <strong class="jxr_keyword">if</strong> ( includeXmlInSite ) +<a class="jxr_linenumber" name="L384" href="#L384">384</a> { +<a class="jxr_linenumber" name="L385" href="#L385">385</a> File siteDir = getReportOutputDirectory(); +<a class="jxr_linenumber" name="L386" href="#L386">386</a> siteDir.mkdirs(); +<a class="jxr_linenumber" name="L387" href="#L387">387</a> FileUtils.copyFile( targetFile, <strong class="jxr_keyword">new</strong> File( siteDir, <span class="jxr_string">"cpd."</span> + format ) ); +<a class="jxr_linenumber" name="L388" href="#L388">388</a> } +<a class="jxr_linenumber" name="L389" href="#L389">389</a> } +<a class="jxr_linenumber" name="L390" href="#L390">390</a> <strong class="jxr_keyword">catch</strong> ( IOException ioe ) +<a class="jxr_linenumber" name="L391" href="#L391">391</a> { +<a class="jxr_linenumber" name="L392" href="#L392">392</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( ioe.getMessage(), ioe ); +<a class="jxr_linenumber" name="L393" href="#L393">393</a> } +<a class="jxr_linenumber" name="L394" href="#L394">394</a> } +<a class="jxr_linenumber" name="L395" href="#L395">395</a> +<a class="jxr_linenumber" name="L396" href="#L396">396</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L397" href="#L397">397</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L398" href="#L398">398</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L399" href="#L399">399</a> <strong class="jxr_keyword">public</strong> String getOutputName() +<a class="jxr_linenumber" name="L400" href="#L400">400</a> { +<a class="jxr_linenumber" name="L401" href="#L401">401</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"cpd"</span>; +<a class="jxr_linenumber" name="L402" href="#L402">402</a> } +<a class="jxr_linenumber" name="L403" href="#L403">403</a> +<a class="jxr_linenumber" name="L404" href="#L404">404</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> ResourceBundle getBundle( Locale locale ) +<a class="jxr_linenumber" name="L405" href="#L405">405</a> { +<a class="jxr_linenumber" name="L406" href="#L406">406</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="L407" href="#L407">407</a> } +<a class="jxr_linenumber" name="L408" href="#L408">408</a> +<a class="jxr_linenumber" name="L409" href="#L409">409</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L410" href="#L410">410</a> <em class="jxr_javadoccomment"> * Create and return the correct renderer for the output type.</em> +<a class="jxr_linenumber" name="L411" href="#L411">411</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L412" href="#L412">412</a> <em class="jxr_javadoccomment"> * @return the renderer based on the configured output</em> +<a class="jxr_linenumber" name="L413" href="#L413">413</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="L414" href="#L414">414</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L415" href="#L415">415</a> <strong class="jxr_keyword">public</strong> Renderer createRenderer() +<a class="jxr_linenumber" name="L416" href="#L416">416</a> <strong class="jxr_keyword">throws</strong> MavenReportException +<a class="jxr_linenumber" name="L417" href="#L417">417</a> { +<a class="jxr_linenumber" name="L418" href="#L418">418</a> Renderer renderer = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L419" href="#L419">419</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"xml"</span>.equals( format ) ) +<a class="jxr_linenumber" name="L420" href="#L420">420</a> { +<a class="jxr_linenumber" name="L421" href="#L421">421</a> renderer = <strong class="jxr_keyword">new</strong> XMLRenderer( getOutputEncoding() ); +<a class="jxr_linenumber" name="L422" href="#L422">422</a> } +<a class="jxr_linenumber" name="L423" href="#L423">423</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"csv"</span>.equals( format ) ) +<a class="jxr_linenumber" name="L424" href="#L424">424</a> { +<a class="jxr_linenumber" name="L425" href="#L425">425</a> renderer = <strong class="jxr_keyword">new</strong> CSVRenderer(); +<a class="jxr_linenumber" name="L426" href="#L426">426</a> } +<a class="jxr_linenumber" name="L427" href="#L427">427</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( !<span class="jxr_string">""</span>.equals( format ) && !<span class="jxr_string">"none"</span>.equals( format ) ) +<a class="jxr_linenumber" name="L428" href="#L428">428</a> { +<a class="jxr_linenumber" name="L429" href="#L429">429</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L430" href="#L430">430</a> { +<a class="jxr_linenumber" name="L431" href="#L431">431</a> renderer = (Renderer) Class.forName( format ).newInstance(); +<a class="jxr_linenumber" name="L432" href="#L432">432</a> } +<a class="jxr_linenumber" name="L433" href="#L433">433</a> <strong class="jxr_keyword">catch</strong> ( Exception e ) +<a class="jxr_linenumber" name="L434" href="#L434">434</a> { +<a class="jxr_linenumber" name="L435" href="#L435">435</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Can't find CPD custom format "</span> + format + <span class="jxr_string">": "</span> +<a class="jxr_linenumber" name="L436" href="#L436">436</a> + e.getClass().getName(), e ); +<a class="jxr_linenumber" name="L437" href="#L437">437</a> } +<a class="jxr_linenumber" name="L438" href="#L438">438</a> } +<a class="jxr_linenumber" name="L439" href="#L439">439</a> +<a class="jxr_linenumber" name="L440" href="#L440">440</a> <strong class="jxr_keyword">return</strong> renderer; +<a class="jxr_linenumber" name="L441" href="#L441">441</a> } +<a class="jxr_linenumber" name="L442" href="#L442">442</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/CpdReportGenerator.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdReportGenerator.html (added) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/CpdReportGenerator.html Sun Jan 21 17:23:18 2018 @@ -0,0 +1,231 @@ +<!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>CpdReportGenerator xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/pmd/CpdReportGenerator.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.util.Iterator; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.Map; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.ResourceBundle; +<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> net.sourceforge.pmd.cpd.Mark; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.cpd.Match; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.cpd.TokenEntry; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.Sink; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * Class that generated the CPD report.</em> +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * @author mperham</em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * @version $Id$</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/pmd/CpdReportGenerator.html">CpdReportGenerator</a> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> { +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">private</strong> Sink sink; +<a class="jxr_linenumber" name="L44" href="#L44">44</a> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">private</strong> Map<File, PmdFileInfo> fileMap; +<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> ResourceBundle bundle; +<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">boolean</strong> aggregate; +<a class="jxr_linenumber" name="L50" href="#L50">50</a> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/maven/plugins/pmd/CpdReportGenerator.html">CpdReportGenerator</a>( Sink sink, Map<File, PmdFileInfo> fileMap, ResourceBundle bundle, <strong class="jxr_keyword">boolean</strong> aggregate ) +<a class="jxr_linenumber" name="L52" href="#L52">52</a> { +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">this</strong>.sink = sink; +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">this</strong>.fileMap = fileMap; +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">this</strong>.bundle = bundle; +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">this</strong>.aggregate = aggregate; +<a class="jxr_linenumber" name="L57" href="#L57">57</a> } +<a class="jxr_linenumber" name="L58" href="#L58">58</a> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * Method that returns the title of the CPD Report</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * @return a String that contains the title</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">private</strong> String getTitle() +<a class="jxr_linenumber" name="L65" href="#L65">65</a> { +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">return</strong> bundle.getString( <span class="jxr_string">"report.cpd.title"</span> ); +<a class="jxr_linenumber" name="L67" href="#L67">67</a> } +<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"> * Method that generates the start of the CPD report.</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> beginDocument() +<a class="jxr_linenumber" name="L73" href="#L73">73</a> { +<a class="jxr_linenumber" name="L74" href="#L74">74</a> sink.head(); +<a class="jxr_linenumber" name="L75" href="#L75">75</a> sink.title(); +<a class="jxr_linenumber" name="L76" href="#L76">76</a> sink.text( getTitle() ); +<a class="jxr_linenumber" name="L77" href="#L77">77</a> sink.title_(); +<a class="jxr_linenumber" name="L78" href="#L78">78</a> sink.head_(); +<a class="jxr_linenumber" name="L79" href="#L79">79</a> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> sink.body(); +<a class="jxr_linenumber" name="L81" href="#L81">81</a> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> sink.section1(); +<a class="jxr_linenumber" name="L83" href="#L83">83</a> sink.sectionTitle1(); +<a class="jxr_linenumber" name="L84" href="#L84">84</a> sink.text( getTitle() ); +<a class="jxr_linenumber" name="L85" href="#L85">85</a> sink.sectionTitle1_(); +<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( bundle.getString( <span class="jxr_string">"report.cpd.cpdlink"</span> ) + <span class="jxr_string">" "</span> ); +<a class="jxr_linenumber" name="L89" href="#L89">89</a> sink.link( <span class="jxr_string">"http://pmd.sourceforge.net/cpd.html"</span> ); +<a class="jxr_linenumber" name="L90" href="#L90">90</a> sink.text( <span class="jxr_string">"CPD"</span> ); +<a class="jxr_linenumber" name="L91" href="#L91">91</a> sink.link_(); +<a class="jxr_linenumber" name="L92" href="#L92">92</a> sink.text( <span class="jxr_string">" "</span> + AbstractPmdReport.getPmdVersion() + <span class="jxr_string">"."</span> ); +<a class="jxr_linenumber" name="L93" href="#L93">93</a> sink.paragraph_(); +<a class="jxr_linenumber" name="L94" href="#L94">94</a> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> sink.section1_(); +<a class="jxr_linenumber" name="L96" href="#L96">96</a> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_comment">// TODO overall summary</em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> sink.section1(); +<a class="jxr_linenumber" name="L100" href="#L100">100</a> sink.sectionTitle1(); +<a class="jxr_linenumber" name="L101" href="#L101">101</a> sink.text( bundle.getString( <span class="jxr_string">"report.cpd.dupes"</span> ) ); +<a class="jxr_linenumber" name="L102" href="#L102">102</a> sink.sectionTitle1_(); +<a class="jxr_linenumber" name="L103" href="#L103">103</a> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_comment">// TODO files summary</em> +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * Method that generates a line of CPD report according to a TokenEntry.</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> generateFileLine( TokenEntry tokenEntry ) +<a class="jxr_linenumber" name="L111" href="#L111">111</a> { +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_comment">// Get information for report generation</em> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> String filename = tokenEntry.getTokenSrcID(); +<a class="jxr_linenumber" name="L114" href="#L114">114</a> File file = <strong class="jxr_keyword">new</strong> File( filename ); +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <a href="../../../../../org/apache/maven/plugins/pmd/PmdFileInfo.html">PmdFileInfo</a> fileInfo = fileMap.get( file ); +<a class="jxr_linenumber" name="L116" href="#L116">116</a> File sourceDirectory = fileInfo.getSourceDirectory(); +<a class="jxr_linenumber" name="L117" href="#L117">117</a> filename = StringUtils.substring( filename, sourceDirectory.getAbsolutePath().length() + 1 ); +<a class="jxr_linenumber" name="L118" href="#L118">118</a> String xrefLocation = fileInfo.getXrefLocation(); +<a class="jxr_linenumber" name="L119" href="#L119">119</a> MavenProject projectFile = fileInfo.getProject(); +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">int</strong> line = tokenEntry.getBeginLine(); +<a class="jxr_linenumber" name="L121" href="#L121">121</a> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> sink.tableRow(); +<a class="jxr_linenumber" name="L123" href="#L123">123</a> sink.tableCell(); +<a class="jxr_linenumber" name="L124" href="#L124">124</a> sink.text( filename ); +<a class="jxr_linenumber" name="L125" href="#L125">125</a> sink.tableCell_(); +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">if</strong> ( aggregate ) +<a class="jxr_linenumber" name="L127" href="#L127">127</a> { +<a class="jxr_linenumber" name="L128" href="#L128">128</a> sink.tableCell(); +<a class="jxr_linenumber" name="L129" href="#L129">129</a> sink.text( projectFile.getName() ); +<a class="jxr_linenumber" name="L130" href="#L130">130</a> sink.tableCell_(); +<a class="jxr_linenumber" name="L131" href="#L131">131</a> } +<a class="jxr_linenumber" name="L132" href="#L132">132</a> sink.tableCell(); +<a class="jxr_linenumber" name="L133" href="#L133">133</a> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">if</strong> ( xrefLocation != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L135" href="#L135">135</a> { +<a class="jxr_linenumber" name="L136" href="#L136">136</a> sink.link( xrefLocation + <span class="jxr_string">"/"</span> + filename.replaceAll( <span class="jxr_string">"\\.java$"</span>, <span class="jxr_string">".html"</span> ).replace( '\\', '/' ) + <span class="jxr_string">"#L"</span> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> + line ); +<a class="jxr_linenumber" name="L138" href="#L138">138</a> } +<a class="jxr_linenumber" name="L139" href="#L139">139</a> sink.text( String.valueOf( line ) ); +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">if</strong> ( xrefLocation != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L141" href="#L141">141</a> { +<a class="jxr_linenumber" name="L142" href="#L142">142</a> sink.link_(); +<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> sink.tableCell_(); +<a class="jxr_linenumber" name="L146" href="#L146">146</a> sink.tableRow_(); +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * Method that generates the contents of the CPD report</em> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * @param matches the found duplications</em> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> generate( Iterator<Match> matches ) +<a class="jxr_linenumber" name="L155" href="#L155">155</a> { +<a class="jxr_linenumber" name="L156" href="#L156">156</a> beginDocument(); +<a class="jxr_linenumber" name="L157" href="#L157">157</a> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">if</strong> ( !matches.hasNext() ) +<a class="jxr_linenumber" name="L159" href="#L159">159</a> { +<a class="jxr_linenumber" name="L160" href="#L160">160</a> sink.paragraph(); +<a class="jxr_linenumber" name="L161" href="#L161">161</a> sink.text( bundle.getString( <span class="jxr_string">"report.cpd.noProblems"</span> ) ); +<a class="jxr_linenumber" name="L162" href="#L162">162</a> sink.paragraph_(); +<a class="jxr_linenumber" name="L163" href="#L163">163</a> } +<a class="jxr_linenumber" name="L164" href="#L164">164</a> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">while</strong> ( matches.hasNext() ) +<a class="jxr_linenumber" name="L166" href="#L166">166</a> { +<a class="jxr_linenumber" name="L167" href="#L167">167</a> Match match = matches.next(); +<a class="jxr_linenumber" name="L168" href="#L168">168</a> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> String code = match.getSourceCodeSlice(); +<a class="jxr_linenumber" name="L170" href="#L170">170</a> +<a class="jxr_linenumber" name="L171" href="#L171">171</a> sink.table(); +<a class="jxr_linenumber" name="L172" href="#L172">172</a> sink.tableRow(); +<a class="jxr_linenumber" name="L173" href="#L173">173</a> sink.tableHeaderCell(); +<a class="jxr_linenumber" name="L174" href="#L174">174</a> sink.text( bundle.getString( <span class="jxr_string">"report.cpd.column.file"</span> ) ); +<a class="jxr_linenumber" name="L175" href="#L175">175</a> sink.tableHeaderCell_(); +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">if</strong> ( aggregate ) +<a class="jxr_linenumber" name="L177" href="#L177">177</a> { +<a class="jxr_linenumber" name="L178" href="#L178">178</a> sink.tableHeaderCell(); +<a class="jxr_linenumber" name="L179" href="#L179">179</a> sink.text( bundle.getString( <span class="jxr_string">"report.cpd.column.project"</span> ) ); +<a class="jxr_linenumber" name="L180" href="#L180">180</a> sink.tableHeaderCell_(); +<a class="jxr_linenumber" name="L181" href="#L181">181</a> } +<a class="jxr_linenumber" name="L182" href="#L182">182</a> sink.tableHeaderCell(); +<a class="jxr_linenumber" name="L183" href="#L183">183</a> sink.text( bundle.getString( <span class="jxr_string">"report.cpd.column.line"</span> ) ); +<a class="jxr_linenumber" name="L184" href="#L184">184</a> sink.tableHeaderCell_(); +<a class="jxr_linenumber" name="L185" href="#L185">185</a> sink.tableRow_(); +<a class="jxr_linenumber" name="L186" href="#L186">186</a> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_comment">// Iterating on every token entry</em> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">for</strong> ( Iterator<Mark> occurrences = match.iterator(); occurrences.hasNext(); ) +<a class="jxr_linenumber" name="L189" href="#L189">189</a> { +<a class="jxr_linenumber" name="L190" href="#L190">190</a> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> TokenEntry mark = occurrences.next().getToken(); +<a class="jxr_linenumber" name="L192" href="#L192">192</a> generateFileLine( mark ); +<a class="jxr_linenumber" name="L193" href="#L193">193</a> } +<a class="jxr_linenumber" name="L194" href="#L194">194</a> +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_comment">// Source snippet</em> +<a class="jxr_linenumber" name="L196" href="#L196">196</a> sink.tableRow(); +<a class="jxr_linenumber" name="L197" href="#L197">197</a> +<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">int</strong> colspan = 2; +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">if</strong> ( aggregate ) +<a class="jxr_linenumber" name="L200" href="#L200">200</a> { +<a class="jxr_linenumber" name="L201" href="#L201">201</a> ++colspan; +<a class="jxr_linenumber" name="L202" href="#L202">202</a> } +<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_comment">// TODO Cleaner way to do this?</em> +<a class="jxr_linenumber" name="L204" href="#L204">204</a> sink.rawText( <span class="jxr_string">"<td colspan='"</span> + colspan + <span class="jxr_string">"'>"</span> ); +<a class="jxr_linenumber" name="L205" href="#L205">205</a> sink.verbatim( <strong class="jxr_keyword">null</strong> ); +<a class="jxr_linenumber" name="L206" href="#L206">206</a> sink.text( code ); +<a class="jxr_linenumber" name="L207" href="#L207">207</a> sink.verbatim_(); +<a class="jxr_linenumber" name="L208" href="#L208">208</a> sink.rawText( <span class="jxr_string">"</td>"</span> ); +<a class="jxr_linenumber" name="L209" href="#L209">209</a> sink.tableRow_(); +<a class="jxr_linenumber" name="L210" href="#L210">210</a> sink.table_(); +<a class="jxr_linenumber" name="L211" href="#L211">211</a> } +<a class="jxr_linenumber" name="L212" href="#L212">212</a> +<a class="jxr_linenumber" name="L213" href="#L213">213</a> sink.section1_(); +<a class="jxr_linenumber" name="L214" href="#L214">214</a> sink.body_(); +<a class="jxr_linenumber" name="L215" href="#L215">215</a> sink.flush(); +<a class="jxr_linenumber" name="L216" href="#L216">216</a> sink.close(); +<a class="jxr_linenumber" name="L217" href="#L217">217</a> } +<a class="jxr_linenumber" name="L218" href="#L218">218</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