You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ol...@apache.org on 2013/03/04 11:25:49 UTC
svn commit: r852906 [35/45] - in
/websites/production/maven/content/plugins-archives/maven-pmd-plugin-3.1:
./ apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/maven/
apidocs/org/apache/maven/plugin/ apidocs/org/apache/maven/plugin/pmd/ apid...
Added: websites/production/maven/content/plugins-archives/maven-pmd-plugin-3.1/xref/org/apache/maven/plugin/pmd/AbstractPmdReport.html
==============================================================================
--- websites/production/maven/content/plugins-archives/maven-pmd-plugin-3.1/xref/org/apache/maven/plugin/pmd/AbstractPmdReport.html (added)
+++ websites/production/maven/content/plugins-archives/maven-pmd-plugin-3.1/xref/org/apache/maven/plugin/pmd/AbstractPmdReport.html Mon Mar 4 10:25:45 2013
@@ -0,0 +1,488 @@
+<!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/plugin/pmd/AbstractPmdReport.html">View Javadoc</a></div><pre>
+
+<a class="jxr_linenumber" name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugin.pmd;
+<a class="jxr_linenumber" name="2" href="#2">2</a>
+<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
+<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
+<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
+<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
+<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
+<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
+<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
+<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
+<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
+<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
+<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
+<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
+<a class="jxr_linenumber" name="19" href="#19">19</a> <em class="jxr_comment"> * under the License.</em>
+<a class="jxr_linenumber" name="20" href="#20">20</a> <em class="jxr_comment"> */</em>
+<a class="jxr_linenumber" name="21" href="#21">21</a>
+<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.PMD;
+<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.Renderer;
+<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.ReportPlugin;
+<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component;
+<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter;
+<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
+<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.AbstractMavenReport;
+<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.FileUtils;
+<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.PathTool;
+<a class="jxr_linenumber" name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory;
+<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils;
+<a class="jxr_linenumber" name="33" href="#33">33</a>
+<a class="jxr_linenumber" name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> java.io.File;
+<a class="jxr_linenumber" name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a class="jxr_linenumber" name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
+<a class="jxr_linenumber" name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> java.util.Collection;
+<a class="jxr_linenumber" name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> java.util.Collections;
+<a class="jxr_linenumber" name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> java.util.HashSet;
+<a class="jxr_linenumber" name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> java.util.Iterator;
+<a class="jxr_linenumber" name="41" href="#41">41</a> <strong class="jxr_keyword">import</strong> java.util.LinkedHashSet;
+<a class="jxr_linenumber" name="42" href="#42">42</a> <strong class="jxr_keyword">import</strong> java.util.List;
+<a class="jxr_linenumber" name="43" href="#43">43</a> <strong class="jxr_keyword">import</strong> java.util.Map;
+<a class="jxr_linenumber" name="44" href="#44">44</a> <strong class="jxr_keyword">import</strong> java.util.TreeMap;
+<a class="jxr_linenumber" name="45" href="#45">45</a>
+<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * Base class for the PMD reports.</em>
+<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:brett@apache.org" target="alexandria_uri">mailto:brett@apache.org</a>">Brett Porter</a></em>
+<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * @version $Id$</em>
+<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="52" href="#52">52</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugin/pmd/AbstractPmdReport.html">AbstractPmdReport</a>
+<a class="jxr_linenumber" name="53" href="#53">53</a> <strong class="jxr_keyword">extends</strong> AbstractMavenReport
+<a class="jxr_linenumber" name="54" href="#54">54</a> {
+<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * The output directory for the intermediate XML report.</em>
+<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="58" href="#58">58</a> @Parameter( property = <span class="jxr_string">"project.build.directory"</span>, required = <strong class="jxr_keyword">true</strong> )
+<a class="jxr_linenumber" name="59" href="#59">59</a> <strong class="jxr_keyword">protected</strong> File targetDirectory;
+<a class="jxr_linenumber" name="60" href="#60">60</a>
+<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="62" href="#62">62</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="63" href="#63">63</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="64" href="#64">64</a> <em class="jxr_javadoccomment"> * generation, the output directory configured in the Maven Site Plugin is used instead.</em>
+<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="66" href="#66">66</a> @Parameter( property = <span class="jxr_string">"project.reporting.outputDirectory"</span>, required = <strong class="jxr_keyword">true</strong> )
+<a class="jxr_linenumber" name="67" href="#67">67</a> <strong class="jxr_keyword">protected</strong> File outputDirectory;
+<a class="jxr_linenumber" name="68" href="#68">68</a>
+<a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * Site rendering component for generating the HTML report.</em>
+<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="72" href="#72">72</a> @Component
+<a class="jxr_linenumber" name="73" href="#73">73</a> <strong class="jxr_keyword">private</strong> Renderer siteRenderer;
+<a class="jxr_linenumber" name="74" href="#74">74</a>
+<a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * The project to analyse.</em>
+<a class="jxr_linenumber" name="77" href="#77">77</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="78" href="#78">78</a> @Component
+<a class="jxr_linenumber" name="79" href="#79">79</a> <strong class="jxr_keyword">protected</strong> MavenProject project;
+<a class="jxr_linenumber" name="80" href="#80">80</a>
+<a class="jxr_linenumber" name="81" href="#81">81</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * Set the output format type, in addition to the HTML report. Must be one of: "none",</em>
+<a class="jxr_linenumber" name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * "csv", "xml", "txt" or the full class name of the PMD renderer to use.</em>
+<a class="jxr_linenumber" name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * See the net.sourceforge.pmd.renderers package javadoc for available renderers.</em>
+<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * XML is required if the pmd:check goal is being used.</em>
+<a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="87" href="#87">87</a> @Parameter( property = <span class="jxr_string">"format"</span>, defaultValue = <span class="jxr_string">"xml"</span> )
+<a class="jxr_linenumber" name="88" href="#88">88</a> <strong class="jxr_keyword">protected</strong> String format = <span class="jxr_string">"xml"</span>;
+<a class="jxr_linenumber" name="89" href="#89">89</a>
+<a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * Link the violation line numbers to the source xref. Links will be created</em>
+<a class="jxr_linenumber" name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * automatically if the jxr plugin is being used.</em>
+<a class="jxr_linenumber" name="93" href="#93">93</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="94" href="#94">94</a> @Parameter( property = <span class="jxr_string">"linkXRef"</span>, defaultValue = <span class="jxr_string">"true"</span> )
+<a class="jxr_linenumber" name="95" href="#95">95</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> linkXRef;
+<a class="jxr_linenumber" name="96" href="#96">96</a>
+<a class="jxr_linenumber" name="97" href="#97">97</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * Location of the Xrefs to link to.</em>
+<a class="jxr_linenumber" name="99" href="#99">99</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="100" href="#100">100</a> @Parameter( defaultValue = <span class="jxr_string">"${project.reporting.outputDirectory}/xref"</span> )
+<a class="jxr_linenumber" name="101" href="#101">101</a> <strong class="jxr_keyword">private</strong> File xrefLocation;
+<a class="jxr_linenumber" name="102" href="#102">102</a>
+<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * Location of the Test Xrefs to link to.</em>
+<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="106" href="#106">106</a> @Parameter( defaultValue = <span class="jxr_string">"${project.reporting.outputDirectory}/xref-test"</span> )
+<a class="jxr_linenumber" name="107" href="#107">107</a> <strong class="jxr_keyword">private</strong> File xrefTestLocation;
+<a class="jxr_linenumber" name="108" href="#108">108</a>
+<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="110" href="#110">110</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="111" href="#111">111</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="112" href="#112">112</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="113" href="#113">113</a> <em class="jxr_javadoccomment"> * directories, use the parameter <code>excludeRoots</code> instead.</em>
+<a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * @since 2.2</em>
+<a class="jxr_linenumber" name="116" href="#116">116</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="117" href="#117">117</a> @Parameter
+<a class="jxr_linenumber" name="118" href="#118">118</a> <strong class="jxr_keyword">private</strong> List<String> excludes;
+<a class="jxr_linenumber" name="119" href="#119">119</a>
+<a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * A list of files to include from checking. Can contain Ant-style wildcards and double wildcards.</em>
+<a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * Defaults to **\/*.java.</em>
+<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * @since 2.2</em>
+<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="126" href="#126">126</a> @Parameter
+<a class="jxr_linenumber" name="127" href="#127">127</a> <strong class="jxr_keyword">private</strong> List<String> includes;
+<a class="jxr_linenumber" name="128" href="#128">128</a>
+<a class="jxr_linenumber" name="129" href="#129">129</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * The directories containing the sources to be compiled.</em>
+<a class="jxr_linenumber" name="131" href="#131">131</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="132" href="#132">132</a> @Parameter( property = <span class="jxr_string">"project.compileSourceRoots"</span>, required = <strong class="jxr_keyword">true</strong>, readonly = <strong class="jxr_keyword">true</strong> )
+<a class="jxr_linenumber" name="133" href="#133">133</a> <strong class="jxr_keyword">private</strong> List<String> compileSourceRoots;
+<a class="jxr_linenumber" name="134" href="#134">134</a>
+<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * The directories containing the test-sources to be compiled.</em>
+<a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="138" href="#138">138</a> @Parameter( property = <span class="jxr_string">"project.testCompileSourceRoots"</span>, required = <strong class="jxr_keyword">true</strong>, readonly = <strong class="jxr_keyword">true</strong> )
+<a class="jxr_linenumber" name="139" href="#139">139</a> <strong class="jxr_keyword">private</strong> List<String> testSourceRoots;
+<a class="jxr_linenumber" name="140" href="#140">140</a>
+<a class="jxr_linenumber" name="141" href="#141">141</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * The project source directories that should be excluded.</em>
+<a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * @since 2.2</em>
+<a class="jxr_linenumber" name="145" href="#145">145</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="146" href="#146">146</a> @Parameter
+<a class="jxr_linenumber" name="147" href="#147">147</a> <strong class="jxr_keyword">private</strong> File[] excludeRoots;
+<a class="jxr_linenumber" name="148" href="#148">148</a>
+<a class="jxr_linenumber" name="149" href="#149">149</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * Run PMD on the tests.</em>
+<a class="jxr_linenumber" name="151" href="#151">151</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * @since 2.2</em>
+<a class="jxr_linenumber" name="153" href="#153">153</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="154" href="#154">154</a> @Parameter( defaultValue = <span class="jxr_string">"false"</span> )
+<a class="jxr_linenumber" name="155" href="#155">155</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> includeTests;
+<a class="jxr_linenumber" name="156" href="#156">156</a>
+<a class="jxr_linenumber" name="157" href="#157">157</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * Whether to build an aggregated report at the root, or build individual reports.</em>
+<a class="jxr_linenumber" name="159" href="#159">159</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * @since 2.2</em>
+<a class="jxr_linenumber" name="161" href="#161">161</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="162" href="#162">162</a> @Parameter( property = <span class="jxr_string">"aggregate"</span>, defaultValue = <span class="jxr_string">"false"</span> )
+<a class="jxr_linenumber" name="163" href="#163">163</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> aggregate;
+<a class="jxr_linenumber" name="164" href="#164">164</a>
+<a class="jxr_linenumber" name="165" href="#165">165</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * The file encoding to use when reading the Java sources.</em>
+<a class="jxr_linenumber" name="167" href="#167">167</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * @since 2.3</em>
+<a class="jxr_linenumber" name="169" href="#169">169</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="170" href="#170">170</a> @Parameter( property = <span class="jxr_string">"encoding"</span>, defaultValue = <span class="jxr_string">"${project.build.sourceEncoding}"</span> )
+<a class="jxr_linenumber" name="171" href="#171">171</a> <strong class="jxr_keyword">private</strong> String sourceEncoding;
+<a class="jxr_linenumber" name="172" href="#172">172</a>
+<a class="jxr_linenumber" name="173" href="#173">173</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="174" href="#174">174</a> <em class="jxr_javadoccomment"> * The file encoding when writing non-HTML reports.</em>
+<a class="jxr_linenumber" name="175" href="#175">175</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="176" href="#176">176</a> <em class="jxr_javadoccomment"> * @since 2.5</em>
+<a class="jxr_linenumber" name="177" href="#177">177</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="178" href="#178">178</a> @Parameter( property = <span class="jxr_string">"outputEncoding"</span>, defaultValue = <span class="jxr_string">"${project.reporting.outputEncoding}"</span> )
+<a class="jxr_linenumber" name="179" href="#179">179</a> <strong class="jxr_keyword">private</strong> String outputEncoding;
+<a class="jxr_linenumber" name="180" href="#180">180</a>
+<a class="jxr_linenumber" name="181" href="#181">181</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * The projects in the reactor for aggregation report.</em>
+<a class="jxr_linenumber" name="183" href="#183">183</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="184" href="#184">184</a> @Parameter( property = <span class="jxr_string">"reactorProjects"</span>, readonly = <strong class="jxr_keyword">true</strong> )
+<a class="jxr_linenumber" name="185" href="#185">185</a> <strong class="jxr_keyword">protected</strong> List<MavenProject> reactorProjects;
+<a class="jxr_linenumber" name="186" href="#186">186</a>
+<a class="jxr_linenumber" name="187" href="#187">187</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="188" href="#188">188</a> <em class="jxr_javadoccomment"> * Whether to include the xml files generated by PMD/CPD in the site.<br/></em>
+<a class="jxr_linenumber" name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * <strong>Note:</strong> In versions 2.2 - 2.7.1 the default value for this</em>
+<a class="jxr_linenumber" name="190" href="#190">190</a> <em class="jxr_javadoccomment"> * was <code>true</code>. This was changed in version 3.0.</em>
+<a class="jxr_linenumber" name="191" href="#191">191</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="192" href="#192">192</a> <em class="jxr_javadoccomment"> * @since 3.0</em>
+<a class="jxr_linenumber" name="193" href="#193">193</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="194" href="#194">194</a> @Parameter( defaultValue = <span class="jxr_string">"false"</span> )
+<a class="jxr_linenumber" name="195" href="#195">195</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> includeXmlInSite;
+<a class="jxr_linenumber" name="196" href="#196">196</a>
+<a class="jxr_linenumber" name="197" href="#197">197</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em>
+<a class="jxr_linenumber" name="199" href="#199">199</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="200" href="#200">200</a> <strong class="jxr_keyword">protected</strong> MavenProject getProject()
+<a class="jxr_linenumber" name="201" href="#201">201</a> {
+<a class="jxr_linenumber" name="202" href="#202">202</a> <strong class="jxr_keyword">return</strong> project;
+<a class="jxr_linenumber" name="203" href="#203">203</a> }
+<a class="jxr_linenumber" name="204" href="#204">204</a>
+<a class="jxr_linenumber" name="205" href="#205">205</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="206" href="#206">206</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em>
+<a class="jxr_linenumber" name="207" href="#207">207</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="208" href="#208">208</a> <strong class="jxr_keyword">protected</strong> Renderer getSiteRenderer()
+<a class="jxr_linenumber" name="209" href="#209">209</a> {
+<a class="jxr_linenumber" name="210" href="#210">210</a> <strong class="jxr_keyword">return</strong> siteRenderer;
+<a class="jxr_linenumber" name="211" href="#211">211</a> }
+<a class="jxr_linenumber" name="212" href="#212">212</a>
+<a class="jxr_linenumber" name="213" href="#213">213</a> <strong class="jxr_keyword">protected</strong> String constructXRefLocation( <strong class="jxr_keyword">boolean</strong> test )
+<a class="jxr_linenumber" name="214" href="#214">214</a> {
+<a class="jxr_linenumber" name="215" href="#215">215</a> String location = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="216" href="#216">216</a> <strong class="jxr_keyword">if</strong> ( linkXRef )
+<a class="jxr_linenumber" name="217" href="#217">217</a> {
+<a class="jxr_linenumber" name="218" href="#218">218</a> File xrefLoc = test ? xrefTestLocation : xrefLocation;
+<a class="jxr_linenumber" name="219" href="#219">219</a>
+<a class="jxr_linenumber" name="220" href="#220">220</a> String relativePath =
+<a class="jxr_linenumber" name="221" href="#221">221</a> PathTool.getRelativePath( outputDirectory.getAbsolutePath(), xrefLoc.getAbsolutePath() );
+<a class="jxr_linenumber" name="222" href="#222">222</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( relativePath ) )
+<a class="jxr_linenumber" name="223" href="#223">223</a> {
+<a class="jxr_linenumber" name="224" href="#224">224</a> relativePath = <span class="jxr_string">"."</span>;
+<a class="jxr_linenumber" name="225" href="#225">225</a> }
+<a class="jxr_linenumber" name="226" href="#226">226</a> relativePath = relativePath + <span class="jxr_string">"/"</span> + xrefLoc.getName();
+<a class="jxr_linenumber" name="227" href="#227">227</a> <strong class="jxr_keyword">if</strong> ( xrefLoc.exists() )
+<a class="jxr_linenumber" name="228" href="#228">228</a> {
+<a class="jxr_linenumber" name="229" href="#229">229</a> <em class="jxr_comment">// XRef was already generated by manual execution of a lifecycle binding</em>
+<a class="jxr_linenumber" name="230" href="#230">230</a> location = relativePath;
+<a class="jxr_linenumber" name="231" href="#231">231</a> }
+<a class="jxr_linenumber" name="232" href="#232">232</a> <strong class="jxr_keyword">else</strong>
+<a class="jxr_linenumber" name="233" href="#233">233</a> {
+<a class="jxr_linenumber" name="234" href="#234">234</a> <em class="jxr_comment">// Not yet generated - check if the report is on its way</em>
+<a class="jxr_linenumber" name="235" href="#235">235</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> ) List<ReportPlugin> reportPlugins = project.getReportPlugins();
+<a class="jxr_linenumber" name="236" href="#236">236</a> <strong class="jxr_keyword">for</strong> ( ReportPlugin plugin : reportPlugins )
+<a class="jxr_linenumber" name="237" href="#237">237</a> {
+<a class="jxr_linenumber" name="238" href="#238">238</a> String artifactId = plugin.getArtifactId();
+<a class="jxr_linenumber" name="239" href="#239">239</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="240" href="#240">240</a> {
+<a class="jxr_linenumber" name="241" href="#241">241</a> location = relativePath;
+<a class="jxr_linenumber" name="242" href="#242">242</a> }
+<a class="jxr_linenumber" name="243" href="#243">243</a> }
+<a class="jxr_linenumber" name="244" href="#244">244</a> }
+<a class="jxr_linenumber" name="245" href="#245">245</a>
+<a class="jxr_linenumber" name="246" href="#246">246</a> <strong class="jxr_keyword">if</strong> ( location == <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="247" href="#247">247</a> {
+<a class="jxr_linenumber" name="248" href="#248">248</a> getLog().warn( <span class="jxr_string">"Unable to locate Source XRef to link to - DISABLED"</span> );
+<a class="jxr_linenumber" name="249" href="#249">249</a> }
+<a class="jxr_linenumber" name="250" href="#250">250</a> }
+<a class="jxr_linenumber" name="251" href="#251">251</a> <strong class="jxr_keyword">return</strong> location;
+<a class="jxr_linenumber" name="252" href="#252">252</a> }
+<a class="jxr_linenumber" name="253" href="#253">253</a>
+<a class="jxr_linenumber" name="254" href="#254">254</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="255" href="#255">255</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="256" href="#256">256</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="257" href="#257">257</a> <em class="jxr_javadoccomment"> * @return a List of the files where the PMD tool will be executed</em>
+<a class="jxr_linenumber" name="258" href="#258">258</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException</em>
+<a class="jxr_linenumber" name="259" href="#259">259</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="260" href="#260">260</a> <strong class="jxr_keyword">protected</strong> Map<File, PmdFileInfo> getFilesToProcess()
+<a class="jxr_linenumber" name="261" href="#261">261</a> <strong class="jxr_keyword">throws</strong> IOException
+<a class="jxr_linenumber" name="262" href="#262">262</a> {
+<a class="jxr_linenumber" name="263" href="#263">263</a> String sourceXref = constructXRefLocation( false );
+<a class="jxr_linenumber" name="264" href="#264">264</a> String testXref = includeTests ? constructXRefLocation( <strong class="jxr_keyword">true</strong> ) : <span class="jxr_string">""</span>;
+<a class="jxr_linenumber" name="265" href="#265">265</a>
+<a class="jxr_linenumber" name="266" href="#266">266</a> <strong class="jxr_keyword">if</strong> ( aggregate && !project.isExecutionRoot() )
+<a class="jxr_linenumber" name="267" href="#267">267</a> {
+<a class="jxr_linenumber" name="268" href="#268">268</a> <strong class="jxr_keyword">return</strong> Collections.emptyMap();
+<a class="jxr_linenumber" name="269" href="#269">269</a> }
+<a class="jxr_linenumber" name="270" href="#270">270</a>
+<a class="jxr_linenumber" name="271" href="#271">271</a> <strong class="jxr_keyword">if</strong> ( excludeRoots == <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="272" href="#272">272</a> {
+<a class="jxr_linenumber" name="273" href="#273">273</a> excludeRoots = <strong class="jxr_keyword">new</strong> File[0];
+<a class="jxr_linenumber" name="274" href="#274">274</a> }
+<a class="jxr_linenumber" name="275" href="#275">275</a>
+<a class="jxr_linenumber" name="276" href="#276">276</a> Collection<File> excludeRootFiles = <strong class="jxr_keyword">new</strong> HashSet<File>( excludeRoots.length );
+<a class="jxr_linenumber" name="277" href="#277">277</a>
+<a class="jxr_linenumber" name="278" href="#278">278</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> i = 0; i < excludeRoots.length; i++ )
+<a class="jxr_linenumber" name="279" href="#279">279</a> {
+<a class="jxr_linenumber" name="280" href="#280">280</a> File file = excludeRoots[i];
+<a class="jxr_linenumber" name="281" href="#281">281</a> <strong class="jxr_keyword">if</strong> ( file.isDirectory() )
+<a class="jxr_linenumber" name="282" href="#282">282</a> {
+<a class="jxr_linenumber" name="283" href="#283">283</a> excludeRootFiles.add( file );
+<a class="jxr_linenumber" name="284" href="#284">284</a> }
+<a class="jxr_linenumber" name="285" href="#285">285</a> }
+<a class="jxr_linenumber" name="286" href="#286">286</a>
+<a class="jxr_linenumber" name="287" href="#287">287</a> List<PmdFileInfo> directories = <strong class="jxr_keyword">new</strong> ArrayList<PmdFileInfo>();
+<a class="jxr_linenumber" name="288" href="#288">288</a>
+<a class="jxr_linenumber" name="289" href="#289">289</a> <strong class="jxr_keyword">if</strong> ( compileSourceRoots != <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="290" href="#290">290</a> {
+<a class="jxr_linenumber" name="291" href="#291">291</a>
+<a class="jxr_linenumber" name="292" href="#292">292</a> <strong class="jxr_keyword">for</strong> ( String root : compileSourceRoots )
+<a class="jxr_linenumber" name="293" href="#293">293</a> {
+<a class="jxr_linenumber" name="294" href="#294">294</a> File sroot = <strong class="jxr_keyword">new</strong> File( root );
+<a class="jxr_linenumber" name="295" href="#295">295</a> directories.add( <strong class="jxr_keyword">new</strong> PmdFileInfo( project, sroot, sourceXref ) );
+<a class="jxr_linenumber" name="296" href="#296">296</a> }
+<a class="jxr_linenumber" name="297" href="#297">297</a>
+<a class="jxr_linenumber" name="298" href="#298">298</a> }
+<a class="jxr_linenumber" name="299" href="#299">299</a> <strong class="jxr_keyword">if</strong> ( includeTests )
+<a class="jxr_linenumber" name="300" href="#300">300</a> {
+<a class="jxr_linenumber" name="301" href="#301">301</a> <strong class="jxr_keyword">if</strong> ( testSourceRoots != <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="302" href="#302">302</a> {
+<a class="jxr_linenumber" name="303" href="#303">303</a> <strong class="jxr_keyword">for</strong> ( String root : testSourceRoots )
+<a class="jxr_linenumber" name="304" href="#304">304</a> {
+<a class="jxr_linenumber" name="305" href="#305">305</a> File sroot = <strong class="jxr_keyword">new</strong> File( root );
+<a class="jxr_linenumber" name="306" href="#306">306</a> directories.add( <strong class="jxr_keyword">new</strong> PmdFileInfo( project, sroot, testXref ) );
+<a class="jxr_linenumber" name="307" href="#307">307</a> }
+<a class="jxr_linenumber" name="308" href="#308">308</a> }
+<a class="jxr_linenumber" name="309" href="#309">309</a> }
+<a class="jxr_linenumber" name="310" href="#310">310</a> <strong class="jxr_keyword">if</strong> ( aggregate )
+<a class="jxr_linenumber" name="311" href="#311">311</a> {
+<a class="jxr_linenumber" name="312" href="#312">312</a> <strong class="jxr_keyword">for</strong> ( MavenProject localProject : reactorProjects )
+<a class="jxr_linenumber" name="313" href="#313">313</a> {
+<a class="jxr_linenumber" name="314" href="#314">314</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> ) List<String> localCompileSourceRoots =
+<a class="jxr_linenumber" name="315" href="#315">315</a> localProject.getCompileSourceRoots();
+<a class="jxr_linenumber" name="316" href="#316">316</a> <strong class="jxr_keyword">for</strong> ( String root : localCompileSourceRoots )
+<a class="jxr_linenumber" name="317" href="#317">317</a> {
+<a class="jxr_linenumber" name="318" href="#318">318</a> File sroot = <strong class="jxr_keyword">new</strong> File( root );
+<a class="jxr_linenumber" name="319" href="#319">319</a> directories.add( <strong class="jxr_keyword">new</strong> PmdFileInfo( localProject, sroot, sourceXref ) );
+<a class="jxr_linenumber" name="320" href="#320">320</a> }
+<a class="jxr_linenumber" name="321" href="#321">321</a> <strong class="jxr_keyword">if</strong> ( includeTests )
+<a class="jxr_linenumber" name="322" href="#322">322</a> {
+<a class="jxr_linenumber" name="323" href="#323">323</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> ) List<String> localTestCompileSourceRoots =
+<a class="jxr_linenumber" name="324" href="#324">324</a> localProject.getTestCompileSourceRoots();
+<a class="jxr_linenumber" name="325" href="#325">325</a> <strong class="jxr_keyword">for</strong> ( String root : localTestCompileSourceRoots )
+<a class="jxr_linenumber" name="326" href="#326">326</a> {
+<a class="jxr_linenumber" name="327" href="#327">327</a> File sroot = <strong class="jxr_keyword">new</strong> File( root );
+<a class="jxr_linenumber" name="328" href="#328">328</a> directories.add( <strong class="jxr_keyword">new</strong> PmdFileInfo( localProject, sroot, testXref ) );
+<a class="jxr_linenumber" name="329" href="#329">329</a> }
+<a class="jxr_linenumber" name="330" href="#330">330</a> }
+<a class="jxr_linenumber" name="331" href="#331">331</a> }
+<a class="jxr_linenumber" name="332" href="#332">332</a>
+<a class="jxr_linenumber" name="333" href="#333">333</a> }
+<a class="jxr_linenumber" name="334" href="#334">334</a>
+<a class="jxr_linenumber" name="335" href="#335">335</a> String excluding = getExcludes();
+<a class="jxr_linenumber" name="336" href="#336">336</a> getLog().debug( <span class="jxr_string">"Exclusions: "</span> + excluding );
+<a class="jxr_linenumber" name="337" href="#337">337</a> String including = getIncludes();
+<a class="jxr_linenumber" name="338" href="#338">338</a> getLog().debug( <span class="jxr_string">"Inclusions: "</span> + including );
+<a class="jxr_linenumber" name="339" href="#339">339</a>
+<a class="jxr_linenumber" name="340" href="#340">340</a> Map<File, PmdFileInfo> files = <strong class="jxr_keyword">new</strong> TreeMap<File, PmdFileInfo>();
+<a class="jxr_linenumber" name="341" href="#341">341</a>
+<a class="jxr_linenumber" name="342" href="#342">342</a> <strong class="jxr_keyword">for</strong> ( PmdFileInfo finfo : directories )
+<a class="jxr_linenumber" name="343" href="#343">343</a> {
+<a class="jxr_linenumber" name="344" href="#344">344</a> getLog().debug( <span class="jxr_string">"Searching for files in directory "</span> + finfo.getSourceDirectory().toString() );
+<a class="jxr_linenumber" name="345" href="#345">345</a> File sourceDirectory = finfo.getSourceDirectory();
+<a class="jxr_linenumber" name="346" href="#346">346</a> <strong class="jxr_keyword">if</strong> ( sourceDirectory.isDirectory() && !excludeRootFiles.contains( sourceDirectory ) )
+<a class="jxr_linenumber" name="347" href="#347">347</a> {
+<a class="jxr_linenumber" name="348" href="#348">348</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> ) List<File> newfiles =
+<a class="jxr_linenumber" name="349" href="#349">349</a> FileUtils.getFiles( sourceDirectory, including, excluding );
+<a class="jxr_linenumber" name="350" href="#350">350</a> <strong class="jxr_keyword">for</strong> ( Iterator<File> it2 = newfiles.iterator(); it2.hasNext(); )
+<a class="jxr_linenumber" name="351" href="#351">351</a> {
+<a class="jxr_linenumber" name="352" href="#352">352</a> files.put( it2.next().getCanonicalFile(), finfo );
+<a class="jxr_linenumber" name="353" href="#353">353</a> }
+<a class="jxr_linenumber" name="354" href="#354">354</a> }
+<a class="jxr_linenumber" name="355" href="#355">355</a> }
+<a class="jxr_linenumber" name="356" href="#356">356</a>
+<a class="jxr_linenumber" name="357" href="#357">357</a> <strong class="jxr_keyword">return</strong> files;
+<a class="jxr_linenumber" name="358" href="#358">358</a> }
+<a class="jxr_linenumber" name="359" href="#359">359</a>
+<a class="jxr_linenumber" name="360" href="#360">360</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="361" href="#361">361</a> <em class="jxr_javadoccomment"> * Gets the comma separated list of effective include patterns.</em>
+<a class="jxr_linenumber" name="362" href="#362">362</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="363" href="#363">363</a> <em class="jxr_javadoccomment"> * @return The comma separated list of effective include patterns, never <code>null</code>.</em>
+<a class="jxr_linenumber" name="364" href="#364">364</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="365" href="#365">365</a> <strong class="jxr_keyword">private</strong> String getIncludes()
+<a class="jxr_linenumber" name="366" href="#366">366</a> {
+<a class="jxr_linenumber" name="367" href="#367">367</a> Collection<String> patterns = <strong class="jxr_keyword">new</strong> LinkedHashSet<String>();
+<a class="jxr_linenumber" name="368" href="#368">368</a> <strong class="jxr_keyword">if</strong> ( includes != <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="369" href="#369">369</a> {
+<a class="jxr_linenumber" name="370" href="#370">370</a> patterns.addAll( includes );
+<a class="jxr_linenumber" name="371" href="#371">371</a> }
+<a class="jxr_linenumber" name="372" href="#372">372</a> <strong class="jxr_keyword">if</strong> ( patterns.isEmpty() )
+<a class="jxr_linenumber" name="373" href="#373">373</a> {
+<a class="jxr_linenumber" name="374" href="#374">374</a> patterns.add( <span class="jxr_string">"**/*.java"</span> );
+<a class="jxr_linenumber" name="375" href="#375">375</a> }
+<a class="jxr_linenumber" name="376" href="#376">376</a> <strong class="jxr_keyword">return</strong> StringUtils.join( patterns.iterator(), <span class="jxr_string">","</span> );
+<a class="jxr_linenumber" name="377" href="#377">377</a> }
+<a class="jxr_linenumber" name="378" href="#378">378</a>
+<a class="jxr_linenumber" name="379" href="#379">379</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="380" href="#380">380</a> <em class="jxr_javadoccomment"> * Gets the comma separated list of effective exclude patterns.</em>
+<a class="jxr_linenumber" name="381" href="#381">381</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="382" href="#382">382</a> <em class="jxr_javadoccomment"> * @return The comma separated list of effective exclude patterns, never <code>null</code>.</em>
+<a class="jxr_linenumber" name="383" href="#383">383</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="384" href="#384">384</a> <strong class="jxr_keyword">private</strong> String getExcludes()
+<a class="jxr_linenumber" name="385" href="#385">385</a> {
+<a class="jxr_linenumber" name="386" href="#386">386</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> ) Collection<String> patterns =
+<a class="jxr_linenumber" name="387" href="#387">387</a> <strong class="jxr_keyword">new</strong> LinkedHashSet<String>( FileUtils.getDefaultExcludesAsList() );
+<a class="jxr_linenumber" name="388" href="#388">388</a> <strong class="jxr_keyword">if</strong> ( excludes != <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="389" href="#389">389</a> {
+<a class="jxr_linenumber" name="390" href="#390">390</a> patterns.addAll( excludes );
+<a class="jxr_linenumber" name="391" href="#391">391</a> }
+<a class="jxr_linenumber" name="392" href="#392">392</a> <strong class="jxr_keyword">return</strong> StringUtils.join( patterns.iterator(), <span class="jxr_string">","</span> );
+<a class="jxr_linenumber" name="393" href="#393">393</a> }
+<a class="jxr_linenumber" name="394" href="#394">394</a>
+<a class="jxr_linenumber" name="395" href="#395">395</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isHtml()
+<a class="jxr_linenumber" name="396" href="#396">396</a> {
+<a class="jxr_linenumber" name="397" href="#397">397</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"html"</span>.equals( format );
+<a class="jxr_linenumber" name="398" href="#398">398</a> }
+<a class="jxr_linenumber" name="399" href="#399">399</a>
+<a class="jxr_linenumber" name="400" href="#400">400</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="401" href="#401">401</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em>
+<a class="jxr_linenumber" name="402" href="#402">402</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="403" href="#403">403</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport()
+<a class="jxr_linenumber" name="404" href="#404">404</a> {
+<a class="jxr_linenumber" name="405" href="#405">405</a> <strong class="jxr_keyword">if</strong> ( aggregate && !project.isExecutionRoot() )
+<a class="jxr_linenumber" name="406" href="#406">406</a> {
+<a class="jxr_linenumber" name="407" href="#407">407</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="408" href="#408">408</a> }
+<a class="jxr_linenumber" name="409" href="#409">409</a>
+<a class="jxr_linenumber" name="410" href="#410">410</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"pom"</span>.equals( project.getPackaging() ) && !aggregate )
+<a class="jxr_linenumber" name="411" href="#411">411</a> {
+<a class="jxr_linenumber" name="412" href="#412">412</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="413" href="#413">413</a> }
+<a class="jxr_linenumber" name="414" href="#414">414</a>
+<a class="jxr_linenumber" name="415" href="#415">415</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="416" href="#416">416</a> <em class="jxr_comment">// so the "check" goals can check for failures</em>
+<a class="jxr_linenumber" name="417" href="#417">417</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"xml"</span>.equals( format ) )
+<a class="jxr_linenumber" name="418" href="#418">418</a> {
+<a class="jxr_linenumber" name="419" href="#419">419</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="420" href="#420">420</a> }
+<a class="jxr_linenumber" name="421" href="#421">421</a> <strong class="jxr_keyword">try</strong>
+<a class="jxr_linenumber" name="422" href="#422">422</a> {
+<a class="jxr_linenumber" name="423" href="#423">423</a> Map<File, PmdFileInfo> filesToProcess = getFilesToProcess();
+<a class="jxr_linenumber" name="424" href="#424">424</a> <strong class="jxr_keyword">if</strong> ( filesToProcess.isEmpty() )
+<a class="jxr_linenumber" name="425" href="#425">425</a> {
+<a class="jxr_linenumber" name="426" href="#426">426</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="427" href="#427">427</a> }
+<a class="jxr_linenumber" name="428" href="#428">428</a> }
+<a class="jxr_linenumber" name="429" href="#429">429</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
+<a class="jxr_linenumber" name="430" href="#430">430</a> {
+<a class="jxr_linenumber" name="431" href="#431">431</a> getLog().error( e );
+<a class="jxr_linenumber" name="432" href="#432">432</a> }
+<a class="jxr_linenumber" name="433" href="#433">433</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="434" href="#434">434</a> }
+<a class="jxr_linenumber" name="435" href="#435">435</a>
+<a class="jxr_linenumber" name="436" href="#436">436</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="437" href="#437">437</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em>
+<a class="jxr_linenumber" name="438" href="#438">438</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="439" href="#439">439</a> <strong class="jxr_keyword">protected</strong> String getOutputDirectory()
+<a class="jxr_linenumber" name="440" href="#440">440</a> {
+<a class="jxr_linenumber" name="441" href="#441">441</a> <strong class="jxr_keyword">return</strong> outputDirectory.getAbsolutePath();
+<a class="jxr_linenumber" name="442" href="#442">442</a> }
+<a class="jxr_linenumber" name="443" href="#443">443</a>
+<a class="jxr_linenumber" name="444" href="#444">444</a> <strong class="jxr_keyword">protected</strong> String getSourceEncoding()
+<a class="jxr_linenumber" name="445" href="#445">445</a> {
+<a class="jxr_linenumber" name="446" href="#446">446</a> <strong class="jxr_keyword">return</strong> sourceEncoding;
+<a class="jxr_linenumber" name="447" href="#447">447</a> }
+<a class="jxr_linenumber" name="448" href="#448">448</a>
+<a class="jxr_linenumber" name="449" href="#449">449</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="450" href="#450">450</a> <em class="jxr_javadoccomment"> * Gets the effective reporting output files encoding.</em>
+<a class="jxr_linenumber" name="451" href="#451">451</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="452" href="#452">452</a> <em class="jxr_javadoccomment"> * @return The effective reporting output file encoding, never <code>null</code>.</em>
+<a class="jxr_linenumber" name="453" href="#453">453</a> <em class="jxr_javadoccomment"> * @since 2.5</em>
+<a class="jxr_linenumber" name="454" href="#454">454</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="455" href="#455">455</a> <strong class="jxr_keyword">protected</strong> String getOutputEncoding()
+<a class="jxr_linenumber" name="456" href="#456">456</a> {
+<a class="jxr_linenumber" name="457" href="#457">457</a> <strong class="jxr_keyword">return</strong> ( outputEncoding != <strong class="jxr_keyword">null</strong> ) ? outputEncoding : ReaderFactory.UTF_8;
+<a class="jxr_linenumber" name="458" href="#458">458</a> }
+<a class="jxr_linenumber" name="459" href="#459">459</a>
+<a class="jxr_linenumber" name="460" href="#460">460</a> <strong class="jxr_keyword">static</strong> String getPmdVersion()
+<a class="jxr_linenumber" name="461" href="#461">461</a> {
+<a class="jxr_linenumber" name="462" href="#462">462</a> <strong class="jxr_keyword">try</strong>
+<a class="jxr_linenumber" name="463" href="#463">463</a> {
+<a class="jxr_linenumber" name="464" href="#464">464</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="465" href="#465">465</a> }
+<a class="jxr_linenumber" name="466" href="#466">466</a> <strong class="jxr_keyword">catch</strong> ( IllegalAccessException e )
+<a class="jxr_linenumber" name="467" href="#467">467</a> {
+<a class="jxr_linenumber" name="468" href="#468">468</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="469" href="#469">469</a> }
+<a class="jxr_linenumber" name="470" href="#470">470</a> <strong class="jxr_keyword">catch</strong> ( NoSuchFieldException e )
+<a class="jxr_linenumber" name="471" href="#471">471</a> {
+<a class="jxr_linenumber" name="472" href="#472">472</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="473" href="#473">473</a> }
+<a class="jxr_linenumber" name="474" href="#474">474</a> }
+<a class="jxr_linenumber" name="475" href="#475">475</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
Propchange: websites/production/maven/content/plugins-archives/maven-pmd-plugin-3.1/xref/org/apache/maven/plugin/pmd/AbstractPmdReport.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/maven/content/plugins-archives/maven-pmd-plugin-3.1/xref/org/apache/maven/plugin/pmd/AbstractPmdReport.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision