You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2012/05/08 17:14:51 UTC
svn commit: r816688 [32/33] - in
/websites/production/maventest/content/plugins/maven-pmd-plugin-latest: ./
apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/maven/
apidocs/org/apache/maven/plugin/ apidocs/org/apache/maven/plugin/pmd/
apidoc...
Added: websites/production/maventest/content/plugins/maven-pmd-plugin-latest/xref/org/apache/maven/plugin/pmd/PmdReport.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-pmd-plugin-latest/xref/org/apache/maven/plugin/pmd/PmdReport.html (added)
+++ websites/production/maventest/content/plugins/maven-pmd-plugin-latest/xref/org/apache/maven/plugin/pmd/PmdReport.html Tue May 8 15:14:44 2012
@@ -0,0 +1,586 @@
+<!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=ISO-8859-1" />
+<title>PmdReport xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../../../site/apidocs/org/apache/maven/plugin/pmd/PmdReport.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugin.pmd;
+<a name="2" href="#2">2</a>
+<a name="3" href="#3">3</a> <em class="jxr_comment">/*</em>
+<a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
+<a name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
+<a name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
+<a name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
+<a name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
+<a name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
+<a name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
+<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
+<a 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 name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
+<a name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
+<a name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
+<a name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
+<a name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
+<a name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
+<a name="19" href="#19">19</a> <em class="jxr_comment"> * under the License.</em>
+<a name="20" href="#20">20</a> <em class="jxr_comment"> */</em>
+<a name="21" href="#21">21</a>
+<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.File;
+<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream;
+<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.FileNotFoundException;
+<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.io.FileOutputStream;
+<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
+<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.io.OutputStreamWriter;
+<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.io.Reader;
+<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException;
+<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> java.io.Writer;
+<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> java.util.Iterator;
+<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
+<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> java.util.Map;
+<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> java.util.ResourceBundle;
+<a name="36" href="#36">36</a>
+<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.IRuleViolation;
+<a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.PMD;
+<a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.PMDException;
+<a name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.Report;
+<a name="41" href="#41">41</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.Rule;
+<a name="42" href="#42">42</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.RuleContext;
+<a name="43" href="#43">43</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.RuleSet;
+<a name="44" href="#44">44</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.RuleSetFactory;
+<a name="45" href="#45">45</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.SourceType;
+<a name="46" href="#46">46</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.renderers.CSVRenderer;
+<a name="47" href="#47">47</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.renderers.HTMLRenderer;
+<a name="48" href="#48">48</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.renderers.Renderer;
+<a name="49" href="#49">49</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.renderers.TextRenderer;
+<a name="50" href="#50">50</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.renderers.XMLRenderer;
+<a name="51" href="#51">51</a>
+<a name="52" href="#52">52</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.Sink;
+<a name="53" href="#53">53</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReportException;
+<a name="54" href="#54">54</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.resource.ResourceManager;
+<a name="55" href="#55">55</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.resource.loader.FileResourceCreationException;
+<a name="56" href="#56">56</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.resource.loader.FileResourceLoader;
+<a name="57" href="#57">57</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.resource.loader.ResourceNotFoundException;
+<a name="58" href="#58">58</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.FileUtils;
+<a name="59" href="#59">59</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.IOUtil;
+<a name="60" href="#60">60</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory;
+<a name="61" href="#61">61</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils;
+<a name="62" href="#62">62</a>
+<a name="63" href="#63">63</a> <em class="jxr_javadoccomment">/**</em>
+<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * Creates a PMD report.</em>
+<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> *</em>
+<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * @author Brett Porter</em>
+<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @version $Id$</em>
+<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * @since 2.0</em>
+<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * @goal pmd</em>
+<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> */</em>
+<a name="71" href="#71">71</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugin/pmd/PmdReport.html">PmdReport</a>
+<a name="72" href="#72">72</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugin/pmd/AbstractPmdReport.html">AbstractPmdReport</a>
+<a name="73" href="#73">73</a> {
+<a name="74" href="#74">74</a> <em class="jxr_javadoccomment">/**</em>
+<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * The target JDK to analyze based on. Should match the target used in the compiler plugin. Valid values are</em>
+<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * currently <code>1.3</code>, <code>1.4</code>, <code>1.5</code> and <code>1.6</code>.</em>
+<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * <p></em>
+<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * <b>Note:</b> support for <code>1.6</code> was added in version 2.3 of this plugin.</em>
+<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * </p></em>
+<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> *</em>
+<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * @parameter expression="${targetJdk}"</em>
+<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> */</em>
+<a name="83" href="#83">83</a> <strong class="jxr_keyword">private</strong> String targetJdk;
+<a name="84" href="#84">84</a>
+<a name="85" href="#85">85</a> <em class="jxr_javadoccomment">/**</em>
+<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * The rule priority threshold; rules with lower priority</em>
+<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * than this will not be evaluated.</em>
+<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> *</em>
+<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * @parameter expression="${minimumPriority}" default-value="5"</em>
+<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * @since 2.1</em>
+<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> */</em>
+<a name="92" href="#92">92</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> minimumPriority = 5;
+<a name="93" href="#93">93</a>
+<a name="94" href="#94">94</a> <em class="jxr_javadoccomment">/**</em>
+<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * Skip the PMD report generation. Most useful on the command line</em>
+<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * via "-Dpmd.skip=true".</em>
+<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> *</em>
+<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * @parameter expression="${pmd.skip}" default-value="false"</em>
+<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * @since 2.1</em>
+<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> */</em>
+<a name="101" href="#101">101</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip;
+<a name="102" href="#102">102</a>
+<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">/**</em>
+<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * The PMD rulesets to use. See the <a href="<a href="http://pmd.sourceforge.net/rules/index.html" target="alexandria_uri">http://pmd.sourceforge.net/rules/index.html</a>">Stock Rulesets</a> for a</em>
+<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * list of some included. Since version 2.5, the ruleset "rulesets/maven.xml" is also available. Defaults to the</em>
+<a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * basic, imports and unusedcode rulesets.</em>
+<a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> *</em>
+<a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * @parameter</em>
+<a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> */</em>
+<a name="110" href="#110">110</a> <strong class="jxr_keyword">private</strong> String[] rulesets = <strong class="jxr_keyword">new</strong> String[]{<span class="jxr_string">"rulesets/basic.xml"</span>, <span class="jxr_string">"rulesets/unusedcode.xml"</span>, <span class="jxr_string">"rulesets/imports.xml"</span>, };
+<a name="111" href="#111">111</a>
+<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">/**</em>
+<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * @component</em>
+<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * @required</em>
+<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * @readonly</em>
+<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> */</em>
+<a name="117" href="#117">117</a> <strong class="jxr_keyword">private</strong> ResourceManager locator;
+<a name="118" href="#118">118</a>
+<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a name="120" href="#120">120</a> <strong class="jxr_keyword">public</strong> String getName( Locale locale )
+<a name="121" href="#121">121</a> {
+<a name="122" href="#122">122</a> <strong class="jxr_keyword">return</strong> getBundle( locale ).getString( <span class="jxr_string">"report.pmd.name"</span> );
+<a name="123" href="#123">123</a> }
+<a name="124" href="#124">124</a>
+<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a name="126" href="#126">126</a> <strong class="jxr_keyword">public</strong> String getDescription( Locale locale )
+<a name="127" href="#127">127</a> {
+<a name="128" href="#128">128</a> <strong class="jxr_keyword">return</strong> getBundle( locale ).getString( <span class="jxr_string">"report.pmd.description"</span> );
+<a name="129" href="#129">129</a> }
+<a name="130" href="#130">130</a>
+<a name="131" href="#131">131</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRulesets( String[] rules )
+<a name="132" href="#132">132</a> {
+<a name="133" href="#133">133</a> rulesets = rules;
+<a name="134" href="#134">134</a> }
+<a name="135" href="#135">135</a>
+<a name="136" href="#136">136</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a name="137" href="#137">137</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> executeReport( Locale locale )
+<a name="138" href="#138">138</a> <strong class="jxr_keyword">throws</strong> MavenReportException
+<a name="139" href="#139">139</a> {
+<a name="140" href="#140">140</a> <strong class="jxr_keyword">try</strong>
+<a name="141" href="#141">141</a> {
+<a name="142" href="#142">142</a> execute( locale );
+<a name="143" href="#143">143</a> }
+<a name="144" href="#144">144</a> <strong class="jxr_keyword">finally</strong>
+<a name="145" href="#145">145</a> {
+<a name="146" href="#146">146</a> <strong class="jxr_keyword">if</strong> ( getSink() != <strong class="jxr_keyword">null</strong> )
+<a name="147" href="#147">147</a> {
+<a name="148" href="#148">148</a> getSink().close();
+<a name="149" href="#149">149</a> }
+<a name="150" href="#150">150</a> }
+<a name="151" href="#151">151</a> }
+<a name="152" href="#152">152</a>
+<a name="153" href="#153">153</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> execute( Locale locale )
+<a name="154" href="#154">154</a> <strong class="jxr_keyword">throws</strong> MavenReportException
+<a name="155" href="#155">155</a> {
+<a name="156" href="#156">156</a> <em class="jxr_comment">//configure ResourceManager</em>
+<a name="157" href="#157">157</a> locator.addSearchPath( FileResourceLoader.ID, project.getFile().getParentFile().getAbsolutePath() );
+<a name="158" href="#158">158</a> locator.addSearchPath( <span class="jxr_string">"url"</span>, <span class="jxr_string">""</span> );
+<a name="159" href="#159">159</a> locator.setOutputDirectory( <strong class="jxr_keyword">new</strong> File( project.getBuild().getDirectory() ) );
+<a name="160" href="#160">160</a>
+<a name="161" href="#161">161</a> <strong class="jxr_keyword">if</strong> ( !skip && canGenerateReport() )
+<a name="162" href="#162">162</a> {
+<a name="163" href="#163">163</a> ClassLoader origLoader = Thread.currentThread().getContextClassLoader();
+<a name="164" href="#164">164</a> <strong class="jxr_keyword">try</strong>
+<a name="165" href="#165">165</a> {
+<a name="166" href="#166">166</a> Thread.currentThread().setContextClassLoader( <strong class="jxr_keyword">this</strong>.getClass().getClassLoader() );
+<a name="167" href="#167">167</a>
+<a name="168" href="#168">168</a> Report report = generateReport( locale );
+<a name="169" href="#169">169</a>
+<a name="170" href="#170">170</a> <strong class="jxr_keyword">if</strong> ( !isHtml() )
+<a name="171" href="#171">171</a> {
+<a name="172" href="#172">172</a> writeNonHtml( report );
+<a name="173" href="#173">173</a> }
+<a name="174" href="#174">174</a> }
+<a name="175" href="#175">175</a> <strong class="jxr_keyword">finally</strong>
+<a name="176" href="#176">176</a> {
+<a name="177" href="#177">177</a> Thread.currentThread().setContextClassLoader( origLoader );
+<a name="178" href="#178">178</a> }
+<a name="179" href="#179">179</a> }
+<a name="180" href="#180">180</a> }
+<a name="181" href="#181">181</a>
+<a name="182" href="#182">182</a> <strong class="jxr_keyword">private</strong> Report generateReport( Locale locale )
+<a name="183" href="#183">183</a> <strong class="jxr_keyword">throws</strong> MavenReportException
+<a name="184" href="#184">184</a> {
+<a name="185" href="#185">185</a> Sink sink = getSink();
+<a name="186" href="#186">186</a>
+<a name="187" href="#187">187</a> PMD pmd = getPMD();
+<a name="188" href="#188">188</a> RuleContext ruleContext = <strong class="jxr_keyword">new</strong> RuleContext();
+<a name="189" href="#189">189</a> Report report = <strong class="jxr_keyword">new</strong> Report();
+<a name="190" href="#190">190</a> <a href="../../../../../org/apache/maven/plugin/pmd/PmdReportListener.html">PmdReportListener</a> reportSink = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/pmd/PmdReportListener.html">PmdReportListener</a>( sink, getBundle( locale ), aggregate );
+<a name="191" href="#191">191</a>
+<a name="192" href="#192">192</a> report.addListener( reportSink );
+<a name="193" href="#193">193</a> ruleContext.setReport( report );
+<a name="194" href="#194">194</a> reportSink.beginDocument();
+<a name="195" href="#195">195</a>
+<a name="196" href="#196">196</a> RuleSetFactory ruleSetFactory = <strong class="jxr_keyword">new</strong> RuleSetFactory();
+<a name="197" href="#197">197</a> ruleSetFactory.setMinimumPriority( <strong class="jxr_keyword">this</strong>.minimumPriority );
+<a name="198" href="#198">198</a> RuleSet[] sets = <strong class="jxr_keyword">new</strong> RuleSet[rulesets.length];
+<a name="199" href="#199">199</a> <strong class="jxr_keyword">try</strong>
+<a name="200" href="#200">200</a> {
+<a name="201" href="#201">201</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> idx = 0; idx < rulesets.length; idx++ )
+<a name="202" href="#202">202</a> {
+<a name="203" href="#203">203</a> String set = rulesets[idx];
+<a name="204" href="#204">204</a> getLog().debug( <span class="jxr_string">"Preparing ruleset: "</span> + set );
+<a name="205" href="#205">205</a> File ruleset = locator.getResourceAsFile( set, getLocationTemp( set ) );
+<a name="206" href="#206">206</a>
+<a name="207" href="#207">207</a> <strong class="jxr_keyword">if</strong> ( <strong class="jxr_keyword">null</strong> == ruleset )
+<a name="208" href="#208">208</a> {
+<a name="209" href="#209">209</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Could not resolve "</span> + set );
+<a name="210" href="#210">210</a> }
+<a name="211" href="#211">211</a>
+<a name="212" href="#212">212</a> InputStream rulesInput = <strong class="jxr_keyword">new</strong> FileInputStream( ruleset );
+<a name="213" href="#213">213</a> <strong class="jxr_keyword">try</strong>
+<a name="214" href="#214">214</a> {
+<a name="215" href="#215">215</a> RuleSet ruleSet = ruleSetFactory.createRuleSet( rulesInput );
+<a name="216" href="#216">216</a> sets[idx] = ruleSet;
+<a name="217" href="#217">217</a>
+<a name="218" href="#218">218</a> ruleSet.start( ruleContext );
+<a name="219" href="#219">219</a> }
+<a name="220" href="#220">220</a> <strong class="jxr_keyword">finally</strong>
+<a name="221" href="#221">221</a> {
+<a name="222" href="#222">222</a> rulesInput.close();
+<a name="223" href="#223">223</a> }
+<a name="224" href="#224">224</a> }
+<a name="225" href="#225">225</a> }
+<a name="226" href="#226">226</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
+<a name="227" href="#227">227</a> {
+<a name="228" href="#228">228</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e );
+<a name="229" href="#229">229</a> }
+<a name="230" href="#230">230</a> <strong class="jxr_keyword">catch</strong> ( ResourceNotFoundException e )
+<a name="231" href="#231">231</a> {
+<a name="232" href="#232">232</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e );
+<a name="233" href="#233">233</a> }
+<a name="234" href="#234">234</a> <strong class="jxr_keyword">catch</strong> ( FileResourceCreationException e )
+<a name="235" href="#235">235</a> {
+<a name="236" href="#236">236</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e );
+<a name="237" href="#237">237</a> }
+<a name="238" href="#238">238</a>
+<a name="239" href="#239">239</a> Map files;
+<a name="240" href="#240">240</a> <strong class="jxr_keyword">try</strong>
+<a name="241" href="#241">241</a> {
+<a name="242" href="#242">242</a> files = getFilesToProcess( );
+<a name="243" href="#243">243</a> }
+<a name="244" href="#244">244</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
+<a name="245" href="#245">245</a> {
+<a name="246" href="#246">246</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Can't get file list"</span>, e );
+<a name="247" href="#247">247</a> }
+<a name="248" href="#248">248</a>
+<a name="249" href="#249">249</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( getSourceEncoding() ) && !files.isEmpty() )
+<a name="250" href="#250">250</a> {
+<a name="251" href="#251">251</a> getLog().warn( <span class="jxr_string">"File encoding has not been set, using platform encoding "</span>
+<a name="252" href="#252">252</a> + ReaderFactory.FILE_ENCODING + <span class="jxr_string">", i.e. build is platform dependent!"</span> );
+<a name="253" href="#253">253</a> }
+<a name="254" href="#254">254</a>
+<a name="255" href="#255">255</a> <strong class="jxr_keyword">for</strong> ( Iterator i = files.entrySet().iterator(); i.hasNext(); )
+<a name="256" href="#256">256</a> {
+<a name="257" href="#257">257</a> Map.Entry entry = (Map.Entry) i.next();
+<a name="258" href="#258">258</a> File file = (File) entry.getKey();
+<a name="259" href="#259">259</a> <a href="../../../../../org/apache/maven/plugin/pmd/PmdFileInfo.html">PmdFileInfo</a> fileInfo = (PmdFileInfo) entry.getValue();
+<a name="260" href="#260">260</a>
+<a name="261" href="#261">261</a> <em class="jxr_comment">// TODO: lazily call beginFile in case there are no rules</em>
+<a name="262" href="#262">262</a>
+<a name="263" href="#263">263</a> reportSink.beginFile( file , fileInfo );
+<a name="264" href="#264">264</a> ruleContext.setSourceCodeFilename( file.getAbsolutePath() );
+<a name="265" href="#265">265</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> idx = 0; idx < rulesets.length; idx++ )
+<a name="266" href="#266">266</a> {
+<a name="267" href="#267">267</a> <strong class="jxr_keyword">try</strong>
+<a name="268" href="#268">268</a> {
+<a name="269" href="#269">269</a> <em class="jxr_comment">// PMD closes this Reader even though it did not open it so we have</em>
+<a name="270" href="#270">270</a> <em class="jxr_comment">// to open a new one with every call to processFile().</em>
+<a name="271" href="#271">271</a> Reader reader;
+<a name="272" href="#272">272</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isNotEmpty( getSourceEncoding() ) )
+<a name="273" href="#273">273</a> {
+<a name="274" href="#274">274</a> reader = ReaderFactory.newReader( file, getSourceEncoding() );
+<a name="275" href="#275">275</a> }
+<a name="276" href="#276">276</a> <strong class="jxr_keyword">else</strong>
+<a name="277" href="#277">277</a> {
+<a name="278" href="#278">278</a> reader = ReaderFactory.newPlatformReader( file );
+<a name="279" href="#279">279</a> }
+<a name="280" href="#280">280</a>
+<a name="281" href="#281">281</a> <strong class="jxr_keyword">try</strong>
+<a name="282" href="#282">282</a> {
+<a name="283" href="#283">283</a> pmd.processFile( reader, sets[idx], ruleContext );
+<a name="284" href="#284">284</a> }
+<a name="285" href="#285">285</a> <strong class="jxr_keyword">finally</strong>
+<a name="286" href="#286">286</a> {
+<a name="287" href="#287">287</a> reader.close();
+<a name="288" href="#288">288</a> }
+<a name="289" href="#289">289</a> }
+<a name="290" href="#290">290</a> <strong class="jxr_keyword">catch</strong> ( UnsupportedEncodingException e1 )
+<a name="291" href="#291">291</a> {
+<a name="292" href="#292">292</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Encoding '"</span> + getSourceEncoding() + <span class="jxr_string">"' is not supported."</span>, e1 );
+<a name="293" href="#293">293</a> }
+<a name="294" href="#294">294</a> <strong class="jxr_keyword">catch</strong> ( PMDException pe )
+<a name="295" href="#295">295</a> {
+<a name="296" href="#296">296</a> String msg = pe.getLocalizedMessage();
+<a name="297" href="#297">297</a> Throwable r = pe.getCause();
+<a name="298" href="#298">298</a> <strong class="jxr_keyword">if</strong> ( r != <strong class="jxr_keyword">null</strong> )
+<a name="299" href="#299">299</a> {
+<a name="300" href="#300">300</a> msg = msg + <span class="jxr_string">": "</span> + r.getLocalizedMessage();
+<a name="301" href="#301">301</a> }
+<a name="302" href="#302">302</a> getLog().warn( msg );
+<a name="303" href="#303">303</a> reportSink.ruleViolationAdded( <strong class="jxr_keyword">new</strong> ProcessingErrorRuleViolation( file, msg ) );
+<a name="304" href="#304">304</a> }
+<a name="305" href="#305">305</a> <strong class="jxr_keyword">catch</strong> ( FileNotFoundException e2 )
+<a name="306" href="#306">306</a> {
+<a name="307" href="#307">307</a> getLog().warn( <span class="jxr_string">"Error opening source file: "</span> + file );
+<a name="308" href="#308">308</a> reportSink.ruleViolationAdded(
+<a name="309" href="#309">309</a> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/pmd/PmdReport.html">ProcessingErrorRuleViolation</a>( file, e2.getLocalizedMessage() ) );
+<a name="310" href="#310">310</a> }
+<a name="311" href="#311">311</a> <strong class="jxr_keyword">catch</strong> ( Exception e3 )
+<a name="312" href="#312">312</a> {
+<a name="313" href="#313">313</a> getLog().warn( <span class="jxr_string">"Failure executing PMD for: "</span> + file, e3 );
+<a name="314" href="#314">314</a> reportSink.ruleViolationAdded(
+<a name="315" href="#315">315</a> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/pmd/PmdReport.html">ProcessingErrorRuleViolation</a>( file, e3.getLocalizedMessage() ) );
+<a name="316" href="#316">316</a> }
+<a name="317" href="#317">317</a> }
+<a name="318" href="#318">318</a> reportSink.endFile( file );
+<a name="319" href="#319">319</a> }
+<a name="320" href="#320">320</a>
+<a name="321" href="#321">321</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> idx = 0; idx < rulesets.length; idx++ )
+<a name="322" href="#322">322</a> {
+<a name="323" href="#323">323</a> sets[idx].end( ruleContext );
+<a name="324" href="#324">324</a> }
+<a name="325" href="#325">325</a>
+<a name="326" href="#326">326</a> reportSink.endDocument();
+<a name="327" href="#327">327</a>
+<a name="328" href="#328">328</a> <strong class="jxr_keyword">return</strong> report;
+<a name="329" href="#329">329</a> }
+<a name="330" href="#330">330</a>
+<a name="331" href="#331">331</a> <em class="jxr_javadoccomment">/**</em>
+<a name="332" href="#332">332</a> <em class="jxr_javadoccomment"> * Use the PMD renderers to render in any format aside from HTML.</em>
+<a name="333" href="#333">333</a> <em class="jxr_javadoccomment"> *</em>
+<a name="334" href="#334">334</a> <em class="jxr_javadoccomment"> * @param report</em>
+<a name="335" href="#335">335</a> <em class="jxr_javadoccomment"> * @throws MavenReportException</em>
+<a name="336" href="#336">336</a> <em class="jxr_javadoccomment"> */</em>
+<a name="337" href="#337">337</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeNonHtml( Report report )
+<a name="338" href="#338">338</a> <strong class="jxr_keyword">throws</strong> MavenReportException
+<a name="339" href="#339">339</a> {
+<a name="340" href="#340">340</a> Renderer r = createRenderer();
+<a name="341" href="#341">341</a>
+<a name="342" href="#342">342</a> <strong class="jxr_keyword">if</strong> ( r == <strong class="jxr_keyword">null</strong> )
+<a name="343" href="#343">343</a> {
+<a name="344" href="#344">344</a> <strong class="jxr_keyword">return</strong>;
+<a name="345" href="#345">345</a> }
+<a name="346" href="#346">346</a>
+<a name="347" href="#347">347</a> Writer writer = <strong class="jxr_keyword">null</strong>;
+<a name="348" href="#348">348</a>
+<a name="349" href="#349">349</a> <strong class="jxr_keyword">try</strong>
+<a name="350" href="#350">350</a> {
+<a name="351" href="#351">351</a> File targetFile = <strong class="jxr_keyword">new</strong> File( targetDirectory, <span class="jxr_string">"pmd."</span> + format );
+<a name="352" href="#352">352</a> FileOutputStream tStream = <strong class="jxr_keyword">new</strong> FileOutputStream( targetFile );
+<a name="353" href="#353">353</a> writer = <strong class="jxr_keyword">new</strong> OutputStreamWriter( tStream, getOutputEncoding() );
+<a name="354" href="#354">354</a>
+<a name="355" href="#355">355</a> r.setWriter( writer );
+<a name="356" href="#356">356</a> r.start();
+<a name="357" href="#357">357</a> r.renderFileReport( report );
+<a name="358" href="#358">358</a> r.end();
+<a name="359" href="#359">359</a> writer.close();
+<a name="360" href="#360">360</a>
+<a name="361" href="#361">361</a> File siteDir = getReportOutputDirectory();
+<a name="362" href="#362">362</a> siteDir.mkdirs();
+<a name="363" href="#363">363</a> FileUtils.copyFile( targetFile, <strong class="jxr_keyword">new</strong> File( siteDir, <span class="jxr_string">"pmd."</span> + format ) );
+<a name="364" href="#364">364</a> }
+<a name="365" href="#365">365</a> <strong class="jxr_keyword">catch</strong> ( IOException ioe )
+<a name="366" href="#366">366</a> {
+<a name="367" href="#367">367</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( ioe.getMessage(), ioe );
+<a name="368" href="#368">368</a> }
+<a name="369" href="#369">369</a> <strong class="jxr_keyword">finally</strong>
+<a name="370" href="#370">370</a> {
+<a name="371" href="#371">371</a> IOUtil.close( writer );
+<a name="372" href="#372">372</a> }
+<a name="373" href="#373">373</a> }
+<a name="374" href="#374">374</a>
+<a name="375" href="#375">375</a> <em class="jxr_javadoccomment">/**</em>
+<a name="376" href="#376">376</a> <em class="jxr_javadoccomment"> * Convenience method to get the location of the specified file name.</em>
+<a name="377" href="#377">377</a> <em class="jxr_javadoccomment"> *</em>
+<a name="378" href="#378">378</a> <em class="jxr_javadoccomment"> * @param name the name of the file whose location is to be resolved</em>
+<a name="379" href="#379">379</a> <em class="jxr_javadoccomment"> * @return a String that contains the absolute file name of the file</em>
+<a name="380" href="#380">380</a> <em class="jxr_javadoccomment"> */</em>
+<a name="381" href="#381">381</a> <strong class="jxr_keyword">private</strong> String getLocationTemp( String name )
+<a name="382" href="#382">382</a> {
+<a name="383" href="#383">383</a> String loc = name;
+<a name="384" href="#384">384</a> <strong class="jxr_keyword">if</strong> ( loc.indexOf( '/' ) != -1 )
+<a name="385" href="#385">385</a> {
+<a name="386" href="#386">386</a> loc = loc.substring( loc.lastIndexOf( '/' ) + 1 );
+<a name="387" href="#387">387</a> }
+<a name="388" href="#388">388</a> <strong class="jxr_keyword">if</strong> ( loc.indexOf( '\\' ) != -1 )
+<a name="389" href="#389">389</a> {
+<a name="390" href="#390">390</a> loc = loc.substring( loc.lastIndexOf( '\\' ) + 1 );
+<a name="391" href="#391">391</a> }
+<a name="392" href="#392">392</a> getLog().debug( <span class="jxr_string">"Before: "</span> + name + <span class="jxr_string">" After: "</span> + loc );
+<a name="393" href="#393">393</a> <strong class="jxr_keyword">return</strong> loc;
+<a name="394" href="#394">394</a> }
+<a name="395" href="#395">395</a>
+<a name="396" href="#396">396</a> <em class="jxr_javadoccomment">/**</em>
+<a name="397" href="#397">397</a> <em class="jxr_javadoccomment"> * Constructs the PMD class, passing it an argument</em>
+<a name="398" href="#398">398</a> <em class="jxr_javadoccomment"> * that configures the target JDK.</em>
+<a name="399" href="#399">399</a> <em class="jxr_javadoccomment"> *</em>
+<a name="400" href="#400">400</a> <em class="jxr_javadoccomment"> * @return the resulting PMD</em>
+<a name="401" href="#401">401</a> <em class="jxr_javadoccomment"> * @throws org.apache.maven.reporting.MavenReportException</em>
+<a name="402" href="#402">402</a> <em class="jxr_javadoccomment"> * if targetJdk is not supported</em>
+<a name="403" href="#403">403</a> <em class="jxr_javadoccomment"> */</em>
+<a name="404" href="#404">404</a> <strong class="jxr_keyword">public</strong> PMD getPMD()
+<a name="405" href="#405">405</a> <strong class="jxr_keyword">throws</strong> MavenReportException
+<a name="406" href="#406">406</a> {
+<a name="407" href="#407">407</a> PMD pmd = <strong class="jxr_keyword">new</strong> PMD();
+<a name="408" href="#408">408</a>
+<a name="409" href="#409">409</a> <strong class="jxr_keyword">if</strong> ( <strong class="jxr_keyword">null</strong> != targetJdk )
+<a name="410" href="#410">410</a> {
+<a name="411" href="#411">411</a> SourceType sourceType = SourceType.getSourceTypeForId( <span class="jxr_string">"java "</span> + targetJdk );
+<a name="412" href="#412">412</a> <strong class="jxr_keyword">if</strong> ( sourceType == <strong class="jxr_keyword">null</strong> )
+<a name="413" href="#413">413</a> {
+<a name="414" href="#414">414</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Unsupported targetJdk value '"</span> + targetJdk + <span class="jxr_string">"'."</span> );
+<a name="415" href="#415">415</a> }
+<a name="416" href="#416">416</a> pmd.setJavaVersion( sourceType );
+<a name="417" href="#417">417</a> }
+<a name="418" href="#418">418</a>
+<a name="419" href="#419">419</a> <strong class="jxr_keyword">return</strong> pmd;
+<a name="420" href="#420">420</a> }
+<a name="421" href="#421">421</a>
+<a name="422" href="#422">422</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a name="423" href="#423">423</a> <strong class="jxr_keyword">public</strong> String getOutputName()
+<a name="424" href="#424">424</a> {
+<a name="425" href="#425">425</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"pmd"</span>;
+<a name="426" href="#426">426</a> }
+<a name="427" href="#427">427</a>
+<a name="428" href="#428">428</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> ResourceBundle getBundle( Locale locale )
+<a name="429" href="#429">429</a> {
+<a name="430" href="#430">430</a> <strong class="jxr_keyword">return</strong> ResourceBundle.getBundle( <span class="jxr_string">"pmd-report"</span>, locale, PmdReport.<strong class="jxr_keyword">class</strong>.getClassLoader() );
+<a name="431" href="#431">431</a> }
+<a name="432" href="#432">432</a>
+<a name="433" href="#433">433</a> <em class="jxr_javadoccomment">/**</em>
+<a name="434" href="#434">434</a> <em class="jxr_javadoccomment"> * Create and return the correct renderer for the output type.</em>
+<a name="435" href="#435">435</a> <em class="jxr_javadoccomment"> *</em>
+<a name="436" href="#436">436</a> <em class="jxr_javadoccomment"> * @return the renderer based on the configured output</em>
+<a name="437" href="#437">437</a> <em class="jxr_javadoccomment"> * @throws org.apache.maven.reporting.MavenReportException</em>
+<a name="438" href="#438">438</a> <em class="jxr_javadoccomment"> * if no renderer found for the output type</em>
+<a name="439" href="#439">439</a> <em class="jxr_javadoccomment"> */</em>
+<a name="440" href="#440">440</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> Renderer createRenderer()
+<a name="441" href="#441">441</a> <strong class="jxr_keyword">throws</strong> MavenReportException
+<a name="442" href="#442">442</a> {
+<a name="443" href="#443">443</a> Renderer renderer = <strong class="jxr_keyword">null</strong>;
+<a name="444" href="#444">444</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"xml"</span>.equals( format ) )
+<a name="445" href="#445">445</a> {
+<a name="446" href="#446">446</a> renderer = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/pmd/PmdReport.html">PmdXMLRenderer</a>( getOutputEncoding() );
+<a name="447" href="#447">447</a> }
+<a name="448" href="#448">448</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"txt"</span>.equals( format ) )
+<a name="449" href="#449">449</a> {
+<a name="450" href="#450">450</a> renderer = <strong class="jxr_keyword">new</strong> TextRenderer();
+<a name="451" href="#451">451</a> }
+<a name="452" href="#452">452</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"csv"</span>.equals( format ) )
+<a name="453" href="#453">453</a> {
+<a name="454" href="#454">454</a> renderer = <strong class="jxr_keyword">new</strong> CSVRenderer();
+<a name="455" href="#455">455</a> }
+<a name="456" href="#456">456</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"html"</span>.equals( format ) )
+<a name="457" href="#457">457</a> {
+<a name="458" href="#458">458</a> renderer = <strong class="jxr_keyword">new</strong> HTMLRenderer();
+<a name="459" href="#459">459</a> }
+<a name="460" href="#460">460</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( !<span class="jxr_string">""</span>.equals( format ) && !<span class="jxr_string">"none"</span>.equals( format ) )
+<a name="461" href="#461">461</a> {
+<a name="462" href="#462">462</a> <strong class="jxr_keyword">try</strong>
+<a name="463" href="#463">463</a> {
+<a name="464" href="#464">464</a> renderer = (Renderer) Class.forName( format ).newInstance();
+<a name="465" href="#465">465</a> }
+<a name="466" href="#466">466</a> <strong class="jxr_keyword">catch</strong> ( Exception e )
+<a name="467" href="#467">467</a> {
+<a name="468" href="#468">468</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(
+<a name="469" href="#469">469</a> <span class="jxr_string">"Can't find PMD custom format "</span> + format + <span class="jxr_string">": "</span> + e.getClass().getName(), e );
+<a name="470" href="#470">470</a> }
+<a name="471" href="#471">471</a> }
+<a name="472" href="#472">472</a>
+<a name="473" href="#473">473</a> <strong class="jxr_keyword">return</strong> renderer;
+<a name="474" href="#474">474</a> }
+<a name="475" href="#475">475</a>
+<a name="476" href="#476">476</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugin/pmd/PmdReport.html">PmdXMLRenderer</a> <strong class="jxr_keyword">extends</strong> XMLRenderer
+<a name="477" href="#477">477</a> {
+<a name="478" href="#478">478</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/maven/plugin/pmd/PmdReport.html">PmdXMLRenderer</a>( String encoding )
+<a name="479" href="#479">479</a> {
+<a name="480" href="#480">480</a> <strong class="jxr_keyword">super</strong>();
+<a name="481" href="#481">481</a> <strong class="jxr_keyword">this</strong>.encoding = encoding;
+<a name="482" href="#482">482</a> }
+<a name="483" href="#483">483</a> }
+<a name="484" href="#484">484</a>
+<a name="485" href="#485">485</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> @author <a href="<a href="<a href="mailto:douglass.doug@gmail.com" target="alexandria_uri">mailto:douglass.doug@gmail.com</a>" target="alexandria_uri"><a href="mailto:douglass.doug@gmail.com" target="alexandria_uri">mailto:douglass.doug@gmail.com</a></a>">Doug Douglass</a> */</em>
+<a name="486" href="#486">486</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugin/pmd/PmdReport.html">ProcessingErrorRuleViolation</a>
+<a name="487" href="#487">487</a> implements IRuleViolation
+<a name="488" href="#488">488</a> {
+<a name="489" href="#489">489</a>
+<a name="490" href="#490">490</a> <strong class="jxr_keyword">private</strong> String filename;
+<a name="491" href="#491">491</a>
+<a name="492" href="#492">492</a> <strong class="jxr_keyword">private</strong> String description;
+<a name="493" href="#493">493</a>
+<a name="494" href="#494">494</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/maven/plugin/pmd/PmdReport.html">ProcessingErrorRuleViolation</a>( File file,
+<a name="495" href="#495">495</a> String description )
+<a name="496" href="#496">496</a> {
+<a name="497" href="#497">497</a> filename = file.getPath();
+<a name="498" href="#498">498</a> <strong class="jxr_keyword">this</strong>.description = description;
+<a name="499" href="#499">499</a> }
+<a name="500" href="#500">500</a>
+<a name="501" href="#501">501</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a name="502" href="#502">502</a> <strong class="jxr_keyword">public</strong> String getFilename()
+<a name="503" href="#503">503</a> {
+<a name="504" href="#504">504</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.filename;
+<a name="505" href="#505">505</a> }
+<a name="506" href="#506">506</a>
+<a name="507" href="#507">507</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a name="508" href="#508">508</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getBeginLine()
+<a name="509" href="#509">509</a> {
+<a name="510" href="#510">510</a> <strong class="jxr_keyword">return</strong> 0;
+<a name="511" href="#511">511</a> }
+<a name="512" href="#512">512</a>
+<a name="513" href="#513">513</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a name="514" href="#514">514</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getBeginColumn()
+<a name="515" href="#515">515</a> {
+<a name="516" href="#516">516</a> <strong class="jxr_keyword">return</strong> 0;
+<a name="517" href="#517">517</a> }
+<a name="518" href="#518">518</a>
+<a name="519" href="#519">519</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a name="520" href="#520">520</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getEndLine()
+<a name="521" href="#521">521</a> {
+<a name="522" href="#522">522</a> <strong class="jxr_keyword">return</strong> 0;
+<a name="523" href="#523">523</a> }
+<a name="524" href="#524">524</a>
+<a name="525" href="#525">525</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a name="526" href="#526">526</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getEndColumn()
+<a name="527" href="#527">527</a> {
+<a name="528" href="#528">528</a> <strong class="jxr_keyword">return</strong> 0;
+<a name="529" href="#529">529</a> }
+<a name="530" href="#530">530</a>
+<a name="531" href="#531">531</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a name="532" href="#532">532</a> <strong class="jxr_keyword">public</strong> Rule getRule()
+<a name="533" href="#533">533</a> {
+<a name="534" href="#534">534</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a name="535" href="#535">535</a> }
+<a name="536" href="#536">536</a>
+<a name="537" href="#537">537</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a name="538" href="#538">538</a> <strong class="jxr_keyword">public</strong> String getDescription()
+<a name="539" href="#539">539</a> {
+<a name="540" href="#540">540</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.description;
+<a name="541" href="#541">541</a> }
+<a name="542" href="#542">542</a>
+<a name="543" href="#543">543</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a name="544" href="#544">544</a> <strong class="jxr_keyword">public</strong> String getPackageName()
+<a name="545" href="#545">545</a> {
+<a name="546" href="#546">546</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a name="547" href="#547">547</a> }
+<a name="548" href="#548">548</a>
+<a name="549" href="#549">549</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a name="550" href="#550">550</a> <strong class="jxr_keyword">public</strong> String getMethodName()
+<a name="551" href="#551">551</a> {
+<a name="552" href="#552">552</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a name="553" href="#553">553</a> }
+<a name="554" href="#554">554</a>
+<a name="555" href="#555">555</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a name="556" href="#556">556</a> <strong class="jxr_keyword">public</strong> String getClassName()
+<a name="557" href="#557">557</a> {
+<a name="558" href="#558">558</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a name="559" href="#559">559</a> }
+<a name="560" href="#560">560</a>
+<a name="561" href="#561">561</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a name="562" href="#562">562</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isSuppressed()
+<a name="563" href="#563">563</a> {
+<a name="564" href="#564">564</a> <strong class="jxr_keyword">return</strong> false;
+<a name="565" href="#565">565</a> }
+<a name="566" href="#566">566</a>
+<a name="567" href="#567">567</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a name="568" href="#568">568</a> <strong class="jxr_keyword">public</strong> String getVariableName()
+<a name="569" href="#569">569</a> {
+<a name="570" href="#570">570</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a name="571" href="#571">571</a> }
+<a name="572" href="#572">572</a> }
+<a name="573" href="#573">573</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/maventest/content/plugins/maven-pmd-plugin-latest/xref/org/apache/maven/plugin/pmd/PmdReport.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/maventest/content/plugins/maven-pmd-plugin-latest/xref/org/apache/maven/plugin/pmd/PmdReport.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: websites/production/maventest/content/plugins/maven-pmd-plugin-latest/xref/org/apache/maven/plugin/pmd/PmdReportListener.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-pmd-plugin-latest/xref/org/apache/maven/plugin/pmd/PmdReportListener.html (added)
+++ websites/production/maventest/content/plugins/maven-pmd-plugin-latest/xref/org/apache/maven/plugin/pmd/PmdReportListener.html Tue May 8 15:14:44 2012
@@ -0,0 +1,320 @@
+<!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=ISO-8859-1" />
+<title>PmdReportListener xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../../../site/apidocs/org/apache/maven/plugin/pmd/PmdReportListener.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugin.pmd;
+<a name="2" href="#2">2</a>
+<a name="3" href="#3">3</a> <em class="jxr_comment">/*</em>
+<a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
+<a name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
+<a name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
+<a name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
+<a name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
+<a name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
+<a name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
+<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
+<a 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 name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
+<a name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
+<a name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
+<a name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
+<a name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
+<a name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
+<a name="19" href="#19">19</a> <em class="jxr_comment"> * under the License.</em>
+<a name="20" href="#20">20</a> <em class="jxr_comment"> */</em>
+<a name="21" href="#21">21</a>
+<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.File;
+<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
+<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.Collections;
+<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.Comparator;
+<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.Iterator;
+<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.List;
+<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.ResourceBundle;
+<a name="29" href="#29">29</a>
+<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.IRuleViolation;
+<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.ReportListener;
+<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.stat.Metric;
+<a name="33" href="#33">33</a>
+<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.Sink;
+<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils;
+<a name="36" href="#36">36</a>
+<a name="37" href="#37">37</a> <em class="jxr_javadoccomment">/**</em>
+<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * Handle events from PMD, converting them into Doxia events.</em>
+<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> *</em>
+<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @author Brett Porter</em>
+<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @version $Id$</em>
+<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em>
+<a name="43" href="#43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugin/pmd/PmdReportListener.html">PmdReportListener</a>
+<a name="44" href="#44">44</a> implements ReportListener
+<a name="45" href="#45">45</a> {
+<a name="46" href="#46">46</a> <strong class="jxr_keyword">private</strong> Sink sink;
+<a name="47" href="#47">47</a>
+<a name="48" href="#48">48</a> <strong class="jxr_keyword">private</strong> String currentFilename;
+<a name="49" href="#49">49</a>
+<a name="50" href="#50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> fileInitialized;
+<a name="51" href="#51">51</a>
+<a name="52" href="#52">52</a> <strong class="jxr_keyword">private</strong> ResourceBundle bundle;
+<a name="53" href="#53">53</a>
+<a name="54" href="#54">54</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/maven/plugin/pmd/PmdFileInfo.html">PmdFileInfo</a> fileInfo;
+<a name="55" href="#55">55</a>
+<a name="56" href="#56">56</a> <strong class="jxr_keyword">private</strong> List violations = <strong class="jxr_keyword">new</strong> ArrayList();
+<a name="57" href="#57">57</a>
+<a name="58" href="#58">58</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> aggregate;
+<a name="59" href="#59">59</a>
+<a name="60" href="#60">60</a> <em class="jxr_comment">// The number of erroneous files</em>
+<a name="61" href="#61">61</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> fileCount = 0;
+<a name="62" href="#62">62</a>
+<a name="63" href="#63">63</a> <em class="jxr_comment">//private List metrics = new ArrayList();</em>
+<a name="64" href="#64">64</a>
+<a name="65" href="#65">65</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/maven/plugin/pmd/PmdReportListener.html">PmdReportListener</a>( Sink sink, ResourceBundle bundle, <strong class="jxr_keyword">boolean</strong> aggregate )
+<a name="66" href="#66">66</a> {
+<a name="67" href="#67">67</a> <strong class="jxr_keyword">this</strong>.sink = sink;
+<a name="68" href="#68">68</a> <strong class="jxr_keyword">this</strong>.bundle = bundle;
+<a name="69" href="#69">69</a> <strong class="jxr_keyword">this</strong>.aggregate = aggregate;
+<a name="70" href="#70">70</a> }
+<a name="71" href="#71">71</a>
+<a name="72" href="#72">72</a> <strong class="jxr_keyword">private</strong> String getTitle()
+<a name="73" href="#73">73</a> {
+<a name="74" href="#74">74</a> <strong class="jxr_keyword">return</strong> bundle.getString( <span class="jxr_string">"report.pmd.title"</span> );
+<a name="75" href="#75">75</a> }
+<a name="76" href="#76">76</a>
+<a name="77" href="#77">77</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a name="78" href="#78">78</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> ruleViolationAdded( IRuleViolation ruleViolation )
+<a name="79" href="#79">79</a> {
+<a name="80" href="#80">80</a> <strong class="jxr_keyword">if</strong> ( !fileInitialized )
+<a name="81" href="#81">81</a> {
+<a name="82" href="#82">82</a> sink.section2();
+<a name="83" href="#83">83</a> sink.sectionTitle2();
+<a name="84" href="#84">84</a> String title = currentFilename;
+<a name="85" href="#85">85</a> <strong class="jxr_keyword">if</strong> ( aggregate )
+<a name="86" href="#86">86</a> {
+<a name="87" href="#87">87</a> title = fileInfo.getProject().getName() + <span class="jxr_string">" - "</span> + currentFilename;
+<a name="88" href="#88">88</a> }
+<a name="89" href="#89">89</a> sink.text( title );
+<a name="90" href="#90">90</a> sink.sectionTitle2_();
+<a name="91" href="#91">91</a>
+<a name="92" href="#92">92</a> sink.table();
+<a name="93" href="#93">93</a> sink.tableRow();
+<a name="94" href="#94">94</a> sink.tableHeaderCell();
+<a name="95" href="#95">95</a> sink.text( bundle.getString( <span class="jxr_string">"report.pmd.column.violation"</span> ) );
+<a name="96" href="#96">96</a> sink.tableHeaderCell_();
+<a name="97" href="#97">97</a> sink.tableHeaderCell();
+<a name="98" href="#98">98</a> sink.text( bundle.getString( <span class="jxr_string">"report.pmd.column.line"</span> ) );
+<a name="99" href="#99">99</a> sink.tableHeaderCell_();
+<a name="100" href="#100">100</a> sink.tableRow_();
+<a name="101" href="#101">101</a>
+<a name="102" href="#102">102</a> fileInitialized = <strong class="jxr_keyword">true</strong>;
+<a name="103" href="#103">103</a> }
+<a name="104" href="#104">104</a> violations.add( ruleViolation );
+<a name="105" href="#105">105</a> }
+<a name="106" href="#106">106</a>
+<a name="107" href="#107">107</a> <em class="jxr_comment">// When dealing with multiple rulesets, the violations will get out of order</em>
+<a name="108" href="#108">108</a> <em class="jxr_comment">// wrt their source line number. We re-sort them before writing them to the report.</em>
+<a name="109" href="#109">109</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> processViolations()
+<a name="110" href="#110">110</a> {
+<a name="111" href="#111">111</a> fileCount++;
+<a name="112" href="#112">112</a> Collections.sort( violations, <strong class="jxr_keyword">new</strong> Comparator()
+<a name="113" href="#113">113</a> {
+<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a name="115" href="#115">115</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> compare( Object o1, Object o2 )
+<a name="116" href="#116">116</a> {
+<a name="117" href="#117">117</a> <strong class="jxr_keyword">return</strong> ( (IRuleViolation) o1 ).getBeginLine()
+<a name="118" href="#118">118</a> - ( (IRuleViolation) o2 ).getBeginLine();
+<a name="119" href="#119">119</a> }
+<a name="120" href="#120">120</a> } );
+<a name="121" href="#121">121</a>
+<a name="122" href="#122">122</a> <strong class="jxr_keyword">for</strong> ( Iterator it = violations.iterator(); it.hasNext(); )
+<a name="123" href="#123">123</a> {
+<a name="124" href="#124">124</a> IRuleViolation ruleViolation = (IRuleViolation) it.next();
+<a name="125" href="#125">125</a>
+<a name="126" href="#126">126</a> sink.tableRow();
+<a name="127" href="#127">127</a> sink.tableCell();
+<a name="128" href="#128">128</a> sink.text( ruleViolation.getDescription() );
+<a name="129" href="#129">129</a> sink.tableCell_();
+<a name="130" href="#130">130</a> sink.tableCell();
+<a name="131" href="#131">131</a>
+<a name="132" href="#132">132</a> <strong class="jxr_keyword">int</strong> beginLine = ruleViolation.getBeginLine();
+<a name="133" href="#133">133</a> outputLineLink( beginLine );
+<a name="134" href="#134">134</a> <strong class="jxr_keyword">int</strong> endLine = ruleViolation.getEndLine();
+<a name="135" href="#135">135</a> <strong class="jxr_keyword">if</strong> ( endLine != beginLine )
+<a name="136" href="#136">136</a> {
+<a name="137" href="#137">137</a> sink.text( <span class="jxr_string">" - "</span> );
+<a name="138" href="#138">138</a> outputLineLink( endLine );
+<a name="139" href="#139">139</a> }
+<a name="140" href="#140">140</a>
+<a name="141" href="#141">141</a> sink.tableCell_();
+<a name="142" href="#142">142</a> sink.tableRow_();
+<a name="143" href="#143">143</a> }
+<a name="144" href="#144">144</a> violations.clear();
+<a name="145" href="#145">145</a> }
+<a name="146" href="#146">146</a>
+<a name="147" href="#147">147</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> outputLineLink( <strong class="jxr_keyword">int</strong> line )
+<a name="148" href="#148">148</a> {
+<a name="149" href="#149">149</a> String xrefLocation = fileInfo.getXrefLocation();
+<a name="150" href="#150">150</a> <strong class="jxr_keyword">if</strong> ( xrefLocation != <strong class="jxr_keyword">null</strong> )
+<a name="151" href="#151">151</a> {
+<a name="152" href="#152">152</a> sink.link( xrefLocation + <span class="jxr_string">"/"</span> + currentFilename.replaceAll( <span class="jxr_string">"\\.java$"</span>, <span class="jxr_string">".html"</span> ) + <span class="jxr_string">"#"</span> + line );
+<a name="153" href="#153">153</a> }
+<a name="154" href="#154">154</a> sink.text( String.valueOf( line ) );
+<a name="155" href="#155">155</a> <strong class="jxr_keyword">if</strong> ( xrefLocation != <strong class="jxr_keyword">null</strong> )
+<a name="156" href="#156">156</a> {
+<a name="157" href="#157">157</a> sink.link_();
+<a name="158" href="#158">158</a> }
+<a name="159" href="#159">159</a> }
+<a name="160" href="#160">160</a>
+<a name="161" href="#161">161</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a name="162" href="#162">162</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> metricAdded( Metric metric )
+<a name="163" href="#163">163</a> {
+<a name="164" href="#164">164</a> <em class="jxr_comment">// if ( metric.getCount() != 0 )</em>
+<a name="165" href="#165">165</a> <em class="jxr_comment">// {</em>
+<a name="166" href="#166">166</a> <em class="jxr_comment">// // Skip metrics which have no data</em>
+<a name="167" href="#167">167</a> <em class="jxr_comment">// metrics.add( metric );</em>
+<a name="168" href="#168">168</a> <em class="jxr_comment">// }</em>
+<a name="169" href="#169">169</a> }
+<a name="170" href="#170">170</a>
+<a name="171" href="#171">171</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> beginDocument()
+<a name="172" href="#172">172</a> {
+<a name="173" href="#173">173</a> sink.head();
+<a name="174" href="#174">174</a> sink.title();
+<a name="175" href="#175">175</a> sink.text( getTitle() );
+<a name="176" href="#176">176</a> sink.title_();
+<a name="177" href="#177">177</a> sink.head_();
+<a name="178" href="#178">178</a>
+<a name="179" href="#179">179</a> sink.body();
+<a name="180" href="#180">180</a>
+<a name="181" href="#181">181</a> sink.section1();
+<a name="182" href="#182">182</a> sink.sectionTitle1();
+<a name="183" href="#183">183</a> sink.text( getTitle() );
+<a name="184" href="#184">184</a> sink.sectionTitle1_();
+<a name="185" href="#185">185</a>
+<a name="186" href="#186">186</a> sink.paragraph();
+<a name="187" href="#187">187</a> sink.text( bundle.getString( <span class="jxr_string">"report.pmd.pmdlink"</span> ) + <span class="jxr_string">" "</span> );
+<a name="188" href="#188">188</a> sink.link( <span class="jxr_string">"http://pmd.sourceforge.net/"</span> );
+<a name="189" href="#189">189</a> sink.text( <span class="jxr_string">"PMD"</span> );
+<a name="190" href="#190">190</a> sink.link_();
+<a name="191" href="#191">191</a> sink.text( <span class="jxr_string">" "</span> + AbstractPmdReport.getPmdVersion() + <span class="jxr_string">"."</span> );
+<a name="192" href="#192">192</a> sink.paragraph_();
+<a name="193" href="#193">193</a>
+<a name="194" href="#194">194</a> sink.section1_();
+<a name="195" href="#195">195</a>
+<a name="196" href="#196">196</a> <em class="jxr_comment">// TODO overall summary</em>
+<a name="197" href="#197">197</a>
+<a name="198" href="#198">198</a> sink.section1();
+<a name="199" href="#199">199</a> sink.sectionTitle1();
+<a name="200" href="#200">200</a> sink.text( bundle.getString( <span class="jxr_string">"report.pmd.files"</span> ) );
+<a name="201" href="#201">201</a> sink.sectionTitle1_();
+<a name="202" href="#202">202</a>
+<a name="203" href="#203">203</a> <em class="jxr_comment">// TODO files summary</em>
+<a name="204" href="#204">204</a> }
+<a name="205" href="#205">205</a>
+<a name="206" href="#206">206</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> beginFile( File file, PmdFileInfo finfo )
+<a name="207" href="#207">207</a> {
+<a name="208" href="#208">208</a> fileInfo = finfo;
+<a name="209" href="#209">209</a> currentFilename = StringUtils.substring( file.getAbsolutePath(),
+<a name="210" href="#210">210</a> finfo.getSourceDirectory().getAbsolutePath().length() + 1 );
+<a name="211" href="#211">211</a> currentFilename = StringUtils.replace( currentFilename, <span class="jxr_string">"\\"</span>, <span class="jxr_string">"/"</span> );
+<a name="212" href="#212">212</a> fileInitialized = false;
+<a name="213" href="#213">213</a> }
+<a name="214" href="#214">214</a>
+<a name="215" href="#215">215</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> endFile( File file )
+<a name="216" href="#216">216</a> {
+<a name="217" href="#217">217</a> <strong class="jxr_keyword">if</strong> ( fileInitialized )
+<a name="218" href="#218">218</a> {
+<a name="219" href="#219">219</a> processViolations();
+<a name="220" href="#220">220</a> sink.table_();
+<a name="221" href="#221">221</a> sink.section2_();
+<a name="222" href="#222">222</a> }
+<a name="223" href="#223">223</a> }
+<a name="224" href="#224">224</a>
+<a name="225" href="#225">225</a> <em class="jxr_comment">/*</em>
+<a name="226" href="#226">226</a> <em class="jxr_comment"> private void processMetrics()</em>
+<a name="227" href="#227">227</a> <em class="jxr_comment"> {</em>
+<a name="228" href="#228">228</a> <em class="jxr_comment"> if ( metrics.size() == 0 )</em>
+<a name="229" href="#229">229</a> <em class="jxr_comment"> {</em>
+<a name="230" href="#230">230</a> <em class="jxr_comment"> return;</em>
+<a name="231" href="#231">231</a> <em class="jxr_comment"> }</em>
+<a name="232" href="#232">232</a>
+<a name="233" href="#233">233</a> <em class="jxr_comment"> sink.section1();</em>
+<a name="234" href="#234">234</a> <em class="jxr_comment"> sink.sectionTitle1();</em>
+<a name="235" href="#235">235</a> <em class="jxr_comment"> sink.text( "Metrics" );</em>
+<a name="236" href="#236">236</a> <em class="jxr_comment"> sink.sectionTitle1_();</em>
+<a name="237" href="#237">237</a>
+<a name="238" href="#238">238</a> <em class="jxr_comment"> sink.table();</em>
+<a name="239" href="#239">239</a> <em class="jxr_comment"> sink.tableRow();</em>
+<a name="240" href="#240">240</a> <em class="jxr_comment"> sink.tableHeaderCell();</em>
+<a name="241" href="#241">241</a> <em class="jxr_comment"> sink.text( "Name" );</em>
+<a name="242" href="#242">242</a> <em class="jxr_comment"> sink.tableHeaderCell_();</em>
+<a name="243" href="#243">243</a> <em class="jxr_comment"> sink.tableHeaderCell();</em>
+<a name="244" href="#244">244</a> <em class="jxr_comment"> sink.text( "Count" );</em>
+<a name="245" href="#245">245</a> <em class="jxr_comment"> sink.tableHeaderCell_();</em>
+<a name="246" href="#246">246</a> <em class="jxr_comment"> sink.tableHeaderCell();</em>
+<a name="247" href="#247">247</a> <em class="jxr_comment"> sink.text( "High" );</em>
+<a name="248" href="#248">248</a> <em class="jxr_comment"> sink.tableHeaderCell_();</em>
+<a name="249" href="#249">249</a> <em class="jxr_comment"> sink.tableHeaderCell();</em>
+<a name="250" href="#250">250</a> <em class="jxr_comment"> sink.text( "Low" );</em>
+<a name="251" href="#251">251</a> <em class="jxr_comment"> sink.tableHeaderCell_();</em>
+<a name="252" href="#252">252</a> <em class="jxr_comment"> sink.tableHeaderCell();</em>
+<a name="253" href="#253">253</a> <em class="jxr_comment"> sink.text( "Average" );</em>
+<a name="254" href="#254">254</a> <em class="jxr_comment"> sink.tableHeaderCell_();</em>
+<a name="255" href="#255">255</a> <em class="jxr_comment"> sink.tableRow_();</em>
+<a name="256" href="#256">256</a>
+<a name="257" href="#257">257</a> <em class="jxr_comment"> for ( Iterator iter = metrics.iterator(); iter.hasNext(); )</em>
+<a name="258" href="#258">258</a> <em class="jxr_comment"> {</em>
+<a name="259" href="#259">259</a> <em class="jxr_comment"> Metric met = (Metric) iter.next();</em>
+<a name="260" href="#260">260</a> <em class="jxr_comment"> sink.tableRow();</em>
+<a name="261" href="#261">261</a> <em class="jxr_comment"> sink.tableCell();</em>
+<a name="262" href="#262">262</a> <em class="jxr_comment"> sink.text( met.getMetricName() );</em>
+<a name="263" href="#263">263</a> <em class="jxr_comment"> sink.tableCell_();</em>
+<a name="264" href="#264">264</a> <em class="jxr_comment"> sink.tableCell();</em>
+<a name="265" href="#265">265</a> <em class="jxr_comment"> sink.text( String.valueOf( met.getCount() ) );</em>
+<a name="266" href="#266">266</a> <em class="jxr_comment"> sink.tableCell_();</em>
+<a name="267" href="#267">267</a> <em class="jxr_comment"> sink.tableCell();</em>
+<a name="268" href="#268">268</a> <em class="jxr_comment"> sink.text( String.valueOf( met.getHighValue() ) );</em>
+<a name="269" href="#269">269</a> <em class="jxr_comment"> sink.tableCell_();</em>
+<a name="270" href="#270">270</a> <em class="jxr_comment"> sink.tableCell();</em>
+<a name="271" href="#271">271</a> <em class="jxr_comment"> sink.text( String.valueOf( met.getLowValue() ) );</em>
+<a name="272" href="#272">272</a> <em class="jxr_comment"> sink.tableCell_();</em>
+<a name="273" href="#273">273</a> <em class="jxr_comment"> sink.tableCell();</em>
+<a name="274" href="#274">274</a> <em class="jxr_comment"> sink.text( String.valueOf( met.getAverage() ) );</em>
+<a name="275" href="#275">275</a> <em class="jxr_comment"> sink.tableCell_();</em>
+<a name="276" href="#276">276</a> <em class="jxr_comment"> sink.tableRow_();</em>
+<a name="277" href="#277">277</a> <em class="jxr_comment"> }</em>
+<a name="278" href="#278">278</a> <em class="jxr_comment"> sink.table_();</em>
+<a name="279" href="#279">279</a> <em class="jxr_comment"> sink.section1_();</em>
+<a name="280" href="#280">280</a> <em class="jxr_comment"> }</em>
+<a name="281" href="#281">281</a> <em class="jxr_comment"> */</em>
+<a name="282" href="#282">282</a>
+<a name="283" href="#283">283</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> endDocument()
+<a name="284" href="#284">284</a> {
+<a name="285" href="#285">285</a> <strong class="jxr_keyword">if</strong> ( fileCount == 0 )
+<a name="286" href="#286">286</a> {
+<a name="287" href="#287">287</a> sink.paragraph();
+<a name="288" href="#288">288</a> sink.text( bundle.getString( <span class="jxr_string">"report.pmd.noProblems"</span> ) );
+<a name="289" href="#289">289</a> sink.paragraph_();
+<a name="290" href="#290">290</a> }
+<a name="291" href="#291">291</a>
+<a name="292" href="#292">292</a> sink.section1_();
+<a name="293" href="#293">293</a>
+<a name="294" href="#294">294</a> <em class="jxr_comment">// The Metrics report useless with the current PMD metrics impl.</em>
+<a name="295" href="#295">295</a> <em class="jxr_comment">// For instance, run the coupling ruleset and you will get a boatload</em>
+<a name="296" href="#296">296</a> <em class="jxr_comment">// of excessive imports metrics, none of which is really any use.</em>
+<a name="297" href="#297">297</a> <em class="jxr_comment">// TODO Determine if we are going to just ignore metrics.</em>
+<a name="298" href="#298">298</a>
+<a name="299" href="#299">299</a> <em class="jxr_comment">// processMetrics();</em>
+<a name="300" href="#300">300</a>
+<a name="301" href="#301">301</a> sink.body_();
+<a name="302" href="#302">302</a>
+<a name="303" href="#303">303</a> sink.flush();
+<a name="304" href="#304">304</a>
+<a name="305" href="#305">305</a> sink.close();
+<a name="306" href="#306">306</a> }
+<a name="307" href="#307">307</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/maventest/content/plugins/maven-pmd-plugin-latest/xref/org/apache/maven/plugin/pmd/PmdReportListener.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/maventest/content/plugins/maven-pmd-plugin-latest/xref/org/apache/maven/plugin/pmd/PmdReportListener.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision