Added: websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/AbstractPmdReport.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/AbstractPmdReport.html (added) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/AbstractPmdReport.html Sun Jan 21 17:23:18 2018 @@ -0,0 +1,594 @@ +<!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>AbstractPmdReport xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/pmd/AbstractPmdReport.html">View Javadoc</a></div><pre> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.pmd; +<a class="jxr_linenumber" name="L2" href="#L2">2</a> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2."; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> +<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> * under the License.</em> +<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.File; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.Collection; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.Collections; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.HashSet; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.LinkedHashSet; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.util.Map; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.util.TreeMap; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.util.logging.Level; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> java.util.logging.Logger; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> java.util.logging.SimpleFormatter; +<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.PMD; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.Renderer; +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.ReportPlugin; +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component; +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.AbstractMavenReport; +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.FileUtils; +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.PathTool; +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory; +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">import</strong> org.slf4j.bridge.SLF4JBridgeHandler; +<a class="jxr_linenumber" name="L49" href="#L49">49</a> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * Base class for the PMD reports.</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:br...@apache.org"; target="alexandria_uri">mailto:br...@apache.org</a>">Brett Porter</a></em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * @version $Id$</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html">AbstractPmdReport</a> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">extends</strong> AbstractMavenReport +<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"> * The output directory for the intermediate XML 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> @Parameter( property = <span class="jxr_string">"project.build.directory"</span>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">protected</strong> File targetDirectory; +<a class="jxr_linenumber" name="L64" href="#L64">64</a> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * The output directory for the final HTML report. Note that this parameter is only evaluated if the goal is run</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * directly from the command line or during the default lifecycle. If the goal is run indirectly as part of a site</em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * generation, the output directory configured in the Maven Site Plugin is used instead.</em> +<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> @Parameter( property = <span class="jxr_string">"project.reporting.outputDirectory"</span>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">protected</strong> File outputDirectory; +<a class="jxr_linenumber" name="L72" href="#L72">72</a> +<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"> * Site rendering component for generating the HTML report.</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> @Component +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">private</strong> Renderer siteRenderer; +<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 project to analyse.</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( defaultValue = <span class="jxr_string">"${project}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">protected</strong> MavenProject project; +<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"> * Set the output format type, in addition to the HTML report. Must be one of: "none", "csv", "xml", "txt" or the</em> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * full class name of the PMD renderer to use. See the net.sourceforge.pmd.renderers package javadoc for available</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * renderers. XML is required if the pmd:check goal is being used.</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">"format"</span>, defaultValue = <span class="jxr_string">"xml"</span> ) +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">protected</strong> String format = <span class="jxr_string">"xml"</span>; +<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"> * Link the violation line numbers to the source xref. Links will be created automatically if the jxr plugin is</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * being used.</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">"linkXRef"</span>, defaultValue = <span class="jxr_string">"true"</span> ) +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> linkXRef; +<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"> * Location of the Xrefs to link to.</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> @Parameter( defaultValue = <span class="jxr_string">"${project.reporting.outputDirectory}/xref"</span> ) +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">private</strong> File xrefLocation; +<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"> * Location of the Test Xrefs to link to.</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> @Parameter( defaultValue = <span class="jxr_string">"${project.reporting.outputDirectory}/xref-test"</span> ) +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">private</strong> File xrefTestLocation; +<a class="jxr_linenumber" name="L111" href="#L111">111</a> +<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> <em class="jxr_javadoccomment"> * A list of files to exclude from checking. Can contain Ant-style wildcards and double wildcards. Note that these</em> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * exclusion patterns only operate on the path of a source file relative to its source root directory. In other</em> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * words, files are excluded based on their package and/or class name. If you want to exclude entire source root</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * directories, use the parameter <code>excludeRoots</code> instead.</em> +<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"> * @since 2.2</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> @Parameter +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">private</strong> List<String> excludes; +<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"> * A list of files to include from checking. Can contain Ant-style wildcards and double wildcards. Defaults to</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * **\/*.java.</em> +<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"> * @since 2.2</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> @Parameter +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">private</strong> List<String> includes; +<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"> * Specifies the location of the source directories to be used for PMD.</em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * Defaults to <code>project.compileSourceRoots</code>.</em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * @since 3.7</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> @Parameter( defaultValue = <span class="jxr_string">"${project.compileSourceRoots}"</span> ) +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">private</strong> List<String> compileSourceRoots; +<a class="jxr_linenumber" name="L139" href="#L139">139</a> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * The directories containing the test-sources to be used for PMD.</em> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * Defaults to <code>project.testCompileSourceRoots</code></em> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * @since 3.7</em> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> @Parameter( defaultValue = <span class="jxr_string">"${project.testCompileSourceRoots}"</span> ) +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">private</strong> List<String> testSourceRoots; +<a class="jxr_linenumber" name="L147" href="#L147">147</a> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * The project source directories that should be excluded.</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * @since 2.2</em> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> @Parameter +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">private</strong> File[] excludeRoots; +<a class="jxr_linenumber" name="L155" href="#L155">155</a> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * Run PMD on the tests.</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * @since 2.2</em> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> @Parameter( defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> includeTests; +<a class="jxr_linenumber" name="L163" href="#L163">163</a> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * Whether to build an aggregated report at the root, or build individual reports.</em> +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * @since 2.2</em> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> @Parameter( property = <span class="jxr_string">"aggregate"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> aggregate; +<a class="jxr_linenumber" name="L171" href="#L171">171</a> +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * The file encoding to use when reading the Java sources.</em> +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * @since 2.3</em> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> @Parameter( property = <span class="jxr_string">"encoding"</span>, defaultValue = <span class="jxr_string">"${project.build.sourceEncoding}"</span> ) +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">private</strong> String sourceEncoding; +<a class="jxr_linenumber" name="L179" href="#L179">179</a> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * The file encoding when writing non-HTML reports.</em> +<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * @since 2.5</em> +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L185" href="#L185">185</a> @Parameter( property = <span class="jxr_string">"outputEncoding"</span>, defaultValue = <span class="jxr_string">"${project.reporting.outputEncoding}"</span> ) +<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">private</strong> String outputEncoding; +<a class="jxr_linenumber" name="L187" href="#L187">187</a> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * The projects in the reactor for aggregation report.</em> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> @Parameter( property = <span class="jxr_string">"reactorProjects"</span>, readonly = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">protected</strong> List<MavenProject> reactorProjects; +<a class="jxr_linenumber" name="L193" href="#L193">193</a> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * Whether to include the xml files generated by PMD/CPD in the site.</em> +<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * @since 3.0</em> +<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L199" href="#L199">199</a> @Parameter( defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> includeXmlInSite; +<a class="jxr_linenumber" name="L201" href="#L201">201</a> +<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * Skip the PMD/CPD report generation if there are no violations or duplications found. Defaults to</em> +<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * <code>true</code>.</em> +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * @since 3.1</em> +<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L208" href="#L208">208</a> @Parameter( defaultValue = <span class="jxr_string">"true"</span> ) +<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> skipEmptyReport; +<a class="jxr_linenumber" name="L210" href="#L210">210</a> +<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> * File that lists classes and rules to be excluded from failures.</em> +<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * For PMD, this is a properties file. For CPD, this</em> +<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * is a text file that contains comma-separated lists of classes</em> +<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * that are allowed to duplicate.</em> +<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * @since 3.7</em> +<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L219" href="#L219">219</a> @Parameter( property = <span class="jxr_string">"pmd.excludeFromFailureFile"</span>, defaultValue = <span class="jxr_string">""</span> ) +<a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">protected</strong> String excludeFromFailureFile; +<a class="jxr_linenumber" name="L221" href="#L221">221</a> +<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> * Redirect PMD log into maven log out.</em> +<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> * When enabled, the PMD log output is redirected to maven, so that</em> +<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment"> * it is visible in the console together with all the other log output.</em> +<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment"> * Also, if maven is started with the debug flag (<code>-X</code> or <code>--debug</code>),</em> +<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> * the PMD logger is also configured for debug.</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> <em class="jxr_javadoccomment"> * @since 3.9.0</em> +<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L231" href="#L231">231</a> @Parameter( defaultValue = <span class="jxr_string">"true"</span>, property = <span class="jxr_string">"pmd.showPmdLog"</span> ) +<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> showPmdLog = <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L233" href="#L233">233</a> +<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment">/** The files that are being analyzed. */</em> +<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">protected</strong> Map<File, PmdFileInfo> filesToProcess; +<a class="jxr_linenumber" name="L236" href="#L236">236</a> +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</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> @Override +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">protected</strong> MavenProject getProject() +<a class="jxr_linenumber" name="L242" href="#L242">242</a> { +<a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">return</strong> project; +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L249" href="#L249">249</a> @Override +<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">protected</strong> Renderer getSiteRenderer() +<a class="jxr_linenumber" name="L251" href="#L251">251</a> { +<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">return</strong> siteRenderer; +<a class="jxr_linenumber" name="L253" href="#L253">253</a> } +<a class="jxr_linenumber" name="L254" href="#L254">254</a> +<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">protected</strong> String constructXRefLocation( <strong class="jxr_keyword">boolean</strong> test ) +<a class="jxr_linenumber" name="L256" href="#L256">256</a> { +<a class="jxr_linenumber" name="L257" href="#L257">257</a> String location = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">if</strong> ( linkXRef ) +<a class="jxr_linenumber" name="L259" href="#L259">259</a> { +<a class="jxr_linenumber" name="L260" href="#L260">260</a> File xrefLoc = test ? xrefTestLocation : xrefLocation; +<a class="jxr_linenumber" name="L261" href="#L261">261</a> +<a class="jxr_linenumber" name="L262" href="#L262">262</a> String relativePath = +<a class="jxr_linenumber" name="L263" href="#L263">263</a> PathTool.getRelativePath( outputDirectory.getAbsolutePath(), xrefLoc.getAbsolutePath() ); +<a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( relativePath ) ) +<a class="jxr_linenumber" name="L265" href="#L265">265</a> { +<a class="jxr_linenumber" name="L266" href="#L266">266</a> relativePath = <span class="jxr_string">"."</span>; +<a class="jxr_linenumber" name="L267" href="#L267">267</a> } +<a class="jxr_linenumber" name="L268" href="#L268">268</a> relativePath = relativePath + <span class="jxr_string">"/"</span> + xrefLoc.getName(); +<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">if</strong> ( xrefLoc.exists() ) +<a class="jxr_linenumber" name="L270" href="#L270">270</a> { +<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_comment">// XRef was already generated by manual execution of a lifecycle binding</em> +<a class="jxr_linenumber" name="L272" href="#L272">272</a> location = relativePath; +<a class="jxr_linenumber" name="L273" href="#L273">273</a> } +<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="L275" href="#L275">275</a> { +<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_comment">// Not yet generated - check if the report is on its way</em> +<a class="jxr_linenumber" name="L277" href="#L277">277</a> List<ReportPlugin> reportPlugins = project.getReportPlugins(); +<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">for</strong> ( ReportPlugin plugin : reportPlugins ) +<a class="jxr_linenumber" name="L279" href="#L279">279</a> { +<a class="jxr_linenumber" name="L280" href="#L280">280</a> String artifactId = plugin.getArtifactId(); +<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"maven-jxr-plugin"</span>.equals( artifactId ) || <span class="jxr_string">"jxr-maven-plugin"</span>.equals( artifactId ) ) +<a class="jxr_linenumber" name="L282" href="#L282">282</a> { +<a class="jxr_linenumber" name="L283" href="#L283">283</a> location = relativePath; +<a class="jxr_linenumber" name="L284" href="#L284">284</a> } +<a class="jxr_linenumber" name="L285" href="#L285">285</a> } +<a class="jxr_linenumber" name="L286" href="#L286">286</a> } +<a class="jxr_linenumber" name="L287" href="#L287">287</a> +<a class="jxr_linenumber" name="L288" href="#L288">288</a> <strong class="jxr_keyword">if</strong> ( location == <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L289" href="#L289">289</a> { +<a class="jxr_linenumber" name="L290" href="#L290">290</a> getLog().warn( <span class="jxr_string">"Unable to locate Source XRef to link to - DISABLED"</span> ); +<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">return</strong> location; +<a class="jxr_linenumber" name="L294" href="#L294">294</a> } +<a class="jxr_linenumber" name="L295" href="#L295">295</a> +<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> * Convenience method to get the list of files where the PMD tool will be executed</em> +<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment"> * @return a List of the files where the PMD tool will be executed</em> +<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> * @throws IOException If an I/O error occurs during construction of the</em> +<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment"> * canonical pathnames of the files</em> +<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">protected</strong> Map<File, PmdFileInfo> getFilesToProcess() +<a class="jxr_linenumber" name="L304" href="#L304">304</a> <strong class="jxr_keyword">throws</strong> IOException +<a class="jxr_linenumber" name="L305" href="#L305">305</a> { +<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong class="jxr_keyword">if</strong> ( aggregate && !project.isExecutionRoot() ) +<a class="jxr_linenumber" name="L307" href="#L307">307</a> { +<a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong class="jxr_keyword">return</strong> Collections.emptyMap(); +<a class="jxr_linenumber" name="L309" href="#L309">309</a> } +<a class="jxr_linenumber" name="L310" href="#L310">310</a> +<a class="jxr_linenumber" name="L311" href="#L311">311</a> <strong class="jxr_keyword">if</strong> ( excludeRoots == <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L312" href="#L312">312</a> { +<a class="jxr_linenumber" name="L313" href="#L313">313</a> excludeRoots = <strong class="jxr_keyword">new</strong> File[0]; +<a class="jxr_linenumber" name="L314" href="#L314">314</a> } +<a class="jxr_linenumber" name="L315" href="#L315">315</a> +<a class="jxr_linenumber" name="L316" href="#L316">316</a> Collection<File> excludeRootFiles = <strong class="jxr_keyword">new</strong> HashSet<>( excludeRoots.length ); +<a class="jxr_linenumber" name="L317" href="#L317">317</a> +<a class="jxr_linenumber" name="L318" href="#L318">318</a> <strong class="jxr_keyword">for</strong> ( File file : excludeRoots ) +<a class="jxr_linenumber" name="L319" href="#L319">319</a> { +<a class="jxr_linenumber" name="L320" href="#L320">320</a> <strong class="jxr_keyword">if</strong> ( file.isDirectory() ) +<a class="jxr_linenumber" name="L321" href="#L321">321</a> { +<a class="jxr_linenumber" name="L322" href="#L322">322</a> excludeRootFiles.add( file ); +<a class="jxr_linenumber" name="L323" href="#L323">323</a> } +<a class="jxr_linenumber" name="L324" href="#L324">324</a> } +<a class="jxr_linenumber" name="L325" href="#L325">325</a> +<a class="jxr_linenumber" name="L326" href="#L326">326</a> List<PmdFileInfo> directories = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L327" href="#L327">327</a> +<a class="jxr_linenumber" name="L328" href="#L328">328</a> <strong class="jxr_keyword">if</strong> ( <strong class="jxr_keyword">null</strong> == compileSourceRoots ) +<a class="jxr_linenumber" name="L329" href="#L329">329</a> { +<a class="jxr_linenumber" name="L330" href="#L330">330</a> compileSourceRoots = project.getCompileSourceRoots(); +<a class="jxr_linenumber" name="L331" href="#L331">331</a> } +<a class="jxr_linenumber" name="L332" href="#L332">332</a> <strong class="jxr_keyword">if</strong> ( compileSourceRoots != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L333" href="#L333">333</a> { +<a class="jxr_linenumber" name="L334" href="#L334">334</a> <strong class="jxr_keyword">for</strong> ( String root : compileSourceRoots ) +<a class="jxr_linenumber" name="L335" href="#L335">335</a> { +<a class="jxr_linenumber" name="L336" href="#L336">336</a> File sroot = <strong class="jxr_keyword">new</strong> File( root ); +<a class="jxr_linenumber" name="L337" href="#L337">337</a> <strong class="jxr_keyword">if</strong> ( sroot.exists() ) +<a class="jxr_linenumber" name="L338" href="#L338">338</a> { +<a class="jxr_linenumber" name="L339" href="#L339">339</a> String sourceXref = constructXRefLocation( false ); +<a class="jxr_linenumber" name="L340" href="#L340">340</a> directories.add( <strong class="jxr_keyword">new</strong> PmdFileInfo( project, sroot, sourceXref ) ); +<a class="jxr_linenumber" name="L341" href="#L341">341</a> } +<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> +<a class="jxr_linenumber" name="L345" href="#L345">345</a> <strong class="jxr_keyword">if</strong> ( <strong class="jxr_keyword">null</strong> == testSourceRoots ) +<a class="jxr_linenumber" name="L346" href="#L346">346</a> { +<a class="jxr_linenumber" name="L347" href="#L347">347</a> testSourceRoots = project.getTestCompileSourceRoots(); +<a class="jxr_linenumber" name="L348" href="#L348">348</a> } +<a class="jxr_linenumber" name="L349" href="#L349">349</a> <strong class="jxr_keyword">if</strong> ( includeTests && testSourceRoots != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L350" href="#L350">350</a> { +<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">for</strong> ( String root : testSourceRoots ) +<a class="jxr_linenumber" name="L352" href="#L352">352</a> { +<a class="jxr_linenumber" name="L353" href="#L353">353</a> File sroot = <strong class="jxr_keyword">new</strong> File( root ); +<a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">if</strong> ( sroot.exists() ) +<a class="jxr_linenumber" name="L355" href="#L355">355</a> { +<a class="jxr_linenumber" name="L356" href="#L356">356</a> String testXref = constructXRefLocation( <strong class="jxr_keyword">true</strong> ); +<a class="jxr_linenumber" name="L357" href="#L357">357</a> directories.add( <strong class="jxr_keyword">new</strong> PmdFileInfo( project, sroot, testXref ) ); +<a class="jxr_linenumber" name="L358" href="#L358">358</a> } +<a class="jxr_linenumber" name="L359" href="#L359">359</a> } +<a class="jxr_linenumber" name="L360" href="#L360">360</a> } +<a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong class="jxr_keyword">if</strong> ( aggregate ) +<a class="jxr_linenumber" name="L362" href="#L362">362</a> { +<a class="jxr_linenumber" name="L363" href="#L363">363</a> <strong class="jxr_keyword">for</strong> ( MavenProject localProject : reactorProjects ) +<a class="jxr_linenumber" name="L364" href="#L364">364</a> { +<a class="jxr_linenumber" name="L365" href="#L365">365</a> List<String> localCompileSourceRoots = localProject.getCompileSourceRoots(); +<a class="jxr_linenumber" name="L366" href="#L366">366</a> <strong class="jxr_keyword">for</strong> ( String root : localCompileSourceRoots ) +<a class="jxr_linenumber" name="L367" href="#L367">367</a> { +<a class="jxr_linenumber" name="L368" href="#L368">368</a> File sroot = <strong class="jxr_keyword">new</strong> File( root ); +<a class="jxr_linenumber" name="L369" href="#L369">369</a> <strong class="jxr_keyword">if</strong> ( sroot.exists() ) +<a class="jxr_linenumber" name="L370" href="#L370">370</a> { +<a class="jxr_linenumber" name="L371" href="#L371">371</a> String sourceXref = constructXRefLocation( false ); +<a class="jxr_linenumber" name="L372" href="#L372">372</a> directories.add( <strong class="jxr_keyword">new</strong> PmdFileInfo( localProject, sroot, sourceXref ) ); +<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> <strong class="jxr_keyword">if</strong> ( includeTests ) +<a class="jxr_linenumber" name="L376" href="#L376">376</a> { +<a class="jxr_linenumber" name="L377" href="#L377">377</a> List<String> localTestCompileSourceRoots = localProject.getTestCompileSourceRoots(); +<a class="jxr_linenumber" name="L378" href="#L378">378</a> <strong class="jxr_keyword">for</strong> ( String root : localTestCompileSourceRoots ) +<a class="jxr_linenumber" name="L379" href="#L379">379</a> { +<a class="jxr_linenumber" name="L380" href="#L380">380</a> File sroot = <strong class="jxr_keyword">new</strong> File( root ); +<a class="jxr_linenumber" name="L381" href="#L381">381</a> <strong class="jxr_keyword">if</strong> ( sroot.exists() ) +<a class="jxr_linenumber" name="L382" href="#L382">382</a> { +<a class="jxr_linenumber" name="L383" href="#L383">383</a> String testXref = constructXRefLocation( <strong class="jxr_keyword">true</strong> ); +<a class="jxr_linenumber" name="L384" href="#L384">384</a> directories.add( <strong class="jxr_keyword">new</strong> PmdFileInfo( localProject, sroot, testXref ) ); +<a class="jxr_linenumber" name="L385" href="#L385">385</a> } +<a class="jxr_linenumber" name="L386" href="#L386">386</a> } +<a class="jxr_linenumber" name="L387" href="#L387">387</a> } +<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> } +<a class="jxr_linenumber" name="L391" href="#L391">391</a> +<a class="jxr_linenumber" name="L392" href="#L392">392</a> String excluding = getExcludes(); +<a class="jxr_linenumber" name="L393" href="#L393">393</a> getLog().debug( <span class="jxr_string">"Exclusions: "</span> + excluding ); +<a class="jxr_linenumber" name="L394" href="#L394">394</a> String including = getIncludes(); +<a class="jxr_linenumber" name="L395" href="#L395">395</a> getLog().debug( <span class="jxr_string">"Inclusions: "</span> + including ); +<a class="jxr_linenumber" name="L396" href="#L396">396</a> +<a class="jxr_linenumber" name="L397" href="#L397">397</a> Map<File, PmdFileInfo> files = <strong class="jxr_keyword">new</strong> TreeMap<>(); +<a class="jxr_linenumber" name="L398" href="#L398">398</a> +<a class="jxr_linenumber" name="L399" href="#L399">399</a> <strong class="jxr_keyword">for</strong> ( PmdFileInfo finfo : directories ) +<a class="jxr_linenumber" name="L400" href="#L400">400</a> { +<a class="jxr_linenumber" name="L401" href="#L401">401</a> getLog().debug( <span class="jxr_string">"Searching for files in directory "</span> + finfo.getSourceDirectory().toString() ); +<a class="jxr_linenumber" name="L402" href="#L402">402</a> File sourceDirectory = finfo.getSourceDirectory(); +<a class="jxr_linenumber" name="L403" href="#L403">403</a> <strong class="jxr_keyword">if</strong> ( sourceDirectory.isDirectory() && !isDirectoryExcluded( excludeRootFiles, sourceDirectory ) ) +<a class="jxr_linenumber" name="L404" href="#L404">404</a> { +<a class="jxr_linenumber" name="L405" href="#L405">405</a> List<File> newfiles = FileUtils.getFiles( sourceDirectory, including, excluding ); +<a class="jxr_linenumber" name="L406" href="#L406">406</a> <strong class="jxr_keyword">for</strong> ( File newfile : newfiles ) +<a class="jxr_linenumber" name="L407" href="#L407">407</a> { +<a class="jxr_linenumber" name="L408" href="#L408">408</a> files.put( newfile.getCanonicalFile(), finfo ); +<a class="jxr_linenumber" name="L409" href="#L409">409</a> } +<a class="jxr_linenumber" name="L410" href="#L410">410</a> } +<a class="jxr_linenumber" name="L411" href="#L411">411</a> } +<a class="jxr_linenumber" name="L412" href="#L412">412</a> +<a class="jxr_linenumber" name="L413" href="#L413">413</a> <strong class="jxr_keyword">return</strong> files; +<a class="jxr_linenumber" name="L414" href="#L414">414</a> } +<a class="jxr_linenumber" name="L415" href="#L415">415</a> +<a class="jxr_linenumber" name="L416" href="#L416">416</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isDirectoryExcluded( Collection<File> excludeRootFiles, File sourceDirectoryToCheck ) +<a class="jxr_linenumber" name="L417" href="#L417">417</a> { +<a class="jxr_linenumber" name="L418" href="#L418">418</a> <strong class="jxr_keyword">boolean</strong> returnVal = false; +<a class="jxr_linenumber" name="L419" href="#L419">419</a> <strong class="jxr_keyword">for</strong> ( File excludeDir : excludeRootFiles ) +<a class="jxr_linenumber" name="L420" href="#L420">420</a> { +<a class="jxr_linenumber" name="L421" href="#L421">421</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L422" href="#L422">422</a> { +<a class="jxr_linenumber" name="L423" href="#L423">423</a> <strong class="jxr_keyword">if</strong> ( sourceDirectoryToCheck.getCanonicalPath().startsWith( excludeDir.getCanonicalPath() ) ) +<a class="jxr_linenumber" name="L424" href="#L424">424</a> { +<a class="jxr_linenumber" name="L425" href="#L425">425</a> getLog().debug( <span class="jxr_string">"Directory "</span> + sourceDirectoryToCheck.getAbsolutePath() +<a class="jxr_linenumber" name="L426" href="#L426">426</a> + <span class="jxr_string">" has been excluded as it matches excludeRoot "</span> +<a class="jxr_linenumber" name="L427" href="#L427">427</a> + excludeDir.getAbsolutePath() ); +<a class="jxr_linenumber" name="L428" href="#L428">428</a> returnVal = <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L429" href="#L429">429</a> <strong class="jxr_keyword">break</strong>; +<a class="jxr_linenumber" name="L430" href="#L430">430</a> } +<a class="jxr_linenumber" name="L431" href="#L431">431</a> } +<a class="jxr_linenumber" name="L432" href="#L432">432</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) +<a class="jxr_linenumber" name="L433" href="#L433">433</a> { +<a class="jxr_linenumber" name="L434" href="#L434">434</a> getLog().warn( <span class="jxr_string">"Error while checking "</span> + sourceDirectoryToCheck +<a class="jxr_linenumber" name="L435" href="#L435">435</a> + <span class="jxr_string">" whether it should be excluded."</span>, e ); +<a class="jxr_linenumber" name="L436" href="#L436">436</a> } +<a class="jxr_linenumber" name="L437" href="#L437">437</a> } +<a class="jxr_linenumber" name="L438" href="#L438">438</a> <strong class="jxr_keyword">return</strong> returnVal; +<a class="jxr_linenumber" name="L439" href="#L439">439</a> } +<a class="jxr_linenumber" name="L440" href="#L440">440</a> +<a class="jxr_linenumber" name="L441" href="#L441">441</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L442" href="#L442">442</a> <em class="jxr_javadoccomment"> * Gets the comma separated list of effective include patterns.</em> +<a class="jxr_linenumber" name="L443" href="#L443">443</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L444" href="#L444">444</a> <em class="jxr_javadoccomment"> * @return The comma separated list of effective include patterns, never <code>null</code>.</em> +<a class="jxr_linenumber" name="L445" href="#L445">445</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L446" href="#L446">446</a> <strong class="jxr_keyword">private</strong> String getIncludes() +<a class="jxr_linenumber" name="L447" href="#L447">447</a> { +<a class="jxr_linenumber" name="L448" href="#L448">448</a> Collection<String> patterns = <strong class="jxr_keyword">new</strong> LinkedHashSet<>(); +<a class="jxr_linenumber" name="L449" href="#L449">449</a> <strong class="jxr_keyword">if</strong> ( includes != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L450" href="#L450">450</a> { +<a class="jxr_linenumber" name="L451" href="#L451">451</a> patterns.addAll( includes ); +<a class="jxr_linenumber" name="L452" href="#L452">452</a> } +<a class="jxr_linenumber" name="L453" href="#L453">453</a> <strong class="jxr_keyword">if</strong> ( patterns.isEmpty() ) +<a class="jxr_linenumber" name="L454" href="#L454">454</a> { +<a class="jxr_linenumber" name="L455" href="#L455">455</a> patterns.add( <span class="jxr_string">"**/*.java"</span> ); +<a class="jxr_linenumber" name="L456" href="#L456">456</a> } +<a class="jxr_linenumber" name="L457" href="#L457">457</a> <strong class="jxr_keyword">return</strong> StringUtils.join( patterns.iterator(), <span class="jxr_string">","</span> ); +<a class="jxr_linenumber" name="L458" href="#L458">458</a> } +<a class="jxr_linenumber" name="L459" href="#L459">459</a> +<a class="jxr_linenumber" name="L460" href="#L460">460</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L461" href="#L461">461</a> <em class="jxr_javadoccomment"> * Gets the comma separated list of effective exclude patterns.</em> +<a class="jxr_linenumber" name="L462" href="#L462">462</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L463" href="#L463">463</a> <em class="jxr_javadoccomment"> * @return The comma separated list of effective exclude patterns, never <code>null</code>.</em> +<a class="jxr_linenumber" name="L464" href="#L464">464</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L465" href="#L465">465</a> <strong class="jxr_keyword">private</strong> String getExcludes() +<a class="jxr_linenumber" name="L466" href="#L466">466</a> { +<a class="jxr_linenumber" name="L467" href="#L467">467</a> Collection<String> patterns = <strong class="jxr_keyword">new</strong> LinkedHashSet<>( FileUtils.getDefaultExcludesAsList() ); +<a class="jxr_linenumber" name="L468" href="#L468">468</a> <strong class="jxr_keyword">if</strong> ( excludes != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L469" href="#L469">469</a> { +<a class="jxr_linenumber" name="L470" href="#L470">470</a> patterns.addAll( excludes ); +<a class="jxr_linenumber" name="L471" href="#L471">471</a> } +<a class="jxr_linenumber" name="L472" href="#L472">472</a> <strong class="jxr_keyword">return</strong> StringUtils.join( patterns.iterator(), <span class="jxr_string">","</span> ); +<a class="jxr_linenumber" name="L473" href="#L473">473</a> } +<a class="jxr_linenumber" name="L474" href="#L474">474</a> +<a class="jxr_linenumber" name="L475" href="#L475">475</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isHtml() +<a class="jxr_linenumber" name="L476" href="#L476">476</a> { +<a class="jxr_linenumber" name="L477" href="#L477">477</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"html"</span>.equals( format ); +<a class="jxr_linenumber" name="L478" href="#L478">478</a> } +<a class="jxr_linenumber" name="L479" href="#L479">479</a> +<a class="jxr_linenumber" name="L480" href="#L480">480</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isXml() +<a class="jxr_linenumber" name="L481" href="#L481">481</a> { +<a class="jxr_linenumber" name="L482" href="#L482">482</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"xml"</span>.equals( format ); +<a class="jxr_linenumber" name="L483" href="#L483">483</a> } +<a class="jxr_linenumber" name="L484" href="#L484">484</a> +<a class="jxr_linenumber" name="L485" href="#L485">485</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L486" href="#L486">486</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L487" href="#L487">487</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L488" href="#L488">488</a> @Override +<a class="jxr_linenumber" name="L489" href="#L489">489</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() +<a class="jxr_linenumber" name="L490" href="#L490">490</a> { +<a class="jxr_linenumber" name="L491" href="#L491">491</a> <strong class="jxr_keyword">if</strong> ( aggregate && !project.isExecutionRoot() ) +<a class="jxr_linenumber" name="L492" href="#L492">492</a> { +<a class="jxr_linenumber" name="L493" href="#L493">493</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L494" href="#L494">494</a> } +<a class="jxr_linenumber" name="L495" href="#L495">495</a> +<a class="jxr_linenumber" name="L496" href="#L496">496</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"pom"</span>.equals( project.getPackaging() ) && !aggregate ) +<a class="jxr_linenumber" name="L497" href="#L497">497</a> { +<a class="jxr_linenumber" name="L498" href="#L498">498</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L499" href="#L499">499</a> } +<a class="jxr_linenumber" name="L500" href="#L500">500</a> +<a class="jxr_linenumber" name="L501" href="#L501">501</a> <em class="jxr_comment">// if format is XML, we need to output it even if the file list is empty</em> +<a class="jxr_linenumber" name="L502" href="#L502">502</a> <em class="jxr_comment">// so the "check" goals can check for failures</em> +<a class="jxr_linenumber" name="L503" href="#L503">503</a> <strong class="jxr_keyword">if</strong> ( isXml() ) +<a class="jxr_linenumber" name="L504" href="#L504">504</a> { +<a class="jxr_linenumber" name="L505" href="#L505">505</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L506" href="#L506">506</a> } +<a class="jxr_linenumber" name="L507" href="#L507">507</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L508" href="#L508">508</a> { +<a class="jxr_linenumber" name="L509" href="#L509">509</a> filesToProcess = getFilesToProcess(); +<a class="jxr_linenumber" name="L510" href="#L510">510</a> <strong class="jxr_keyword">if</strong> ( filesToProcess.isEmpty() ) +<a class="jxr_linenumber" name="L511" href="#L511">511</a> { +<a class="jxr_linenumber" name="L512" href="#L512">512</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L513" href="#L513">513</a> } +<a class="jxr_linenumber" name="L514" href="#L514">514</a> } +<a class="jxr_linenumber" name="L515" href="#L515">515</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) +<a class="jxr_linenumber" name="L516" href="#L516">516</a> { +<a class="jxr_linenumber" name="L517" href="#L517">517</a> getLog().error( e ); +<a class="jxr_linenumber" name="L518" href="#L518">518</a> } +<a class="jxr_linenumber" name="L519" href="#L519">519</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L520" href="#L520">520</a> } +<a class="jxr_linenumber" name="L521" href="#L521">521</a> +<a class="jxr_linenumber" name="L522" href="#L522">522</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L523" href="#L523">523</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L524" href="#L524">524</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L525" href="#L525">525</a> @Override +<a class="jxr_linenumber" name="L526" href="#L526">526</a> <strong class="jxr_keyword">protected</strong> String getOutputDirectory() +<a class="jxr_linenumber" name="L527" href="#L527">527</a> { +<a class="jxr_linenumber" name="L528" href="#L528">528</a> <strong class="jxr_keyword">return</strong> outputDirectory.getAbsolutePath(); +<a class="jxr_linenumber" name="L529" href="#L529">529</a> } +<a class="jxr_linenumber" name="L530" href="#L530">530</a> +<a class="jxr_linenumber" name="L531" href="#L531">531</a> <strong class="jxr_keyword">protected</strong> String getSourceEncoding() +<a class="jxr_linenumber" name="L532" href="#L532">532</a> { +<a class="jxr_linenumber" name="L533" href="#L533">533</a> <strong class="jxr_keyword">return</strong> sourceEncoding; +<a class="jxr_linenumber" name="L534" href="#L534">534</a> } +<a class="jxr_linenumber" name="L535" href="#L535">535</a> +<a class="jxr_linenumber" name="L536" href="#L536">536</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L537" href="#L537">537</a> <em class="jxr_javadoccomment"> * Gets the effective reporting output files encoding.</em> +<a class="jxr_linenumber" name="L538" href="#L538">538</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L539" href="#L539">539</a> <em class="jxr_javadoccomment"> * @return The effective reporting output file encoding, never <code>null</code>.</em> +<a class="jxr_linenumber" name="L540" href="#L540">540</a> <em class="jxr_javadoccomment"> * @since 2.5</em> +<a class="jxr_linenumber" name="L541" href="#L541">541</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L542" href="#L542">542</a> <strong class="jxr_keyword">protected</strong> String getOutputEncoding() +<a class="jxr_linenumber" name="L543" href="#L543">543</a> { +<a class="jxr_linenumber" name="L544" href="#L544">544</a> <strong class="jxr_keyword">return</strong> ( outputEncoding != <strong class="jxr_keyword">null</strong> ) ? outputEncoding : ReaderFactory.UTF_8; +<a class="jxr_linenumber" name="L545" href="#L545">545</a> } +<a class="jxr_linenumber" name="L546" href="#L546">546</a> +<a class="jxr_linenumber" name="L547" href="#L547">547</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setupPmdLogging() +<a class="jxr_linenumber" name="L548" href="#L548">548</a> { +<a class="jxr_linenumber" name="L549" href="#L549">549</a> <strong class="jxr_keyword">if</strong> ( !showPmdLog ) +<a class="jxr_linenumber" name="L550" href="#L550">550</a> { +<a class="jxr_linenumber" name="L551" href="#L551">551</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L552" href="#L552">552</a> } +<a class="jxr_linenumber" name="L553" href="#L553">553</a> +<a class="jxr_linenumber" name="L554" href="#L554">554</a> Logger logger = Logger.getLogger( <span class="jxr_string">"net.sourceforge.pmd"</span> ); +<a class="jxr_linenumber" name="L555" href="#L555">555</a> +<a class="jxr_linenumber" name="L556" href="#L556">556</a> SLF4JBridgeHandler handler = <strong class="jxr_keyword">new</strong> SLF4JBridgeHandler(); +<a class="jxr_linenumber" name="L557" href="#L557">557</a> SimpleFormatter formatter = <strong class="jxr_keyword">new</strong> SimpleFormatter(); +<a class="jxr_linenumber" name="L558" href="#L558">558</a> handler.setFormatter( formatter ); +<a class="jxr_linenumber" name="L559" href="#L559">559</a> logger.setUseParentHandlers( false ); +<a class="jxr_linenumber" name="L560" href="#L560">560</a> logger.addHandler( handler ); +<a class="jxr_linenumber" name="L561" href="#L561">561</a> handler.setLevel( Level.ALL ); +<a class="jxr_linenumber" name="L562" href="#L562">562</a> logger.setLevel( Level.ALL ); +<a class="jxr_linenumber" name="L563" href="#L563">563</a> getLog().debug( <span class="jxr_string">"Configured jul-to-slf4j bridge for "</span> + logger.getName() ); +<a class="jxr_linenumber" name="L564" href="#L564">564</a> } +<a class="jxr_linenumber" name="L565" href="#L565">565</a> +<a class="jxr_linenumber" name="L566" href="#L566">566</a> <strong class="jxr_keyword">static</strong> String getPmdVersion() +<a class="jxr_linenumber" name="L567" href="#L567">567</a> { +<a class="jxr_linenumber" name="L568" href="#L568">568</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L569" href="#L569">569</a> { +<a class="jxr_linenumber" name="L570" href="#L570">570</a> <strong class="jxr_keyword">return</strong> (String) PMD.<strong class="jxr_keyword">class</strong>.getField( <span class="jxr_string">"VERSION"</span> ).get( <strong class="jxr_keyword">null</strong> ); +<a class="jxr_linenumber" name="L571" href="#L571">571</a> } +<a class="jxr_linenumber" name="L572" href="#L572">572</a> <strong class="jxr_keyword">catch</strong> ( IllegalAccessException e ) +<a class="jxr_linenumber" name="L573" href="#L573">573</a> { +<a class="jxr_linenumber" name="L574" href="#L574">574</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException( <span class="jxr_string">"PMD VERSION field not accessible"</span>, e ); +<a class="jxr_linenumber" name="L575" href="#L575">575</a> } +<a class="jxr_linenumber" name="L576" href="#L576">576</a> <strong class="jxr_keyword">catch</strong> ( NoSuchFieldException e ) +<a class="jxr_linenumber" name="L577" href="#L577">577</a> { +<a class="jxr_linenumber" name="L578" href="#L578">578</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException( <span class="jxr_string">"PMD VERSION field not found"</span>, e ); +<a class="jxr_linenumber" name="L579" href="#L579">579</a> } +<a class="jxr_linenumber" name="L580" href="#L580">580</a> } +<a class="jxr_linenumber" name="L581" href="#L581">581</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
