maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hbout...@apache.org
Subject svn commit: r816650 [21/23] - in /websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest: ./ apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/maven/ apidocs/org/apache/maven/plugin/ apidocs/org/apache/maven/plugin/chec...
Date Tue, 08 May 2012 13:51:05 GMT
Added: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/CheckstyleReport.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/CheckstyleReport.html (added)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/CheckstyleReport.html Tue May  8 13:51:00 2012
@@ -0,0 +1,1277 @@
+<!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>CheckstyleReport xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../../../site/apidocs/org/apache/maven/plugin/checkstyle/CheckstyleReport.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a>   <strong class="jxr_keyword">package</strong> org.apache.maven.plugin.checkstyle;
+<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> com.puppycrawl.tools.checkstyle.Checker;
+<a name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.ConfigurationLoader;
+<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.DefaultConfiguration;
+<a name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.DefaultLogger;
+<a name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.ModuleFactory;
+<a name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.PackageNamesLoader;
+<a name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.PropertiesExpander;
+<a name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.XMLLogger;
+<a name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.api.AuditListener;
+<a name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.api.CheckstyleException;
+<a name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.api.Configuration;
+<a name="33" href="#33">33</a>  <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.api.FilterSet;
+<a name="34" href="#34">34</a>  <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.api.SeverityLevel;
+<a name="35" href="#35">35</a>  <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.filters.SuppressionsLoader;
+<a name="36" href="#36">36</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.DependencyResolutionRequiredException;
+<a name="37" href="#37">37</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.tools.SiteTool;
+<a name="38" href="#38">38</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.model.ReportPlugin;
+<a name="39" href="#39">39</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
+<a name="40" href="#40">40</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
+<a name="41" href="#41">41</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.AbstractMavenReport;
+<a name="42" href="#42">42</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReportException;
+<a name="43" href="#43">43</a>  <strong class="jxr_keyword">import</strong> org.apache.velocity.VelocityContext;
+<a name="44" href="#44">44</a>  <strong class="jxr_keyword">import</strong> org.apache.velocity.context.Context;
+<a name="45" href="#45">45</a>  <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.ResourceNotFoundException;
+<a name="46" href="#46">46</a>  <strong class="jxr_keyword">import</strong> org.apache.velocity.exception.VelocityException;
+<a name="47" href="#47">47</a>  <strong class="jxr_keyword">import</strong> org.codehaus.doxia.site.renderer.SiteRenderer;
+<a name="48" href="#48">48</a>  <strong class="jxr_keyword">import</strong> org.codehaus.plexus.resource.ResourceManager;
+<a name="49" href="#49">49</a>  <strong class="jxr_keyword">import</strong> org.codehaus.plexus.resource.loader.FileResourceCreationException;
+<a name="50" href="#50">50</a>  <strong class="jxr_keyword">import</strong> org.codehaus.plexus.resource.loader.FileResourceLoader;
+<a name="51" href="#51">51</a>  <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.FileUtils;
+<a name="52" href="#52">52</a>  <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.PathTool;
+<a name="53" href="#53">53</a>  <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringInputStream;
+<a name="54" href="#54">54</a>  <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringOutputStream;
+<a name="55" href="#55">55</a>  <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils;
+<a name="56" href="#56">56</a>  <strong class="jxr_keyword">import</strong> org.codehaus.plexus.velocity.VelocityComponent;
+<a name="57" href="#57">57</a>  
+<a name="58" href="#58">58</a>  <strong class="jxr_keyword">import</strong> java.io.File;
+<a name="59" href="#59">59</a>  <strong class="jxr_keyword">import</strong> java.io.FileInputStream;
+<a name="60" href="#60">60</a>  <strong class="jxr_keyword">import</strong> java.io.FileNotFoundException;
+<a name="61" href="#61">61</a>  <strong class="jxr_keyword">import</strong> java.io.FileOutputStream;
+<a name="62" href="#62">62</a>  <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a name="63" href="#63">63</a>  <strong class="jxr_keyword">import</strong> java.io.OutputStream;
+<a name="64" href="#64">64</a>  <strong class="jxr_keyword">import</strong> java.net.MalformedURLException;
+<a name="65" href="#65">65</a>  <strong class="jxr_keyword">import</strong> java.net.URL;
+<a name="66" href="#66">66</a>  <strong class="jxr_keyword">import</strong> java.net.URLClassLoader;
+<a name="67" href="#67">67</a>  <strong class="jxr_keyword">import</strong> java.util.ArrayList;
+<a name="68" href="#68">68</a>  <strong class="jxr_keyword">import</strong> java.util.Calendar;
+<a name="69" href="#69">69</a>  <strong class="jxr_keyword">import</strong> java.util.Collections;
+<a name="70" href="#70">70</a>  <strong class="jxr_keyword">import</strong> java.util.HashMap;
+<a name="71" href="#71">71</a>  <strong class="jxr_keyword">import</strong> java.util.Iterator;
+<a name="72" href="#72">72</a>  <strong class="jxr_keyword">import</strong> java.util.List;
+<a name="73" href="#73">73</a>  <strong class="jxr_keyword">import</strong> java.util.Locale;
+<a name="74" href="#74">74</a>  <strong class="jxr_keyword">import</strong> java.util.Map;
+<a name="75" href="#75">75</a>  <strong class="jxr_keyword">import</strong> java.util.Properties;
+<a name="76" href="#76">76</a>  <strong class="jxr_keyword">import</strong> java.util.ResourceBundle;
+<a name="77" href="#77">77</a>  
+<a name="78" href="#78">78</a>  <em class="jxr_javadoccomment">/**</em>
+<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment"> * Perform a Checkstyle analysis, and generate a report on violations.</em>
+<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment"> *</em>
+<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="mailto:evenisse@apache.org" target="alexandria_uri">mailto:evenisse@apache.org</a>"&gt;Emmanuel Venisse&lt;/a&gt;</em>
+<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="mailto:vincent.siveton@gmail.com" target="alexandria_uri">mailto:vincent.siveton@gmail.com</a>"&gt;Vincent Siveton&lt;/a&gt;</em>
+<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="mailto:joakim@erdfelt.com" target="alexandria_uri">mailto:joakim@erdfelt.com</a>"&gt;Joakim Erdfelt&lt;/a&gt;</em>
+<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment"> * @goal checkstyle</em>
+<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment"> * @requiresDependencyResolution compile</em>
+<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment"> */</em>
+<a name="87" href="#87">87</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugin/checkstyle/CheckstyleReport.html">CheckstyleReport</a>
+<a name="88" href="#88">88</a>      <strong class="jxr_keyword">extends</strong> AbstractMavenReport
+<a name="89" href="#89">89</a>  {
+<a name="90" href="#90">90</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PLUGIN_RESOURCES = <span class="jxr_string">"org/apache/maven/plugin/checkstyle"</span>;
+<a name="91" href="#91">91</a>  
+<a name="92" href="#92">92</a>      <em class="jxr_javadoccomment">/**</em>
+<a name="93" href="#93">93</a>  <em class="jxr_javadoccomment">     * @deprecated Remove with format parameter.</em>
+<a name="94" href="#94">94</a>  <em class="jxr_javadoccomment">     */</em>
+<a name="95" href="#95">95</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Map FORMAT_TO_CONFIG_LOCATION;
+<a name="96" href="#96">96</a>  
+<a name="97" href="#97">97</a>      <strong class="jxr_keyword">static</strong>
+<a name="98" href="#98">98</a>      {
+<a name="99" href="#99">99</a>          Map fmt2Cfg = <strong class="jxr_keyword">new</strong> HashMap();
+<a name="100" href="#100">100</a> 
+<a name="101" href="#101">101</a>         fmt2Cfg.put( <span class="jxr_string">"sun"</span>, <span class="jxr_string">"config/sun_checks.xml"</span> );
+<a name="102" href="#102">102</a>         fmt2Cfg.put( <span class="jxr_string">"turbine"</span>, <span class="jxr_string">"config/turbine_checks.xml"</span> );
+<a name="103" href="#103">103</a>         fmt2Cfg.put( <span class="jxr_string">"avalon"</span>, <span class="jxr_string">"config/avalon_checks.xml"</span> );
+<a name="104" href="#104">104</a>         fmt2Cfg.put( <span class="jxr_string">"maven"</span>, <span class="jxr_string">"config/maven_checks.xml"</span> );
+<a name="105" href="#105">105</a> 
+<a name="106" href="#106">106</a>         FORMAT_TO_CONFIG_LOCATION = Collections.unmodifiableMap( fmt2Cfg );
+<a name="107" href="#107">107</a>     }
+<a name="108" href="#108">108</a> 
+<a name="109" href="#109">109</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="110" href="#110">110</a> <em class="jxr_javadoccomment">     * Skip entire check.</em>
+<a name="111" href="#111">111</a> <em class="jxr_javadoccomment">     *</em>
+<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">     * @parameter expression="${checkstyle.skip}" default-value="false"</em>
+<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">     * @since 2.2</em>
+<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">     */</em>
+<a name="115" href="#115">115</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip;
+<a name="116" href="#116">116</a> 
+<a name="117" href="#117">117</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">     * The output directory for the report. Note that this parameter is only</em>
+<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">     * evaluated if the goal is run directly from the command line. If the goal</em>
+<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">     * is run indirectly as part of a site generation, the output directory</em>
+<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">     * configured in Maven Site Plugin is used instead.</em>
+<a name="122" href="#122">122</a> <em class="jxr_javadoccomment">     *</em>
+<a name="123" href="#123">123</a> <em class="jxr_javadoccomment">     * @parameter default-value="${project.reporting.outputDirectory}"</em>
+<a name="124" href="#124">124</a> <em class="jxr_javadoccomment">     * @required</em>
+<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">     */</em>
+<a name="126" href="#126">126</a>     <strong class="jxr_keyword">private</strong> File outputDirectory;
+<a name="127" href="#127">127</a> 
+<a name="128" href="#128">128</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="129" href="#129">129</a> <em class="jxr_javadoccomment">     * Specifies if the Rules summary should be enabled or not.</em>
+<a name="130" href="#130">130</a> <em class="jxr_javadoccomment">     *</em>
+<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">     * @parameter expression="${checkstyle.enable.rules.summary}"</em>
+<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">     *            default-value="true"</em>
+<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">     */</em>
+<a name="134" href="#134">134</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> enableRulesSummary;
+<a name="135" href="#135">135</a> 
+<a name="136" href="#136">136</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="137" href="#137">137</a> <em class="jxr_javadoccomment">     * Specifies if the Severity summary should be enabled or not.</em>
+<a name="138" href="#138">138</a> <em class="jxr_javadoccomment">     *</em>
+<a name="139" href="#139">139</a> <em class="jxr_javadoccomment">     * @parameter expression="${checkstyle.enable.severity.summary}"</em>
+<a name="140" href="#140">140</a> <em class="jxr_javadoccomment">     *            default-value="true"</em>
+<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">     */</em>
+<a name="142" href="#142">142</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> enableSeveritySummary;
+<a name="143" href="#143">143</a> 
+<a name="144" href="#144">144</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">     * Specifies if the Files summary should be enabled or not.</em>
+<a name="146" href="#146">146</a> <em class="jxr_javadoccomment">     *</em>
+<a name="147" href="#147">147</a> <em class="jxr_javadoccomment">     * @parameter expression="${checkstyle.enable.files.summary}"</em>
+<a name="148" href="#148">148</a> <em class="jxr_javadoccomment">     *            default-value="true"</em>
+<a name="149" href="#149">149</a> <em class="jxr_javadoccomment">     */</em>
+<a name="150" href="#150">150</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> enableFilesSummary;
+<a name="151" href="#151">151</a> 
+<a name="152" href="#152">152</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="153" href="#153">153</a> <em class="jxr_javadoccomment">     * Specifies if the RSS should be enabled or not.</em>
+<a name="154" href="#154">154</a> <em class="jxr_javadoccomment">     *</em>
+<a name="155" href="#155">155</a> <em class="jxr_javadoccomment">     * @parameter expression="${checkstyle.enable.rss}" default-value="true"</em>
+<a name="156" href="#156">156</a> <em class="jxr_javadoccomment">     */</em>
+<a name="157" href="#157">157</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> enableRSS;
+<a name="158" href="#158">158</a> 
+<a name="159" href="#159">159</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="160" href="#160">160</a> <em class="jxr_javadoccomment">     * Specifies the names filter of the source files to be used for Checkstyle.</em>
+<a name="161" href="#161">161</a> <em class="jxr_javadoccomment">     *</em>
+<a name="162" href="#162">162</a> <em class="jxr_javadoccomment">     * @parameter expression="${checkstyle.includes}" default-value="**\/*.java"</em>
+<a name="163" href="#163">163</a> <em class="jxr_javadoccomment">     * @required</em>
+<a name="164" href="#164">164</a> <em class="jxr_javadoccomment">     */</em>
+<a name="165" href="#165">165</a>     <strong class="jxr_keyword">private</strong> String includes;
+<a name="166" href="#166">166</a> 
+<a name="167" href="#167">167</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="168" href="#168">168</a> <em class="jxr_javadoccomment">     * Specifies the names filter of the source files to be excluded for</em>
+<a name="169" href="#169">169</a> <em class="jxr_javadoccomment">     * Checkstyle.</em>
+<a name="170" href="#170">170</a> <em class="jxr_javadoccomment">     *</em>
+<a name="171" href="#171">171</a> <em class="jxr_javadoccomment">     * @parameter expression="${checkstyle.excludes}"</em>
+<a name="172" href="#172">172</a> <em class="jxr_javadoccomment">     */</em>
+<a name="173" href="#173">173</a>     <strong class="jxr_keyword">private</strong> String excludes;
+<a name="174" href="#174">174</a> 
+<a name="175" href="#175">175</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="176" href="#176">176</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
+<a name="177" href="#177">177</a> <em class="jxr_javadoccomment">     * Specifies the location of the XML configuration to use.</em>
+<a name="178" href="#178">178</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
+<a name="179" href="#179">179</a> <em class="jxr_javadoccomment">     *</em>
+<a name="180" href="#180">180</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
+<a name="181" href="#181">181</a> <em class="jxr_javadoccomment">     * Potential values are a filesystem path, a URL, or a classpath resource.</em>
+<a name="182" href="#182">182</a> <em class="jxr_javadoccomment">     * This parameter expects that the contents of the location conform to the</em>
+<a name="183" href="#183">183</a> <em class="jxr_javadoccomment">     * xml format (Checkstyle &lt;a</em>
+<a name="184" href="#184">184</a> <em class="jxr_javadoccomment">     * href="<a href="http://checkstyle.sourceforge.net/config.html" target="alexandria_uri">http://checkstyle.sourceforge.net/config.html</a>#Modules"&gt;Checker</em>
+<a name="185" href="#185">185</a> <em class="jxr_javadoccomment">     * module&lt;/a&gt;) configuration of rulesets.</em>
+<a name="186" href="#186">186</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
+<a name="187" href="#187">187</a> <em class="jxr_javadoccomment">     *</em>
+<a name="188" href="#188">188</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
+<a name="189" href="#189">189</a> <em class="jxr_javadoccomment">     * This parameter is resolved as resource, URL, then file. If successfully</em>
+<a name="190" href="#190">190</a> <em class="jxr_javadoccomment">     * resolved, the contents of the configuration is copied into the</em>
+<a name="191" href="#191">191</a> <em class="jxr_javadoccomment">     * &lt;code&gt;${project.build.directory}/checkstyle-configuration.xml&lt;/code&gt;</em>
+<a name="192" href="#192">192</a> <em class="jxr_javadoccomment">     * file before being passed to Checkstyle as a configuration.</em>
+<a name="193" href="#193">193</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
+<a name="194" href="#194">194</a> <em class="jxr_javadoccomment">     *</em>
+<a name="195" href="#195">195</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
+<a name="196" href="#196">196</a> <em class="jxr_javadoccomment">     * There are 4 predefined rulesets.</em>
+<a name="197" href="#197">197</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
+<a name="198" href="#198">198</a> <em class="jxr_javadoccomment">     *</em>
+<a name="199" href="#199">199</a> <em class="jxr_javadoccomment">     * &lt;ul&gt;</em>
+<a name="200" href="#200">200</a> <em class="jxr_javadoccomment">     * &lt;li&gt;&lt;code&gt;config/sun_checks.xml&lt;/code&gt;: Sun Checks.&lt;/li&gt;</em>
+<a name="201" href="#201">201</a> <em class="jxr_javadoccomment">     * &lt;li&gt;&lt;code&gt;config/turbine_checks.xml&lt;/code&gt;: Turbine Checks.&lt;/li&gt;</em>
+<a name="202" href="#202">202</a> <em class="jxr_javadoccomment">     * &lt;li&gt;&lt;code&gt;config/avalon_checks.xml&lt;/code&gt;: Avalon Checks.&lt;/li&gt;</em>
+<a name="203" href="#203">203</a> <em class="jxr_javadoccomment">     * &lt;li&gt;&lt;code&gt;config/maven_checks.xml&lt;/code&gt;: Maven Source Checks.&lt;/li&gt;</em>
+<a name="204" href="#204">204</a> <em class="jxr_javadoccomment">     * &lt;/ul&gt;</em>
+<a name="205" href="#205">205</a> <em class="jxr_javadoccomment">     *</em>
+<a name="206" href="#206">206</a> <em class="jxr_javadoccomment">     * @parameter expression="${checkstyle.config.location}"</em>
+<a name="207" href="#207">207</a> <em class="jxr_javadoccomment">     *            default-value="config/sun_checks.xml"</em>
+<a name="208" href="#208">208</a> <em class="jxr_javadoccomment">     */</em>
+<a name="209" href="#209">209</a>     <strong class="jxr_keyword">private</strong> String configLocation;
+<a name="210" href="#210">210</a> 
+<a name="211" href="#211">211</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="212" href="#212">212</a> <em class="jxr_javadoccomment">     * Specifies what predefined check set to use. Available sets are "sun" (for</em>
+<a name="213" href="#213">213</a> <em class="jxr_javadoccomment">     * the Sun coding conventions), "turbine", and "avalon".</em>
+<a name="214" href="#214">214</a> <em class="jxr_javadoccomment">     *</em>
+<a name="215" href="#215">215</a> <em class="jxr_javadoccomment">     * @parameter default-value="sun"</em>
+<a name="216" href="#216">216</a> <em class="jxr_javadoccomment">     * @deprecated Use configLocation instead.</em>
+<a name="217" href="#217">217</a> <em class="jxr_javadoccomment">     */</em>
+<a name="218" href="#218">218</a>     <strong class="jxr_keyword">private</strong> String format;
+<a name="219" href="#219">219</a> 
+<a name="220" href="#220">220</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="221" href="#221">221</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
+<a name="222" href="#222">222</a> <em class="jxr_javadoccomment">     * Specifies the location of the properties file.</em>
+<a name="223" href="#223">223</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
+<a name="224" href="#224">224</a> <em class="jxr_javadoccomment">     *</em>
+<a name="225" href="#225">225</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
+<a name="226" href="#226">226</a> <em class="jxr_javadoccomment">     * This parameter is resolved as URL, File then resource. If successfully</em>
+<a name="227" href="#227">227</a> <em class="jxr_javadoccomment">     * resolved, the contents of the properties location is copied into the</em>
+<a name="228" href="#228">228</a> <em class="jxr_javadoccomment">     * &lt;code&gt;${project.build.directory}/checkstyle-checker.properties&lt;/code&gt;</em>
+<a name="229" href="#229">229</a> <em class="jxr_javadoccomment">     * file before being passed to Checkstyle for loading.</em>
+<a name="230" href="#230">230</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
+<a name="231" href="#231">231</a> <em class="jxr_javadoccomment">     *</em>
+<a name="232" href="#232">232</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
+<a name="233" href="#233">233</a> <em class="jxr_javadoccomment">     * The contents of the &lt;code&gt;propertiesLocation&lt;/code&gt; will be made</em>
+<a name="234" href="#234">234</a> <em class="jxr_javadoccomment">     * available to Checkstyle for specifying values for parameters within the</em>
+<a name="235" href="#235">235</a> <em class="jxr_javadoccomment">     * xml configuration (specified in the &lt;code&gt;configLocation&lt;/code&gt;</em>
+<a name="236" href="#236">236</a> <em class="jxr_javadoccomment">     * parameter).</em>
+<a name="237" href="#237">237</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
+<a name="238" href="#238">238</a> <em class="jxr_javadoccomment">     *</em>
+<a name="239" href="#239">239</a> <em class="jxr_javadoccomment">     * @parameter expression="${checkstyle.properties.location}"</em>
+<a name="240" href="#240">240</a> <em class="jxr_javadoccomment">     * @since 2.0-beta-2</em>
+<a name="241" href="#241">241</a> <em class="jxr_javadoccomment">     */</em>
+<a name="242" href="#242">242</a>     <strong class="jxr_keyword">private</strong> String propertiesLocation;
+<a name="243" href="#243">243</a> 
+<a name="244" href="#244">244</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="245" href="#245">245</a> <em class="jxr_javadoccomment">     * Specifies the location of the Checkstyle properties file that will be used to</em>
+<a name="246" href="#246">246</a> <em class="jxr_javadoccomment">     * check the source.</em>
+<a name="247" href="#247">247</a> <em class="jxr_javadoccomment">     *</em>
+<a name="248" href="#248">248</a> <em class="jxr_javadoccomment">     * @parameter</em>
+<a name="249" href="#249">249</a> <em class="jxr_javadoccomment">     * @deprecated Use propertiesLocation instead.</em>
+<a name="250" href="#250">250</a> <em class="jxr_javadoccomment">     */</em>
+<a name="251" href="#251">251</a>     <strong class="jxr_keyword">private</strong> File propertiesFile;
+<a name="252" href="#252">252</a> 
+<a name="253" href="#253">253</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="254" href="#254">254</a> <em class="jxr_javadoccomment">     * Specifies the URL of the Checkstyle properties that will be used to check</em>
+<a name="255" href="#255">255</a> <em class="jxr_javadoccomment">     * the source.</em>
+<a name="256" href="#256">256</a> <em class="jxr_javadoccomment">     *</em>
+<a name="257" href="#257">257</a> <em class="jxr_javadoccomment">     * @parameter</em>
+<a name="258" href="#258">258</a> <em class="jxr_javadoccomment">     * @deprecated Use propertiesLocation instead.</em>
+<a name="259" href="#259">259</a> <em class="jxr_javadoccomment">     */</em>
+<a name="260" href="#260">260</a>     <strong class="jxr_keyword">private</strong> URL propertiesURL;
+<a name="261" href="#261">261</a> 
+<a name="262" href="#262">262</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="263" href="#263">263</a> <em class="jxr_javadoccomment">     * Allows for specifying raw property expansion information.</em>
+<a name="264" href="#264">264</a> <em class="jxr_javadoccomment">     *</em>
+<a name="265" href="#265">265</a> <em class="jxr_javadoccomment">     * @parameter</em>
+<a name="266" href="#266">266</a> <em class="jxr_javadoccomment">     */</em>
+<a name="267" href="#267">267</a>     <strong class="jxr_keyword">private</strong> String propertyExpansion;
+<a name="268" href="#268">268</a> 
+<a name="269" href="#269">269</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="270" href="#270">270</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
+<a name="271" href="#271">271</a> <em class="jxr_javadoccomment">     * Specifies the location of the License file (a.k.a. the header file) that</em>
+<a name="272" href="#272">272</a> <em class="jxr_javadoccomment">     * can be used by Checkstyle to verify that source code has the correct</em>
+<a name="273" href="#273">273</a> <em class="jxr_javadoccomment">     * license header.</em>
+<a name="274" href="#274">274</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
+<a name="275" href="#275">275</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
+<a name="276" href="#276">276</a> <em class="jxr_javadoccomment">     * You need to use ${checkstyle.header.file} in your Checkstyle xml</em>
+<a name="277" href="#277">277</a> <em class="jxr_javadoccomment">     * configuration to reference the name of this header file.</em>
+<a name="278" href="#278">278</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
+<a name="279" href="#279">279</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
+<a name="280" href="#280">280</a> <em class="jxr_javadoccomment">     * For instance:</em>
+<a name="281" href="#281">281</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
+<a name="282" href="#282">282</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
+<a name="283" href="#283">283</a> <em class="jxr_javadoccomment">     * &lt;code&gt;</em>
+<a name="284" href="#284">284</a> <em class="jxr_javadoccomment">     * &amp;lt;module name="RegexpHeader"&gt;</em>
+<a name="285" href="#285">285</a> <em class="jxr_javadoccomment">     *   &amp;lt;property name="headerFile" value="${checkstyle.header.file}"/&gt;</em>
+<a name="286" href="#286">286</a> <em class="jxr_javadoccomment">     * &amp;lt;/module&gt;</em>
+<a name="287" href="#287">287</a> <em class="jxr_javadoccomment">     * &lt;/code&gt;</em>
+<a name="288" href="#288">288</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
+<a name="289" href="#289">289</a> <em class="jxr_javadoccomment">     *</em>
+<a name="290" href="#290">290</a> <em class="jxr_javadoccomment">     * @parameter expression="${checkstyle.header.file}"</em>
+<a name="291" href="#291">291</a> <em class="jxr_javadoccomment">     *            default-value="LICENSE.txt"</em>
+<a name="292" href="#292">292</a> <em class="jxr_javadoccomment">     * @since 2.0-beta-2</em>
+<a name="293" href="#293">293</a> <em class="jxr_javadoccomment">     */</em>
+<a name="294" href="#294">294</a>     <strong class="jxr_keyword">private</strong> String headerLocation;
+<a name="295" href="#295">295</a> 
+<a name="296" href="#296">296</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="297" href="#297">297</a> <em class="jxr_javadoccomment">     * Specifies the location of the License file (a.k.a. the header file) that</em>
+<a name="298" href="#298">298</a> <em class="jxr_javadoccomment">     * is used by Checkstyle to verify that source code has the correct</em>
+<a name="299" href="#299">299</a> <em class="jxr_javadoccomment">     * license header.</em>
+<a name="300" href="#300">300</a> <em class="jxr_javadoccomment">     *</em>
+<a name="301" href="#301">301</a> <em class="jxr_javadoccomment">     * @parameter expression="${basedir}/LICENSE.txt"</em>
+<a name="302" href="#302">302</a> <em class="jxr_javadoccomment">     * @deprecated Use headerLocation instead.</em>
+<a name="303" href="#303">303</a> <em class="jxr_javadoccomment">     */</em>
+<a name="304" href="#304">304</a>     <strong class="jxr_keyword">private</strong> File headerFile;
+<a name="305" href="#305">305</a> 
+<a name="306" href="#306">306</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="307" href="#307">307</a> <em class="jxr_javadoccomment">     * Specifies the cache file used to speed up Checkstyle on successive runs.</em>
+<a name="308" href="#308">308</a> <em class="jxr_javadoccomment">     *</em>
+<a name="309" href="#309">309</a> <em class="jxr_javadoccomment">     * @parameter default-value="${project.build.directory}/checkstyle-cachefile"</em>
+<a name="310" href="#310">310</a> <em class="jxr_javadoccomment">     */</em>
+<a name="311" href="#311">311</a>     <strong class="jxr_keyword">private</strong> String cacheFile;
+<a name="312" href="#312">312</a> 
+<a name="313" href="#313">313</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="314" href="#314">314</a> <em class="jxr_javadoccomment">     * If &lt;code&gt;null&lt;/code&gt;, the Checkstyle plugin will display violations on stdout.</em>
+<a name="315" href="#315">315</a> <em class="jxr_javadoccomment">     * Otherwise, a text file will be created with the violations.</em>
+<a name="316" href="#316">316</a> <em class="jxr_javadoccomment">     *</em>
+<a name="317" href="#317">317</a> <em class="jxr_javadoccomment">     * @parameter</em>
+<a name="318" href="#318">318</a> <em class="jxr_javadoccomment">     */</em>
+<a name="319" href="#319">319</a>     <strong class="jxr_keyword">private</strong> File useFile;
+<a name="320" href="#320">320</a> 
+<a name="321" href="#321">321</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="322" href="#322">322</a> <em class="jxr_javadoccomment">     * SiteTool.</em>
+<a name="323" href="#323">323</a> <em class="jxr_javadoccomment">     *</em>
+<a name="324" href="#324">324</a> <em class="jxr_javadoccomment">     * @since 2.2</em>
+<a name="325" href="#325">325</a> <em class="jxr_javadoccomment">     * @component role="org.apache.maven.doxia.tools.SiteTool"</em>
+<a name="326" href="#326">326</a> <em class="jxr_javadoccomment">     * @required</em>
+<a name="327" href="#327">327</a> <em class="jxr_javadoccomment">     * @readonly</em>
+<a name="328" href="#328">328</a> <em class="jxr_javadoccomment">     */</em>
+<a name="329" href="#329">329</a>     <strong class="jxr_keyword">protected</strong> SiteTool siteTool;
+<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">     * &lt;p&gt;</em>
+<a name="333" href="#333">333</a> <em class="jxr_javadoccomment">     * Specifies the location of the suppressions XML file to use.</em>
+<a name="334" href="#334">334</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
+<a name="335" href="#335">335</a> <em class="jxr_javadoccomment">     *</em>
+<a name="336" href="#336">336</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
+<a name="337" href="#337">337</a> <em class="jxr_javadoccomment">     * This parameter is resolved as resource, URL, then file. If successfully</em>
+<a name="338" href="#338">338</a> <em class="jxr_javadoccomment">     * resolved, the contents of the suppressions XML is copied into the</em>
+<a name="339" href="#339">339</a> <em class="jxr_javadoccomment">     * &lt;code&gt;${project.build.directory}/checkstyle-supressions.xml&lt;/code&gt; file</em>
+<a name="340" href="#340">340</a> <em class="jxr_javadoccomment">     * before being passed to Checkstyle for loading.</em>
+<a name="341" href="#341">341</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
+<a name="342" href="#342">342</a> <em class="jxr_javadoccomment">     *</em>
+<a name="343" href="#343">343</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
+<a name="344" href="#344">344</a> <em class="jxr_javadoccomment">     * See &lt;code&gt;suppressionsFileExpression&lt;/code&gt; for the property that will</em>
+<a name="345" href="#345">345</a> <em class="jxr_javadoccomment">     * be made available to your checkstyle configuration.</em>
+<a name="346" href="#346">346</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
+<a name="347" href="#347">347</a> <em class="jxr_javadoccomment">     *</em>
+<a name="348" href="#348">348</a> <em class="jxr_javadoccomment">     * @parameter expression="${checkstyle.suppressions.location}"</em>
+<a name="349" href="#349">349</a> <em class="jxr_javadoccomment">     * @since 2.0-beta-2</em>
+<a name="350" href="#350">350</a> <em class="jxr_javadoccomment">     */</em>
+<a name="351" href="#351">351</a>     <strong class="jxr_keyword">private</strong> String suppressionsLocation;
+<a name="352" href="#352">352</a> 
+<a name="353" href="#353">353</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="354" href="#354">354</a> <em class="jxr_javadoccomment">     * The key to be used in the properties for the suppressions file.</em>
+<a name="355" href="#355">355</a> <em class="jxr_javadoccomment">     *</em>
+<a name="356" href="#356">356</a> <em class="jxr_javadoccomment">     * @parameter expression="${checkstyle.suppression.expression}"</em>
+<a name="357" href="#357">357</a> <em class="jxr_javadoccomment">     *            default-value="checkstyle.suppressions.file"</em>
+<a name="358" href="#358">358</a> <em class="jxr_javadoccomment">     * @since 2.1</em>
+<a name="359" href="#359">359</a> <em class="jxr_javadoccomment">     */</em>
+<a name="360" href="#360">360</a>     <strong class="jxr_keyword">private</strong> String suppressionsFileExpression;
+<a name="361" href="#361">361</a> 
+<a name="362" href="#362">362</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="363" href="#363">363</a> <em class="jxr_javadoccomment">     * Specifies the location of the suppressions XML file to use. The plugin</em>
+<a name="364" href="#364">364</a> <em class="jxr_javadoccomment">     * defines a Checkstyle property named</em>
+<a name="365" href="#365">365</a> <em class="jxr_javadoccomment">     * &lt;code&gt;checkstyle.suppressions.file&lt;/code&gt; with the value of this</em>
+<a name="366" href="#366">366</a> <em class="jxr_javadoccomment">     * property. This allows using the Checkstyle property in your own custom</em>
+<a name="367" href="#367">367</a> <em class="jxr_javadoccomment">     * checkstyle configuration file when specifying a suppressions file.</em>
+<a name="368" href="#368">368</a> <em class="jxr_javadoccomment">     *</em>
+<a name="369" href="#369">369</a> <em class="jxr_javadoccomment">     * @parameter</em>
+<a name="370" href="#370">370</a> <em class="jxr_javadoccomment">     * @deprecated Use suppressionsLocation instead.</em>
+<a name="371" href="#371">371</a> <em class="jxr_javadoccomment">     */</em>
+<a name="372" href="#372">372</a>     <strong class="jxr_keyword">private</strong> String suppressionsFile;
+<a name="373" href="#373">373</a> 
+<a name="374" href="#374">374</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="375" href="#375">375</a> <em class="jxr_javadoccomment">     * Specifies the path and filename to save the checkstyle output. The format</em>
+<a name="376" href="#376">376</a> <em class="jxr_javadoccomment">     * of the output file is determined by the &lt;code&gt;outputFileFormat&lt;/code&gt;</em>
+<a name="377" href="#377">377</a> <em class="jxr_javadoccomment">     * parameter.</em>
+<a name="378" href="#378">378</a> <em class="jxr_javadoccomment">     *</em>
+<a name="379" href="#379">379</a> <em class="jxr_javadoccomment">     * @parameter expression="${checkstyle.output.file}"</em>
+<a name="380" href="#380">380</a> <em class="jxr_javadoccomment">     *            default-value="${project.build.directory}/checkstyle-result.xml"</em>
+<a name="381" href="#381">381</a> <em class="jxr_javadoccomment">     */</em>
+<a name="382" href="#382">382</a>     <strong class="jxr_keyword">private</strong> File outputFile;
+<a name="383" href="#383">383</a> 
+<a name="384" href="#384">384</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="385" href="#385">385</a> <em class="jxr_javadoccomment">     * Specifies the format of the output to be used when writing to the output</em>
+<a name="386" href="#386">386</a> <em class="jxr_javadoccomment">     * file. Valid values are "plain" and "xml".</em>
+<a name="387" href="#387">387</a> <em class="jxr_javadoccomment">     *</em>
+<a name="388" href="#388">388</a> <em class="jxr_javadoccomment">     * @parameter expression="${checkstyle.output.format}" default-value="xml"</em>
+<a name="389" href="#389">389</a> <em class="jxr_javadoccomment">     */</em>
+<a name="390" href="#390">390</a>     <strong class="jxr_keyword">private</strong> String outputFileFormat;
+<a name="391" href="#391">391</a> 
+<a name="392" href="#392">392</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="393" href="#393">393</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
+<a name="394" href="#394">394</a> <em class="jxr_javadoccomment">     * Specifies the location of the package names XML to be used to configure</em>
+<a name="395" href="#395">395</a> <em class="jxr_javadoccomment">     * the Checkstyle &lt;a</em>
+<a name="396" href="#396">396</a> <em class="jxr_javadoccomment">     * href="<a href="http://checkstyle.sourceforge.net/config.html" target="alexandria_uri">http://checkstyle.sourceforge.net/config.html</a>#Packages"&gt;Packages&lt;/a&gt;.</em>
+<a name="397" href="#397">397</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
+<a name="398" href="#398">398</a> <em class="jxr_javadoccomment">     *</em>
+<a name="399" href="#399">399</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
+<a name="400" href="#400">400</a> <em class="jxr_javadoccomment">     * This parameter is resolved as resource, URL, then file. If resolved to a</em>
+<a name="401" href="#401">401</a> <em class="jxr_javadoccomment">     * resource, or a URL, the contents of the package names XML is copied into</em>
+<a name="402" href="#402">402</a> <em class="jxr_javadoccomment">     * the &lt;code&gt;${project.build.directory}/checkstyle-packagenames.xml&lt;/code&gt;</em>
+<a name="403" href="#403">403</a> <em class="jxr_javadoccomment">     * file before being passed to Checkstyle for loading.</em>
+<a name="404" href="#404">404</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
+<a name="405" href="#405">405</a> <em class="jxr_javadoccomment">     *</em>
+<a name="406" href="#406">406</a> <em class="jxr_javadoccomment">     * @parameter</em>
+<a name="407" href="#407">407</a> <em class="jxr_javadoccomment">     * @since 2.0-beta-2</em>
+<a name="408" href="#408">408</a> <em class="jxr_javadoccomment">     */</em>
+<a name="409" href="#409">409</a>     <strong class="jxr_keyword">private</strong> String packageNamesLocation;
+<a name="410" href="#410">410</a> 
+<a name="411" href="#411">411</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="412" href="#412">412</a> <em class="jxr_javadoccomment">     * Specifies the location of the package names XML to be used to configure</em>
+<a name="413" href="#413">413</a> <em class="jxr_javadoccomment">     * Checkstyle.</em>
+<a name="414" href="#414">414</a> <em class="jxr_javadoccomment">     *</em>
+<a name="415" href="#415">415</a> <em class="jxr_javadoccomment">     * @parameter</em>
+<a name="416" href="#416">416</a> <em class="jxr_javadoccomment">     * @deprecated Use packageNamesLocation instead.</em>
+<a name="417" href="#417">417</a> <em class="jxr_javadoccomment">     */</em>
+<a name="418" href="#418">418</a>     <strong class="jxr_keyword">private</strong> String packageNamesFile;
+<a name="419" href="#419">419</a> 
+<a name="420" href="#420">420</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="421" href="#421">421</a> <em class="jxr_javadoccomment">     * Specifies if the build should fail upon a violation.</em>
+<a name="422" href="#422">422</a> <em class="jxr_javadoccomment">     *</em>
+<a name="423" href="#423">423</a> <em class="jxr_javadoccomment">     * @parameter default-value="false"</em>
+<a name="424" href="#424">424</a> <em class="jxr_javadoccomment">     */</em>
+<a name="425" href="#425">425</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> failsOnError;
+<a name="426" href="#426">426</a> 
+<a name="427" href="#427">427</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="428" href="#428">428</a> <em class="jxr_javadoccomment">     * Specifies the location of the source directory to be used for Checkstyle.</em>
+<a name="429" href="#429">429</a> <em class="jxr_javadoccomment">     *</em>
+<a name="430" href="#430">430</a> <em class="jxr_javadoccomment">     * @parameter default-value="${project.build.sourceDirectory}"</em>
+<a name="431" href="#431">431</a> <em class="jxr_javadoccomment">     * @required</em>
+<a name="432" href="#432">432</a> <em class="jxr_javadoccomment">     */</em>
+<a name="433" href="#433">433</a>     <strong class="jxr_keyword">private</strong> File sourceDirectory;
+<a name="434" href="#434">434</a> 
+<a name="435" href="#435">435</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="436" href="#436">436</a> <em class="jxr_javadoccomment">     * Specifies the location of the test source directory to be used for</em>
+<a name="437" href="#437">437</a> <em class="jxr_javadoccomment">     * Checkstyle.</em>
+<a name="438" href="#438">438</a> <em class="jxr_javadoccomment">     *</em>
+<a name="439" href="#439">439</a> <em class="jxr_javadoccomment">     * @parameter default-value="${project.build.testSourceDirectory}"</em>
+<a name="440" href="#440">440</a> <em class="jxr_javadoccomment">     * @since 2.2</em>
+<a name="441" href="#441">441</a> <em class="jxr_javadoccomment">     */</em>
+<a name="442" href="#442">442</a>     <strong class="jxr_keyword">private</strong> File testSourceDirectory;
+<a name="443" href="#443">443</a> 
+<a name="444" href="#444">444</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="445" href="#445">445</a> <em class="jxr_javadoccomment">     * Include or not the test source directory to be used for Checkstyle.</em>
+<a name="446" href="#446">446</a> <em class="jxr_javadoccomment">     *</em>
+<a name="447" href="#447">447</a> <em class="jxr_javadoccomment">     * @parameter default-value="${false}"</em>
+<a name="448" href="#448">448</a> <em class="jxr_javadoccomment">     * @since 2.2</em>
+<a name="449" href="#449">449</a> <em class="jxr_javadoccomment">     */</em>
+<a name="450" href="#450">450</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> includeTestSourceDirectory;
+<a name="451" href="#451">451</a> 
+<a name="452" href="#452">452</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="453" href="#453">453</a> <em class="jxr_javadoccomment">     * The Maven Project Object.</em>
+<a name="454" href="#454">454</a> <em class="jxr_javadoccomment">     *</em>
+<a name="455" href="#455">455</a> <em class="jxr_javadoccomment">     * @parameter default-value="${project}"</em>
+<a name="456" href="#456">456</a> <em class="jxr_javadoccomment">     * @required</em>
+<a name="457" href="#457">457</a> <em class="jxr_javadoccomment">     * @readonly</em>
+<a name="458" href="#458">458</a> <em class="jxr_javadoccomment">     */</em>
+<a name="459" href="#459">459</a>     <strong class="jxr_keyword">private</strong> MavenProject project;
+<a name="460" href="#460">460</a> 
+<a name="461" href="#461">461</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="462" href="#462">462</a> <em class="jxr_javadoccomment">     * Output errors to console.</em>
+<a name="463" href="#463">463</a> <em class="jxr_javadoccomment">     *</em>
+<a name="464" href="#464">464</a> <em class="jxr_javadoccomment">     * @parameter default-value="false"</em>
+<a name="465" href="#465">465</a> <em class="jxr_javadoccomment">     */</em>
+<a name="466" href="#466">466</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> consoleOutput;
+<a name="467" href="#467">467</a> 
+<a name="468" href="#468">468</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="469" href="#469">469</a> <em class="jxr_javadoccomment">     * Link the violation line numbers to the source xref. Will link</em>
+<a name="470" href="#470">470</a> <em class="jxr_javadoccomment">     * automatically if Maven JXR plugin is being used.</em>
+<a name="471" href="#471">471</a> <em class="jxr_javadoccomment">     *</em>
+<a name="472" href="#472">472</a> <em class="jxr_javadoccomment">     * @parameter expression="${linkXRef}" default-value="true"</em>
+<a name="473" href="#473">473</a> <em class="jxr_javadoccomment">     * @since 2.1</em>
+<a name="474" href="#474">474</a> <em class="jxr_javadoccomment">     */</em>
+<a name="475" href="#475">475</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> linkXRef;
+<a name="476" href="#476">476</a> 
+<a name="477" href="#477">477</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="478" href="#478">478</a> <em class="jxr_javadoccomment">     * Location of the Xrefs to link to.</em>
+<a name="479" href="#479">479</a> <em class="jxr_javadoccomment">     *</em>
+<a name="480" href="#480">480</a> <em class="jxr_javadoccomment">     * @parameter default-value="${project.reporting.outputDirectory}/xref"</em>
+<a name="481" href="#481">481</a> <em class="jxr_javadoccomment">     */</em>
+<a name="482" href="#482">482</a>     <strong class="jxr_keyword">private</strong> File xrefLocation;
+<a name="483" href="#483">483</a> 
+<a name="484" href="#484">484</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="485" href="#485">485</a> <em class="jxr_javadoccomment">     * The file encoding to use when reading the source files. If the property &lt;code&gt;project.build.sourceEncoding&lt;/code&gt;</em>
+<a name="486" href="#486">486</a> <em class="jxr_javadoccomment">     * is not set, the platform default encoding is used. &lt;strong&gt;Note:&lt;/strong&gt; This parameter always overrides the</em>
+<a name="487" href="#487">487</a> <em class="jxr_javadoccomment">     * property &lt;code&gt;charset&lt;/code&gt; from Checkstyle's &lt;code&gt;TreeWalker&lt;/code&gt; module.</em>
+<a name="488" href="#488">488</a> <em class="jxr_javadoccomment">     * </em>
+<a name="489" href="#489">489</a> <em class="jxr_javadoccomment">     * @parameter expression="${encoding}" default-value="${project.build.sourceEncoding}"</em>
+<a name="490" href="#490">490</a> <em class="jxr_javadoccomment">     * @since 2.2</em>
+<a name="491" href="#491">491</a> <em class="jxr_javadoccomment">     */</em>
+<a name="492" href="#492">492</a>     <strong class="jxr_keyword">private</strong> String encoding;
+<a name="493" href="#493">493</a> 
+<a name="494" href="#494">494</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="495" href="#495">495</a> <em class="jxr_javadoccomment">     * @component</em>
+<a name="496" href="#496">496</a> <em class="jxr_javadoccomment">     * @required</em>
+<a name="497" href="#497">497</a> <em class="jxr_javadoccomment">     * @readonly</em>
+<a name="498" href="#498">498</a> <em class="jxr_javadoccomment">     */</em>
+<a name="499" href="#499">499</a>     <strong class="jxr_keyword">private</strong> SiteRenderer siteRenderer;
+<a name="500" href="#500">500</a> 
+<a name="501" href="#501">501</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="502" href="#502">502</a> <em class="jxr_javadoccomment">     * Velocity Component.</em>
+<a name="503" href="#503">503</a> <em class="jxr_javadoccomment">     *</em>
+<a name="504" href="#504">504</a> <em class="jxr_javadoccomment">     * @component role="org.codehaus.plexus.velocity.VelocityComponent"</em>
+<a name="505" href="#505">505</a> <em class="jxr_javadoccomment">     * @required</em>
+<a name="506" href="#506">506</a> <em class="jxr_javadoccomment">     */</em>
+<a name="507" href="#507">507</a>     <strong class="jxr_keyword">private</strong> VelocityComponent velocityComponent;
+<a name="508" href="#508">508</a> 
+<a name="509" href="#509">509</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> File[] EMPTY_FILE_ARRAY = <strong class="jxr_keyword">new</strong> File[0];
+<a name="510" href="#510">510</a> 
+<a name="511" href="#511">511</a>     <strong class="jxr_keyword">private</strong> StringOutputStream stringOutputStream;
+<a name="512" href="#512">512</a> 
+<a name="513" href="#513">513</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="514" href="#514">514</a> <em class="jxr_javadoccomment">     * @component</em>
+<a name="515" href="#515">515</a> <em class="jxr_javadoccomment">     * @required</em>
+<a name="516" href="#516">516</a> <em class="jxr_javadoccomment">     * @readonly</em>
+<a name="517" href="#517">517</a> <em class="jxr_javadoccomment">     */</em>
+<a name="518" href="#518">518</a>     <strong class="jxr_keyword">private</strong> ResourceManager locator;
+<a name="519" href="#519">519</a> 
+<a name="520" href="#520">520</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="521" href="#521">521</a> <em class="jxr_javadoccomment">     * @see org.apache.maven.reporting.MavenReport#getName(java.util.Locale)</em>
+<a name="522" href="#522">522</a> <em class="jxr_javadoccomment">     */</em>
+<a name="523" href="#523">523</a>     <strong class="jxr_keyword">public</strong> String getName( Locale locale )
+<a name="524" href="#524">524</a>     {
+<a name="525" href="#525">525</a>         <strong class="jxr_keyword">return</strong> getBundle( locale ).getString( <span class="jxr_string">"report.checkstyle.name"</span> );
+<a name="526" href="#526">526</a>     }
+<a name="527" href="#527">527</a> 
+<a name="528" href="#528">528</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="529" href="#529">529</a> <em class="jxr_javadoccomment">     * @see org.apache.maven.reporting.MavenReport#getDescription(java.util.Locale)</em>
+<a name="530" href="#530">530</a> <em class="jxr_javadoccomment">     */</em>
+<a name="531" href="#531">531</a>     <strong class="jxr_keyword">public</strong> String getDescription( Locale locale )
+<a name="532" href="#532">532</a>     {
+<a name="533" href="#533">533</a>         <strong class="jxr_keyword">return</strong> getBundle( locale ).getString( <span class="jxr_string">"report.checkstyle.description"</span> );
+<a name="534" href="#534">534</a>     }
+<a name="535" href="#535">535</a> 
+<a name="536" href="#536">536</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="537" href="#537">537</a> <em class="jxr_javadoccomment">     * @see org.apache.maven.reporting.AbstractMavenReport#getOutputDirectory()</em>
+<a name="538" href="#538">538</a> <em class="jxr_javadoccomment">     */</em>
+<a name="539" href="#539">539</a>     <strong class="jxr_keyword">protected</strong> String getOutputDirectory()
+<a name="540" href="#540">540</a>     {
+<a name="541" href="#541">541</a>         <strong class="jxr_keyword">return</strong> outputDirectory.getAbsolutePath();
+<a name="542" href="#542">542</a>     }
+<a name="543" href="#543">543</a> 
+<a name="544" href="#544">544</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="545" href="#545">545</a> <em class="jxr_javadoccomment">     * @see org.apache.maven.reporting.AbstractMavenReport#getProject()</em>
+<a name="546" href="#546">546</a> <em class="jxr_javadoccomment">     */</em>
+<a name="547" href="#547">547</a>     <strong class="jxr_keyword">protected</strong> MavenProject getProject()
+<a name="548" href="#548">548</a>     {
+<a name="549" href="#549">549</a>         <strong class="jxr_keyword">return</strong> project;
+<a name="550" href="#550">550</a>     }
+<a name="551" href="#551">551</a> 
+<a name="552" href="#552">552</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="553" href="#553">553</a> <em class="jxr_javadoccomment">     * @see org.apache.maven.reporting.AbstractMavenReport#getSiteRenderer()</em>
+<a name="554" href="#554">554</a> <em class="jxr_javadoccomment">     */</em>
+<a name="555" href="#555">555</a>     <strong class="jxr_keyword">protected</strong> SiteRenderer getSiteRenderer()
+<a name="556" href="#556">556</a>     {
+<a name="557" href="#557">557</a>         <strong class="jxr_keyword">return</strong> siteRenderer;
+<a name="558" href="#558">558</a>     }
+<a name="559" href="#559">559</a> 
+<a name="560" href="#560">560</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="561" href="#561">561</a> <em class="jxr_javadoccomment">     * @see org.apache.maven.reporting.AbstractMavenReport#executeReport(java.util.Locale)</em>
+<a name="562" href="#562">562</a> <em class="jxr_javadoccomment">     */</em>
+<a name="563" href="#563">563</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> executeReport( Locale locale )
+<a name="564" href="#564">564</a>         <strong class="jxr_keyword">throws</strong> MavenReportException
+<a name="565" href="#565">565</a>     {
+<a name="566" href="#566">566</a>         <strong class="jxr_keyword">if</strong> ( !skip )
+<a name="567" href="#567">567</a>         {
+<a name="568" href="#568">568</a>             mergeDeprecatedInfo();
+<a name="569" href="#569">569</a> 
+<a name="570" href="#570">570</a>             locator.addSearchPath( FileResourceLoader.ID, project.getFile().getParentFile().getAbsolutePath() );
+<a name="571" href="#571">571</a>             locator.addSearchPath( <span class="jxr_string">"url"</span>, <span class="jxr_string">""</span> );
+<a name="572" href="#572">572</a> 
+<a name="573" href="#573">573</a>             locator.setOutputDirectory( <strong class="jxr_keyword">new</strong> File( project.getBuild().getDirectory() ) );
+<a name="574" href="#574">574</a> 
+<a name="575" href="#575">575</a>             <strong class="jxr_keyword">if</strong> ( !canGenerateReport() )
+<a name="576" href="#576">576</a>             {
+<a name="577" href="#577">577</a>                 getLog().info( <span class="jxr_string">"Source directory does not exist - skipping report."</span> );
+<a name="578" href="#578">578</a>                 <strong class="jxr_keyword">return</strong>;
+<a name="579" href="#579">579</a>             }
+<a name="580" href="#580">580</a> 
+<a name="581" href="#581">581</a>             <em class="jxr_comment">// for when we start using maven-shared-io and</em>
+<a name="582" href="#582">582</a>             <em class="jxr_comment">// maven-shared-monitor...</em>
+<a name="583" href="#583">583</a>             <em class="jxr_comment">// locator = new Locator( new MojoLogMonitorAdaptor( getLog() ) );</em>
+<a name="584" href="#584">584</a> 
+<a name="585" href="#585">585</a>             <em class="jxr_comment">// locator = new Locator( getLog(), new File(</em>
+<a name="586" href="#586">586</a>             <em class="jxr_comment">// project.getBuild().getDirectory() ) );</em>
+<a name="587" href="#587">587</a> 
+<a name="588" href="#588">588</a>             ClassLoader currentClassLoader = Thread.currentThread().getContextClassLoader();
+<a name="589" href="#589">589</a> 
+<a name="590" href="#590">590</a>             <strong class="jxr_keyword">try</strong>
+<a name="591" href="#591">591</a>             {
+<a name="592" href="#592">592</a>                 <em class="jxr_comment">// checkstyle will always use the context classloader in order</em>
+<a name="593" href="#593">593</a>                 <em class="jxr_comment">// to load resources (dtds),</em>
+<a name="594" href="#594">594</a>                 <em class="jxr_comment">// so we have to fix it</em>
+<a name="595" href="#595">595</a>                 ClassLoader checkstyleClassLoader = PackageNamesLoader.<strong class="jxr_keyword">class</strong>.getClassLoader();
+<a name="596" href="#596">596</a>                 Thread.currentThread().setContextClassLoader( checkstyleClassLoader );
+<a name="597" href="#597">597</a> 
+<a name="598" href="#598">598</a> 
+<a name="599" href="#599">599</a>                 String configFile = getConfigFile();
+<a name="600" href="#600">600</a>                 Properties overridingProperties = getOverridingProperties();
+<a name="601" href="#601">601</a>                 ModuleFactory moduleFactory;
+<a name="602" href="#602">602</a>                 Configuration config;
+<a name="603" href="#603">603</a>                 <a href="../../../../../org/apache/maven/plugin/checkstyle/CheckstyleResults.html">CheckstyleResults</a> results;
+<a name="604" href="#604">604</a> 
+<a name="605" href="#605">605</a>                 moduleFactory = getModuleFactory();
+<a name="606" href="#606">606</a> 
+<a name="607" href="#607">607</a>                 config = ConfigurationLoader.loadConfiguration( configFile,
+<a name="608" href="#608">608</a>                                                                 <strong class="jxr_keyword">new</strong> PropertiesExpander( overridingProperties ) );
+<a name="609" href="#609">609</a>                 String effectiveEncoding =
+<a name="610" href="#610">610</a>                     StringUtils.isNotEmpty( encoding ) ? encoding : System.getProperty( <span class="jxr_string">"file.encoding"</span>, <span class="jxr_string">"UTF-8"</span> );
+<a name="611" href="#611">611</a>                 <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( encoding ) )
+<a name="612" href="#612">612</a>                 {
+<a name="613" href="#613">613</a>                     getLog().warn(
+<a name="614" href="#614">614</a>                                    <span class="jxr_string">"File encoding has not been set, using platform encoding "</span> + effectiveEncoding
+<a name="615" href="#615">615</a>                                        + <span class="jxr_string">", i.e. build is platform dependent!"</span> );
+<a name="616" href="#616">616</a>                 }
+<a name="617" href="#617">617</a>                 Configuration[] modules = config.getChildren();
+<a name="618" href="#618">618</a>                 <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> i = 0; i &lt; modules.length; i++ )
+<a name="619" href="#619">619</a>                 {
+<a name="620" href="#620">620</a>                     Configuration module = modules[i];
+<a name="621" href="#621">621</a>                     <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"TreeWalker"</span>.equals( module.getName() )
+<a name="622" href="#622">622</a>                         || <span class="jxr_string">"com.puppycrawl.tools.checkstyle.TreeWalker"</span>.equals( module.getName() ) )
+<a name="623" href="#623">623</a>                     {
+<a name="624" href="#624">624</a>                         <strong class="jxr_keyword">if</strong> ( module instanceof DefaultConfiguration )
+<a name="625" href="#625">625</a>                         {
+<a name="626" href="#626">626</a>                             ( (DefaultConfiguration) module ).addAttribute( <span class="jxr_string">"charset"</span>, effectiveEncoding );
+<a name="627" href="#627">627</a>                         }
+<a name="628" href="#628">628</a>                         <strong class="jxr_keyword">else</strong>
+<a name="629" href="#629">629</a>                         {
+<a name="630" href="#630">630</a>                             getLog().warn( <span class="jxr_string">"Failed to configure file encoding on module "</span> + module );
+<a name="631" href="#631">631</a>                         }
+<a name="632" href="#632">632</a>                     }
+<a name="633" href="#633">633</a>                 }
+<a name="634" href="#634">634</a> 
+<a name="635" href="#635">635</a>                 results = executeCheckstyle( config, moduleFactory );
+<a name="636" href="#636">636</a> 
+<a name="637" href="#637">637</a>                 ResourceBundle bundle = getBundle( locale );
+<a name="638" href="#638">638</a>                 generateReportStatics();
+<a name="639" href="#639">639</a>                 generateMainReport( results, config, moduleFactory, bundle );
+<a name="640" href="#640">640</a>                 <strong class="jxr_keyword">if</strong> ( enableRSS )
+<a name="641" href="#641">641</a>                 {
+<a name="642" href="#642">642</a>                     generateRSS( results );
+<a name="643" href="#643">643</a>                 }
+<a name="644" href="#644">644</a> 
+<a name="645" href="#645">645</a>             }
+<a name="646" href="#646">646</a>             <strong class="jxr_keyword">catch</strong> ( CheckstyleException e )
+<a name="647" href="#647">647</a>             {
+<a name="648" href="#648">648</a>                 <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Failed during checkstyle configuration"</span>, e );
+<a name="649" href="#649">649</a>             }
+<a name="650" href="#650">650</a>             <strong class="jxr_keyword">finally</strong>
+<a name="651" href="#651">651</a>             {
+<a name="652" href="#652">652</a>                 <em class="jxr_comment">//be sure to restore original context classloader</em>
+<a name="653" href="#653">653</a>                 Thread.currentThread().setContextClassLoader( currentClassLoader );
+<a name="654" href="#654">654</a>             }
+<a name="655" href="#655">655</a>         }
+<a name="656" href="#656">656</a>     }
+<a name="657" href="#657">657</a> 
+<a name="658" href="#658">658</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> generateReportStatics()
+<a name="659" href="#659">659</a>         <strong class="jxr_keyword">throws</strong> MavenReportException
+<a name="660" href="#660">660</a>     {
+<a name="661" href="#661">661</a>         <a href="../../../../../org/apache/maven/plugin/checkstyle/ReportResource.html">ReportResource</a> rresource = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/checkstyle/ReportResource.html">ReportResource</a>( PLUGIN_RESOURCES, outputDirectory );
+<a name="662" href="#662">662</a>         <strong class="jxr_keyword">try</strong>
+<a name="663" href="#663">663</a>         {
+<a name="664" href="#664">664</a>             rresource.copy( <span class="jxr_string">"images/rss.png"</span> );
+<a name="665" href="#665">665</a>         }
+<a name="666" href="#666">666</a>         <strong class="jxr_keyword">catch</strong> ( IOException e )
+<a name="667" href="#667">667</a>         {
+<a name="668" href="#668">668</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Unable to copy static resources."</span>, e );
+<a name="669" href="#669">669</a>         }
+<a name="670" href="#670">670</a>     }
+<a name="671" href="#671">671</a> 
+<a name="672" href="#672">672</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> generateRSS( CheckstyleResults results )
+<a name="673" href="#673">673</a>         <strong class="jxr_keyword">throws</strong> MavenReportException
+<a name="674" href="#674">674</a>     {
+<a name="675" href="#675">675</a>         <a href="../../../../../org/apache/maven/plugin/checkstyle/VelocityTemplate.html">VelocityTemplate</a> vtemplate = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/checkstyle/VelocityTemplate.html">VelocityTemplate</a>( velocityComponent, PLUGIN_RESOURCES );
+<a name="676" href="#676">676</a>         vtemplate.setLog( getLog() );
+<a name="677" href="#677">677</a> 
+<a name="678" href="#678">678</a>         Context context = <strong class="jxr_keyword">new</strong> VelocityContext();
+<a name="679" href="#679">679</a>         context.put( <span class="jxr_string">"results"</span>, results );
+<a name="680" href="#680">680</a>         context.put( <span class="jxr_string">"project"</span>, project );
+<a name="681" href="#681">681</a>         context.put( <span class="jxr_string">"copyright"</span>, getCopyright() );
+<a name="682" href="#682">682</a>         context.put( <span class="jxr_string">"levelInfo"</span>, SeverityLevel.INFO );
+<a name="683" href="#683">683</a>         context.put( <span class="jxr_string">"levelWarning"</span>, SeverityLevel.WARNING );
+<a name="684" href="#684">684</a>         context.put( <span class="jxr_string">"levelError"</span>, SeverityLevel.ERROR );
+<a name="685" href="#685">685</a>         context.put( <span class="jxr_string">"stringutils"</span>, <strong class="jxr_keyword">new</strong> StringUtils() );
+<a name="686" href="#686">686</a> 
+<a name="687" href="#687">687</a>         <strong class="jxr_keyword">try</strong>
+<a name="688" href="#688">688</a>         {
+<a name="689" href="#689">689</a>             vtemplate.generate( outputDirectory.getPath() + <span class="jxr_string">"/checkstyle.rss"</span>, <span class="jxr_string">"checkstyle-rss.vm"</span>, context );
+<a name="690" href="#690">690</a>         }
+<a name="691" href="#691">691</a>         <strong class="jxr_keyword">catch</strong> ( ResourceNotFoundException e )
+<a name="692" href="#692">692</a>         {
+<a name="693" href="#693">693</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Unable to find checkstyle-rss.vm resource."</span>, e );
+<a name="694" href="#694">694</a>         }
+<a name="695" href="#695">695</a>         <strong class="jxr_keyword">catch</strong> ( MojoExecutionException e )
+<a name="696" href="#696">696</a>         {
+<a name="697" href="#697">697</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Unable to generate checkstyle.rss."</span>, e );
+<a name="698" href="#698">698</a>         }
+<a name="699" href="#699">699</a>         <strong class="jxr_keyword">catch</strong> ( VelocityException e )
+<a name="700" href="#700">700</a>         {
+<a name="701" href="#701">701</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Unable to generate checkstyle.rss."</span>, e );
+<a name="702" href="#702">702</a>         }
+<a name="703" href="#703">703</a>         <strong class="jxr_keyword">catch</strong> ( IOException e )
+<a name="704" href="#704">704</a>         {
+<a name="705" href="#705">705</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Unable to generate checkstyle.rss."</span>, e );
+<a name="706" href="#706">706</a>         }
+<a name="707" href="#707">707</a>     }
+<a name="708" href="#708">708</a> 
+<a name="709" href="#709">709</a>     <strong class="jxr_keyword">private</strong> String getCopyright()
+<a name="710" href="#710">710</a>     {
+<a name="711" href="#711">711</a>         String copyright;
+<a name="712" href="#712">712</a>         <strong class="jxr_keyword">int</strong> currentYear = Calendar.getInstance().get( Calendar.YEAR );
+<a name="713" href="#713">713</a>         <strong class="jxr_keyword">if</strong> ( StringUtils.isNotEmpty( project.getInceptionYear() )
+<a name="714" href="#714">714</a>             &amp;&amp; !String.valueOf( currentYear ).equals( project.getInceptionYear() ) )
+<a name="715" href="#715">715</a>         {
+<a name="716" href="#716">716</a>             copyright = project.getInceptionYear() + <span class="jxr_string">" - "</span> + currentYear;
+<a name="717" href="#717">717</a>         }
+<a name="718" href="#718">718</a>         <strong class="jxr_keyword">else</strong>
+<a name="719" href="#719">719</a>         {
+<a name="720" href="#720">720</a>             copyright = String.valueOf( currentYear );
+<a name="721" href="#721">721</a>         }
+<a name="722" href="#722">722</a> 
+<a name="723" href="#723">723</a>         <strong class="jxr_keyword">if</strong> ( ( project.getOrganization() != <strong class="jxr_keyword">null</strong> ) &amp;&amp; StringUtils.isNotEmpty( project.getOrganization().getName() ) )
+<a name="724" href="#724">724</a>         {
+<a name="725" href="#725">725</a>             copyright = copyright + <span class="jxr_string">" "</span> + project.getOrganization().getName();
+<a name="726" href="#726">726</a>         }
+<a name="727" href="#727">727</a>         <strong class="jxr_keyword">return</strong> copyright;
+<a name="728" href="#728">728</a>     }
+<a name="729" href="#729">729</a> 
+<a name="730" href="#730">730</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> generateMainReport( CheckstyleResults results, Configuration config, ModuleFactory moduleFactory,
+<a name="731" href="#731">731</a>                                      ResourceBundle bundle )
+<a name="732" href="#732">732</a>     {
+<a name="733" href="#733">733</a>         <a href="../../../../../org/apache/maven/plugin/checkstyle/CheckstyleReportGenerator.html">CheckstyleReportGenerator</a> generator = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/checkstyle/CheckstyleReportGenerator.html">CheckstyleReportGenerator</a>( getSink(), bundle, project.getBasedir(), siteTool );
+<a name="734" href="#734">734</a> 
+<a name="735" href="#735">735</a>         generator.setLog( getLog() );
+<a name="736" href="#736">736</a>         generator.setEnableRulesSummary( enableRulesSummary );
+<a name="737" href="#737">737</a>         generator.setEnableSeveritySummary( enableSeveritySummary );
+<a name="738" href="#738">738</a>         generator.setEnableFilesSummary( enableFilesSummary );
+<a name="739" href="#739">739</a>         generator.setEnableRSS( enableRSS );
+<a name="740" href="#740">740</a>         generator.setCheckstyleConfig( config );
+<a name="741" href="#741">741</a>         generator.setCheckstyleModuleFactory( moduleFactory );
+<a name="742" href="#742">742</a>         <strong class="jxr_keyword">if</strong> ( linkXRef )
+<a name="743" href="#743">743</a>         {
+<a name="744" href="#744">744</a>             String relativePath = PathTool.getRelativePath( getOutputDirectory(), xrefLocation.getAbsolutePath() );
+<a name="745" href="#745">745</a>             <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( relativePath ) )
+<a name="746" href="#746">746</a>             {
+<a name="747" href="#747">747</a>                 relativePath = <span class="jxr_string">"."</span>;
+<a name="748" href="#748">748</a>             }
+<a name="749" href="#749">749</a>             relativePath = relativePath + <span class="jxr_string">"/"</span> + xrefLocation.getName();
+<a name="750" href="#750">750</a>             <strong class="jxr_keyword">if</strong> ( xrefLocation.exists() )
+<a name="751" href="#751">751</a>             {
+<a name="752" href="#752">752</a>                 <em class="jxr_comment">// XRef was already generated by manual execution of a lifecycle</em>
+<a name="753" href="#753">753</a>                 <em class="jxr_comment">// binding</em>
+<a name="754" href="#754">754</a>                 generator.setXrefLocation( relativePath );
+<a name="755" href="#755">755</a>             }
+<a name="756" href="#756">756</a>             <strong class="jxr_keyword">else</strong>
+<a name="757" href="#757">757</a>             {
+<a name="758" href="#758">758</a>                 <em class="jxr_comment">// Not yet generated - check if the report is on its way</em>
+<a name="759" href="#759">759</a>                 <strong class="jxr_keyword">for</strong> ( Iterator reports = getProject().getReportPlugins().iterator(); reports.hasNext(); )
+<a name="760" href="#760">760</a>                 {
+<a name="761" href="#761">761</a>                     ReportPlugin report = (ReportPlugin) reports.next();
+<a name="762" href="#762">762</a> 
+<a name="763" href="#763">763</a>                     String artifactId = report.getArtifactId();
+<a name="764" href="#764">764</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 name="765" href="#765">765</a>                     {
+<a name="766" href="#766">766</a>                         generator.setXrefLocation( relativePath );
+<a name="767" href="#767">767</a>                     }
+<a name="768" href="#768">768</a>                 }
+<a name="769" href="#769">769</a>             }
+<a name="770" href="#770">770</a> 
+<a name="771" href="#771">771</a>             <strong class="jxr_keyword">if</strong> ( generator.getXrefLocation() == <strong class="jxr_keyword">null</strong> )
+<a name="772" href="#772">772</a>             {
+<a name="773" href="#773">773</a>                 getLog().warn( <span class="jxr_string">"Unable to locate Source XRef to link to - DISABLED"</span> );
+<a name="774" href="#774">774</a>             }
+<a name="775" href="#775">775</a>         }
+<a name="776" href="#776">776</a>         generator.generateReport( results );
+<a name="777" href="#777">777</a>     }
+<a name="778" href="#778">778</a> 
+<a name="779" href="#779">779</a>     <em class="jxr_javadoccomment">/**</em>
+<a name="780" href="#780">780</a> <em class="jxr_javadoccomment">     * Merge in the deprecated parameters to the new ones, unless the new</em>
+<a name="781" href="#781">781</a> <em class="jxr_javadoccomment">     * parameters have values.</em>
+<a name="782" href="#782">782</a> <em class="jxr_javadoccomment">     *</em>
+<a name="783" href="#783">783</a> <em class="jxr_javadoccomment">     * @deprecated Remove when deprecated params are removed.</em>
+<a name="784" href="#784">784</a> <em class="jxr_javadoccomment">     */</em>
+<a name="785" href="#785">785</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> mergeDeprecatedInfo()
+<a name="786" href="#786">786</a>     {
+<a name="787" href="#787">787</a>         <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"config/sun_checks.xml"</span>.equals( configLocation ) &amp;&amp; !<span class="jxr_string">"sun"</span>.equals( format ) )
+<a name="788" href="#788">788</a>         {
+<a name="789" href="#789">789</a>             configLocation = (String) FORMAT_TO_CONFIG_LOCATION.get( format );
+<a name="790" href="#790">790</a>         }
+<a name="791" href="#791">791</a> 
+<a name="792" href="#792">792</a>         <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( propertiesLocation ) )
+<a name="793" href="#793">793</a>         {
+<a name="794" href="#794">794</a>             <strong class="jxr_keyword">if</strong> ( propertiesFile != <strong class="jxr_keyword">null</strong> )
+<a name="795" href="#795">795</a>             {
+<a name="796" href="#796">796</a>                 propertiesLocation = propertiesFile.getPath();
+<a name="797" href="#797">797</a>             }
+<a name="798" href="#798">798</a>             <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( propertiesURL != <strong class="jxr_keyword">null</strong> )
+<a name="799" href="#799">799</a>             {
+<a name="800" href="#800">800</a>                 propertiesLocation = propertiesURL.toExternalForm();
+<a name="801" href="#801">801</a>             }
+<a name="802" href="#802">802</a>         }
+<a name="803" href="#803">803</a> 
+<a name="804" href="#804">804</a>         <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"LICENSE.txt"</span>.equals( headerLocation ) )
+<a name="805" href="#805">805</a>         {
+<a name="806" href="#806">806</a>             File defaultHeaderFile = <strong class="jxr_keyword">new</strong> File( project.getBasedir(), <span class="jxr_string">"LICENSE.txt"</span> );
+<a name="807" href="#807">807</a>             <strong class="jxr_keyword">if</strong> ( !defaultHeaderFile.equals( headerFile ) )
+<a name="808" href="#808">808</a>             {
+<a name="809" href="#809">809</a>                 headerLocation = headerFile.getPath();
+<a name="810" href="#810">810</a>             }
+<a name="811" href="#811">811</a>         }
+<a name="812" href="#812">812</a> 
+<a name="813" href="#813">813</a>         <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( suppressionsLocation ) )
+<a name="814" href="#814">814</a>         {
+<a name="815" href="#815">815</a>             suppressionsLocation = suppressionsFile;
+<a name="816" href="#816">816</a>         }
+<a name="817" href="#817">817</a> 
+<a name="818" href="#818">818</a>         <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( packageNamesLocation ) )
+<a name="819" href="#819">819</a>         {
+<a name="820" href="#820">820</a>             packageNamesLocation = packageNamesFile;
+<a name="821" href="#821">821</a>         }
+<a name="822" href="#822">822</a>     }
+<a name="823" href="#823">823</a> 
+<a name="824" href="#824">824</a>     <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/maven/plugin/checkstyle/CheckstyleResults.html">CheckstyleResults</a> executeCheckstyle( Configuration config, ModuleFactory moduleFactory )
+<a name="825" href="#825">825</a>         <strong class="jxr_keyword">throws</strong> MavenReportException, CheckstyleException
+<a name="826" href="#826">826</a>     {
+<a name="827" href="#827">827</a>         File[] files;
+<a name="828" href="#828">828</a>         <strong class="jxr_keyword">try</strong>
+<a name="829" href="#829">829</a>         {
+<a name="830" href="#830">830</a>             files = getFilesToProcess( includes, excludes );
+<a name="831" href="#831">831</a>         }
+<a name="832" href="#832">832</a>         <strong class="jxr_keyword">catch</strong> ( IOException e )
+<a name="833" href="#833">833</a>         {
+<a name="834" href="#834">834</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Error getting files to process"</span>, e );
+<a name="835" href="#835">835</a>         }
+<a name="836" href="#836">836</a> 
+<a name="837" href="#837">837</a>         FilterSet filterSet = getSuppressions();
+<a name="838" href="#838">838</a> 
+<a name="839" href="#839">839</a>         Checker checker = <strong class="jxr_keyword">new</strong> Checker();
+<a name="840" href="#840">840</a> 
+<a name="841" href="#841">841</a>         <em class="jxr_comment">// setup classloader, needed to avoid "Unable to get class information</em>
+<a name="842" href="#842">842</a>         <em class="jxr_comment">// for ..." errors</em>
+<a name="843" href="#843">843</a>         List classPathStrings;
+<a name="844" href="#844">844</a>         List outputDirectories = <strong class="jxr_keyword">new</strong> ArrayList();
+<a name="845" href="#845">845</a>         <strong class="jxr_keyword">try</strong>
+<a name="846" href="#846">846</a>         {
+<a name="847" href="#847">847</a>             classPathStrings = <strong class="jxr_keyword">this</strong>.project.getCompileClasspathElements();
+<a name="848" href="#848">848</a>             outputDirectories.add( <strong class="jxr_keyword">this</strong>.project.getBuild().getOutputDirectory() );
+<a name="849" href="#849">849</a> 
+<a name="850" href="#850">850</a>             <strong class="jxr_keyword">if</strong> ( includeTestSourceDirectory &amp;&amp; ( testSourceDirectory != <strong class="jxr_keyword">null</strong> ) &amp;&amp; ( testSourceDirectory.exists() )
+<a name="851" href="#851">851</a>                 &amp;&amp; ( testSourceDirectory.isDirectory() ) )
+<a name="852" href="#852">852</a>             {
+<a name="853" href="#853">853</a>                 classPathStrings = <strong class="jxr_keyword">this</strong>.project.getTestClasspathElements();
+<a name="854" href="#854">854</a>                 outputDirectories.add( <strong class="jxr_keyword">this</strong>.project.getBuild().getTestOutputDirectory() );
+<a name="855" href="#855">855</a>             }
+<a name="856" href="#856">856</a>         }
+<a name="857" href="#857">857</a>         <strong class="jxr_keyword">catch</strong> ( DependencyResolutionRequiredException e )
+<a name="858" href="#858">858</a>         {
+<a name="859" href="#859">859</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e );
+<a name="860" href="#860">860</a>         }
+<a name="861" href="#861">861</a> 
+<a name="862" href="#862">862</a>         List urls = <strong class="jxr_keyword">new</strong> ArrayList( classPathStrings.size() );
+<a name="863" href="#863">863</a> 
+<a name="864" href="#864">864</a>         Iterator iter = classPathStrings.iterator();
+<a name="865" href="#865">865</a>         <strong class="jxr_keyword">while</strong> ( iter.hasNext() )
+<a name="866" href="#866">866</a>         {
+<a name="867" href="#867">867</a>             <strong class="jxr_keyword">try</strong>
+<a name="868" href="#868">868</a>             {
+<a name="869" href="#869">869</a>                 urls.add( <strong class="jxr_keyword">new</strong> File( ( (String) iter.next() ) ).toURL() );
+<a name="870" href="#870">870</a>             }
+<a name="871" href="#871">871</a>             <strong class="jxr_keyword">catch</strong> ( MalformedURLException e )
+<a name="872" href="#872">872</a>             {
+<a name="873" href="#873">873</a>                 <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e );
+<a name="874" href="#874">874</a>             }
+<a name="875" href="#875">875</a>         }
+<a name="876" href="#876">876</a> 
+<a name="877" href="#877">877</a>         Iterator iterator = outputDirectories.iterator();
+<a name="878" href="#878">878</a>         <strong class="jxr_keyword">while</strong> ( iterator.hasNext() )
+<a name="879" href="#879">879</a>         {
+<a name="880" href="#880">880</a>             <strong class="jxr_keyword">try</strong>
+<a name="881" href="#881">881</a>             {
+<a name="882" href="#882">882</a>                 String outputDirectoryString = (String) iterator.next();
+<a name="883" href="#883">883</a>                 <strong class="jxr_keyword">if</strong> ( outputDirectoryString != <strong class="jxr_keyword">null</strong> )
+<a name="884" href="#884">884</a>                 {
+<a name="885" href="#885">885</a>                     File outputDirectoryFile = <strong class="jxr_keyword">new</strong> File( outputDirectoryString );
+<a name="886" href="#886">886</a>                     <strong class="jxr_keyword">if</strong> ( outputDirectoryFile.exists() )
+<a name="887" href="#887">887</a>                     {
+<a name="888" href="#888">888</a>                         URL outputDirectoryUrl = outputDirectoryFile.toURL();
+<a name="889" href="#889">889</a>                         getLog().debug( <span class="jxr_string">"Adding the outputDirectory "</span> + outputDirectoryUrl.toString()
+<a name="890" href="#890">890</a>                             + <span class="jxr_string">" to the Checkstyle class path"</span> );
+<a name="891" href="#891">891</a>                         urls.add( outputDirectoryUrl );
+<a name="892" href="#892">892</a>                     }
+<a name="893" href="#893">893</a>                 }
+<a name="894" href="#894">894</a>             }
+<a name="895" href="#895">895</a>             <strong class="jxr_keyword">catch</strong> ( MalformedURLException e )
+<a name="896" href="#896">896</a>             {
+<a name="897" href="#897">897</a>                 <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e );
+<a name="898" href="#898">898</a>             }
+<a name="899" href="#899">899</a>             <strong class="jxr_keyword">catch</strong> ( IOException e )
+<a name="900" href="#900">900</a>             {
+<a name="901" href="#901">901</a>                 <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e );
+<a name="902" href="#902">902</a>             }
+<a name="903" href="#903">903</a>         }
+<a name="904" href="#904">904</a> 

[... 364 lines stripped ...]


Mime
View raw message