You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by bi...@apache.org on 2013/11/11 23:42:54 UTC
svn commit: r886226 [38/44] - in
/websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT:
./ apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/maven/
apidocs/org/apache/maven/plugin/ apidocs/org/apache/maven...
Added: websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT/xref/org/apache/maven/plugin/checkstyle/CheckstyleReport.html
==============================================================================
--- websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT/xref/org/apache/maven/plugin/checkstyle/CheckstyleReport.html (added)
+++ websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT/xref/org/apache/maven/plugin/checkstyle/CheckstyleReport.html Mon Nov 11 22:42:50 2013
@@ -0,0 +1,467 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+<title>CheckstyleReport xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugin/checkstyle/CheckstyleReport.html">View Javadoc</a></div><pre>
+
+<a class="jxr_linenumber" name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugin.checkstyle;
+<a class="jxr_linenumber" name="2" href="#2">2</a>
+<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
+<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
+<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
+<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
+<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
+<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
+<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
+<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
+<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
+<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
+<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
+<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
+<a class="jxr_linenumber" name="19" href="#19">19</a> <em class="jxr_comment"> * under the License.</em>
+<a class="jxr_linenumber" name="20" href="#20">20</a> <em class="jxr_comment"> */</em>
+<a class="jxr_linenumber" name="21" href="#21">21</a>
+<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo;
+<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter;
+<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.ResolutionScope;
+<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
+<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReportException;
+<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils;
+<a class="jxr_linenumber" name="28" href="#28">28</a>
+<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.io.File;
+<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.net.URL;
+<a class="jxr_linenumber" name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> java.util.Collections;
+<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> java.util.HashMap;
+<a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
+<a class="jxr_linenumber" name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> java.util.Map;
+<a class="jxr_linenumber" name="35" href="#35">35</a>
+<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * A reporting task that performs Checkstyle analysis and generates an HTML report on any violations that Checkstyle finds.</em>
+<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:evenisse@apache.org" target="alexandria_uri">mailto:evenisse@apache.org</a>">Emmanuel Venisse</a></em>
+<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:vincent.siveton@gmail.com" target="alexandria_uri">mailto:vincent.siveton@gmail.com</a>">Vincent Siveton</a></em>
+<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:joakim@erdfelt.com" target="alexandria_uri">mailto:joakim@erdfelt.com</a>">Joakim Erdfelt</a></em>
+<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @version $Id: CheckstyleReport.java 1540563 2013-11-10 22:07:54Z bimargulies $</em>
+<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="44" href="#44">44</a> @Mojo( name = <span class="jxr_string">"checkstyle"</span>, requiresDependencyResolution = ResolutionScope.COMPILE, threadSafe = <strong class="jxr_keyword">true</strong> )
+<a class="jxr_linenumber" name="45" href="#45">45</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 class="jxr_linenumber" name="46" href="#46">46</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.html">AbstractCheckstyleReport</a>
+<a class="jxr_linenumber" name="47" href="#47">47</a> {
+<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * @deprecated Remove with format parameter.</em>
+<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="51" href="#51">51</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Map<String, String> FORMAT_TO_CONFIG_LOCATION;
+<a class="jxr_linenumber" name="52" href="#52">52</a>
+<a class="jxr_linenumber" name="53" href="#53">53</a> <strong class="jxr_keyword">static</strong>
+<a class="jxr_linenumber" name="54" href="#54">54</a> {
+<a class="jxr_linenumber" name="55" href="#55">55</a> Map<String, String> fmt2Cfg = <strong class="jxr_keyword">new</strong> HashMap<String, String>();
+<a class="jxr_linenumber" name="56" href="#56">56</a>
+<a class="jxr_linenumber" name="57" href="#57">57</a> fmt2Cfg.put( <span class="jxr_string">"sun"</span>, <span class="jxr_string">"config/sun_checks.xml"</span> );
+<a class="jxr_linenumber" name="58" href="#58">58</a> fmt2Cfg.put( <span class="jxr_string">"turbine"</span>, <span class="jxr_string">"config/turbine_checks.xml"</span> );
+<a class="jxr_linenumber" name="59" href="#59">59</a> fmt2Cfg.put( <span class="jxr_string">"avalon"</span>, <span class="jxr_string">"config/avalon_checks.xml"</span> );
+<a class="jxr_linenumber" name="60" href="#60">60</a> fmt2Cfg.put( <span class="jxr_string">"maven"</span>, <span class="jxr_string">"config/maven_checks.xml"</span> );
+<a class="jxr_linenumber" name="61" href="#61">61</a>
+<a class="jxr_linenumber" name="62" href="#62">62</a> FORMAT_TO_CONFIG_LOCATION = Collections.unmodifiableMap( fmt2Cfg );
+<a class="jxr_linenumber" name="63" href="#63">63</a> }
+<a class="jxr_linenumber" name="64" href="#64">64</a>
+<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * Specifies the names filter of the source files to be used for Checkstyle.</em>
+<a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * <strong>Note:</strong> default value is {@code **\/*.java}.</em>
+<a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="70" href="#70">70</a> @Parameter( property = <span class="jxr_string">"checkstyle.includes"</span>, defaultValue = JAVA_FILES, required = <strong class="jxr_keyword">true</strong> )
+<a class="jxr_linenumber" name="71" href="#71">71</a> <strong class="jxr_keyword">private</strong> String includes;
+<a class="jxr_linenumber" name="72" href="#72">72</a>
+<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * Specifies the names filter of the source files to be excluded for</em>
+<a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * Checkstyle.</em>
+<a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="77" href="#77">77</a> @Parameter( property = <span class="jxr_string">"checkstyle.excludes"</span> )
+<a class="jxr_linenumber" name="78" href="#78">78</a> <strong class="jxr_keyword">private</strong> String excludes;
+<a class="jxr_linenumber" name="79" href="#79">79</a>
+<a class="jxr_linenumber" name="80" href="#80">80</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * Specifies the names filter of the source files to be used for Checkstyle.</em>
+<a class="jxr_linenumber" name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * @since 2.11</em>
+<a class="jxr_linenumber" name="83" href="#83">83</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * <strong>Note:</strong> default value is {@code **\/*.properties}.</em>
+<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="86" href="#86">86</a> @Parameter( property = <span class="jxr_string">"checkstyle.resourceIncludes"</span>, defaultValue = <span class="jxr_string">"**/*.properties"</span>, required = <strong class="jxr_keyword">true</strong> )
+<a class="jxr_linenumber" name="87" href="#87">87</a> <strong class="jxr_keyword">private</strong> String resourceIncludes;
+<a class="jxr_linenumber" name="88" href="#88">88</a>
+<a class="jxr_linenumber" name="89" href="#89">89</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * Specifies the names filter of the source files to be excluded for</em>
+<a class="jxr_linenumber" name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * Checkstyle.</em>
+<a class="jxr_linenumber" name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * @since 2.11</em>
+<a class="jxr_linenumber" name="93" href="#93">93</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="94" href="#94">94</a> @Parameter( property = <span class="jxr_string">"checkstyle.resourceExcludes"</span> )
+<a class="jxr_linenumber" name="95" href="#95">95</a> <strong class="jxr_keyword">private</strong> String resourceExcludes;
+<a class="jxr_linenumber" name="96" href="#96">96</a>
+<a class="jxr_linenumber" name="97" href="#97">97</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * Specifies whether to include the resource directories in the check.</em>
+<a class="jxr_linenumber" name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * @since 2.11</em>
+<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="101" href="#101">101</a> @Parameter( property = <span class="jxr_string">"checkstyle.includeResources"</span>, defaultValue = <span class="jxr_string">"true"</span>, required = <strong class="jxr_keyword">true</strong> )
+<a class="jxr_linenumber" name="102" href="#102">102</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> includeResources;
+<a class="jxr_linenumber" name="103" href="#103">103</a>
+<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * Specifies whether to include the test resource directories in the check.</em>
+<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * @since 2.11</em>
+<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="108" href="#108">108</a> @Parameter( property = <span class="jxr_string">"checkstyle.includeTestResources"</span>, defaultValue = <span class="jxr_string">"true"</span>, required = <strong class="jxr_keyword">true</strong> )
+<a class="jxr_linenumber" name="109" href="#109">109</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> includeTestResources;
+<a class="jxr_linenumber" name="110" href="#110">110</a>
+<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * Specifies the location of the XML configuration to use.</em>
+<a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * <p/></em>
+<a class="jxr_linenumber" name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * Potential values are a filesystem path, a URL, or a classpath resource.</em>
+<a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * This parameter expects that the contents of the location conform to the</em>
+<a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * xml format (Checkstyle <a</em>
+<a class="jxr_linenumber" name="120" href="#120">120</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">Checker</em>
+<a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * module</a>) configuration of rulesets.</em>
+<a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * <p/></em>
+<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * This parameter is resolved as resource, URL, then file. If successfully</em>
+<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * resolved, the contents of the configuration is copied into the</em>
+<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * <code>${project.build.directory}/checkstyle-configuration.xml</code></em>
+<a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * file before being passed to Checkstyle as a configuration.</em>
+<a class="jxr_linenumber" name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * <p/></em>
+<a class="jxr_linenumber" name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * There are 4 predefined rulesets.</em>
+<a class="jxr_linenumber" name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * <p/></em>
+<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * <ul></em>
+<a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * <li><code>config/sun_checks.xml</code>: Sun Checks.</li></em>
+<a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * <li><code>config/turbine_checks.xml</code>: Turbine Checks.</li></em>
+<a class="jxr_linenumber" name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * <li><code>config/avalon_checks.xml</code>: Avalon Checks.</li></em>
+<a class="jxr_linenumber" name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * <li><code>config/maven_checks.xml</code>: Maven Source Checks.</li></em>
+<a class="jxr_linenumber" name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * </ul></em>
+<a class="jxr_linenumber" name="141" href="#141">141</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="142" href="#142">142</a> @Parameter( property = <span class="jxr_string">"checkstyle.config.location"</span>, defaultValue = <span class="jxr_string">"config/sun_checks.xml"</span> )
+<a class="jxr_linenumber" name="143" href="#143">143</a> <strong class="jxr_keyword">private</strong> String configLocation;
+<a class="jxr_linenumber" name="144" href="#144">144</a>
+<a class="jxr_linenumber" name="145" href="#145">145</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * Specifies what predefined check set to use. Available sets are "sun" (for</em>
+<a class="jxr_linenumber" name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * the Sun coding conventions), "turbine", and "avalon".</em>
+<a class="jxr_linenumber" name="148" href="#148">148</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * @deprecated Use configLocation instead.</em>
+<a class="jxr_linenumber" name="150" href="#150">150</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="151" href="#151">151</a> @Parameter( defaultValue = <span class="jxr_string">"sun"</span> )
+<a class="jxr_linenumber" name="152" href="#152">152</a> <strong class="jxr_keyword">private</strong> String format;
+<a class="jxr_linenumber" name="153" href="#153">153</a>
+<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * Specifies the location of the properties file.</em>
+<a class="jxr_linenumber" name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * <p/></em>
+<a class="jxr_linenumber" name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * This parameter is resolved as URL, File then resource. If successfully</em>
+<a class="jxr_linenumber" name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * resolved, the contents of the properties location is copied into the</em>
+<a class="jxr_linenumber" name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * <code>${project.build.directory}/checkstyle-checker.properties</code></em>
+<a class="jxr_linenumber" name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * file before being passed to Checkstyle for loading.</em>
+<a class="jxr_linenumber" name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * <p/></em>
+<a class="jxr_linenumber" name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * The contents of the <code>propertiesLocation</code> will be made</em>
+<a class="jxr_linenumber" name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * available to Checkstyle for specifying values for parameters within the</em>
+<a class="jxr_linenumber" name="169" href="#169">169</a> <em class="jxr_javadoccomment"> * xml configuration (specified in the <code>configLocation</code></em>
+<a class="jxr_linenumber" name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * parameter).</em>
+<a class="jxr_linenumber" name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="172" href="#172">172</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="173" href="#173">173</a> <em class="jxr_javadoccomment"> * @since 2.0-beta-2</em>
+<a class="jxr_linenumber" name="174" href="#174">174</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="175" href="#175">175</a> @Parameter( property = <span class="jxr_string">"checkstyle.properties.location"</span> )
+<a class="jxr_linenumber" name="176" href="#176">176</a> <strong class="jxr_keyword">private</strong> String propertiesLocation;
+<a class="jxr_linenumber" name="177" href="#177">177</a>
+<a class="jxr_linenumber" name="178" href="#178">178</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="179" href="#179">179</a> <em class="jxr_javadoccomment"> * Specifies the location of the Checkstyle properties file that will be used to</em>
+<a class="jxr_linenumber" name="180" href="#180">180</a> <em class="jxr_javadoccomment"> * check the source.</em>
+<a class="jxr_linenumber" name="181" href="#181">181</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * @deprecated Use propertiesLocation instead.</em>
+<a class="jxr_linenumber" name="183" href="#183">183</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="184" href="#184">184</a> @Parameter
+<a class="jxr_linenumber" name="185" href="#185">185</a> <strong class="jxr_keyword">private</strong> File propertiesFile;
+<a class="jxr_linenumber" name="186" href="#186">186</a>
+<a class="jxr_linenumber" name="187" href="#187">187</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="188" href="#188">188</a> <em class="jxr_javadoccomment"> * Specifies the URL of the Checkstyle properties that will be used to check</em>
+<a class="jxr_linenumber" name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * the source.</em>
+<a class="jxr_linenumber" name="190" href="#190">190</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="191" href="#191">191</a> <em class="jxr_javadoccomment"> * @deprecated Use propertiesLocation instead.</em>
+<a class="jxr_linenumber" name="192" href="#192">192</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="193" href="#193">193</a> @Parameter
+<a class="jxr_linenumber" name="194" href="#194">194</a> <strong class="jxr_keyword">private</strong> URL propertiesURL;
+<a class="jxr_linenumber" name="195" href="#195">195</a>
+<a class="jxr_linenumber" name="196" href="#196">196</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="197" href="#197">197</a> <em class="jxr_javadoccomment"> * Allows for specifying raw property expansion information.</em>
+<a class="jxr_linenumber" name="198" href="#198">198</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="199" href="#199">199</a> @Parameter
+<a class="jxr_linenumber" name="200" href="#200">200</a> <strong class="jxr_keyword">private</strong> String propertyExpansion;
+<a class="jxr_linenumber" name="201" href="#201">201</a>
+<a class="jxr_linenumber" name="202" href="#202">202</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="203" href="#203">203</a> <em class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="204" href="#204">204</a> <em class="jxr_javadoccomment"> * Specifies the location of the License file (a.k.a. the header file) that</em>
+<a class="jxr_linenumber" name="205" href="#205">205</a> <em class="jxr_javadoccomment"> * can be used by Checkstyle to verify that source code has the correct</em>
+<a class="jxr_linenumber" name="206" href="#206">206</a> <em class="jxr_javadoccomment"> * license header.</em>
+<a class="jxr_linenumber" name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="208" href="#208">208</a> <em class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="209" href="#209">209</a> <em class="jxr_javadoccomment"> * You need to use ${checkstyle.header.file} in your Checkstyle xml</em>
+<a class="jxr_linenumber" name="210" href="#210">210</a> <em class="jxr_javadoccomment"> * configuration to reference the name of this header file.</em>
+<a class="jxr_linenumber" name="211" href="#211">211</a> <em class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="212" href="#212">212</a> <em class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="213" href="#213">213</a> <em class="jxr_javadoccomment"> * For instance:</em>
+<a class="jxr_linenumber" name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="215" href="#215">215</a> <em class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * <code></em>
+<a class="jxr_linenumber" name="217" href="#217">217</a> <em class="jxr_javadoccomment"> * &lt;module name="RegexpHeader"></em>
+<a class="jxr_linenumber" name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * &lt;property name="headerFile" value="${checkstyle.header.file}"/></em>
+<a class="jxr_linenumber" name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * &lt;/module></em>
+<a class="jxr_linenumber" name="220" href="#220">220</a> <em class="jxr_javadoccomment"> * </code></em>
+<a class="jxr_linenumber" name="221" href="#221">221</a> <em class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="222" href="#222">222</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="223" href="#223">223</a> <em class="jxr_javadoccomment"> * @since 2.0-beta-2</em>
+<a class="jxr_linenumber" name="224" href="#224">224</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="225" href="#225">225</a> @Parameter( property = <span class="jxr_string">"checkstyle.header.file"</span>, defaultValue = <span class="jxr_string">"LICENSE.txt"</span> )
+<a class="jxr_linenumber" name="226" href="#226">226</a> <strong class="jxr_keyword">private</strong> String headerLocation;
+<a class="jxr_linenumber" name="227" href="#227">227</a>
+<a class="jxr_linenumber" name="228" href="#228">228</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="229" href="#229">229</a> <em class="jxr_javadoccomment"> * Specifies the location of the License file (a.k.a. the header file) that</em>
+<a class="jxr_linenumber" name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * is used by Checkstyle to verify that source code has the correct</em>
+<a class="jxr_linenumber" name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * license header.</em>
+<a class="jxr_linenumber" name="232" href="#232">232</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * @deprecated Use headerLocation instead.</em>
+<a class="jxr_linenumber" name="234" href="#234">234</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="235" href="#235">235</a> @Parameter( defaultValue = <span class="jxr_string">"${basedir}/LICENSE.txt"</span> )
+<a class="jxr_linenumber" name="236" href="#236">236</a> <strong class="jxr_keyword">private</strong> File headerFile;
+<a class="jxr_linenumber" name="237" href="#237">237</a>
+<a class="jxr_linenumber" name="238" href="#238">238</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="239" href="#239">239</a> <em class="jxr_javadoccomment"> * Specifies the cache file used to speed up Checkstyle on successive runs.</em>
+<a class="jxr_linenumber" name="240" href="#240">240</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="241" href="#241">241</a> @Parameter( defaultValue = <span class="jxr_string">"${project.build.directory}/checkstyle-cachefile"</span> )
+<a class="jxr_linenumber" name="242" href="#242">242</a> <strong class="jxr_keyword">private</strong> String cacheFile;
+<a class="jxr_linenumber" name="243" href="#243">243</a>
+<a class="jxr_linenumber" name="244" href="#244">244</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="245" href="#245">245</a> <em class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="246" href="#246">246</a> <em class="jxr_javadoccomment"> * Specifies the location of the suppressions XML file to use.</em>
+<a class="jxr_linenumber" name="247" href="#247">247</a> <em class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="248" href="#248">248</a> <em class="jxr_javadoccomment"> * <p/></em>
+<a class="jxr_linenumber" name="249" href="#249">249</a> <em class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="250" href="#250">250</a> <em class="jxr_javadoccomment"> * This parameter is resolved as resource, URL, then file. If successfully</em>
+<a class="jxr_linenumber" name="251" href="#251">251</a> <em class="jxr_javadoccomment"> * resolved, the contents of the suppressions XML is copied into the</em>
+<a class="jxr_linenumber" name="252" href="#252">252</a> <em class="jxr_javadoccomment"> * <code>${project.build.directory}/checkstyle-supressions.xml</code> file</em>
+<a class="jxr_linenumber" name="253" href="#253">253</a> <em class="jxr_javadoccomment"> * before being passed to Checkstyle for loading.</em>
+<a class="jxr_linenumber" name="254" href="#254">254</a> <em class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="255" href="#255">255</a> <em class="jxr_javadoccomment"> * <p/></em>
+<a class="jxr_linenumber" name="256" href="#256">256</a> <em class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="257" href="#257">257</a> <em class="jxr_javadoccomment"> * See <code>suppressionsFileExpression</code> for the property that will</em>
+<a class="jxr_linenumber" name="258" href="#258">258</a> <em class="jxr_javadoccomment"> * be made available to your checkstyle configuration.</em>
+<a class="jxr_linenumber" name="259" href="#259">259</a> <em class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="260" href="#260">260</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="261" href="#261">261</a> <em class="jxr_javadoccomment"> * @since 2.0-beta-2</em>
+<a class="jxr_linenumber" name="262" href="#262">262</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="263" href="#263">263</a> @Parameter( property = <span class="jxr_string">"checkstyle.suppressions.location"</span> )
+<a class="jxr_linenumber" name="264" href="#264">264</a> <strong class="jxr_keyword">private</strong> String suppressionsLocation;
+<a class="jxr_linenumber" name="265" href="#265">265</a>
+<a class="jxr_linenumber" name="266" href="#266">266</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="267" href="#267">267</a> <em class="jxr_javadoccomment"> * The key to be used in the properties for the suppressions file.</em>
+<a class="jxr_linenumber" name="268" href="#268">268</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="269" href="#269">269</a> <em class="jxr_javadoccomment"> * @since 2.1</em>
+<a class="jxr_linenumber" name="270" href="#270">270</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="271" href="#271">271</a> @Parameter( property = <span class="jxr_string">"checkstyle.suppression.expression"</span>, defaultValue = <span class="jxr_string">"checkstyle.suppressions.file"</span> )
+<a class="jxr_linenumber" name="272" href="#272">272</a> <strong class="jxr_keyword">private</strong> String suppressionsFileExpression;
+<a class="jxr_linenumber" name="273" href="#273">273</a>
+<a class="jxr_linenumber" name="274" href="#274">274</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="275" href="#275">275</a> <em class="jxr_javadoccomment"> * Specifies the location of the suppressions XML file to use. The plugin</em>
+<a class="jxr_linenumber" name="276" href="#276">276</a> <em class="jxr_javadoccomment"> * defines a Checkstyle property named</em>
+<a class="jxr_linenumber" name="277" href="#277">277</a> <em class="jxr_javadoccomment"> * <code>checkstyle.suppressions.file</code> with the value of this</em>
+<a class="jxr_linenumber" name="278" href="#278">278</a> <em class="jxr_javadoccomment"> * property. This allows using the Checkstyle property in your own custom</em>
+<a class="jxr_linenumber" name="279" href="#279">279</a> <em class="jxr_javadoccomment"> * checkstyle configuration file when specifying a suppressions file.</em>
+<a class="jxr_linenumber" name="280" href="#280">280</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="281" href="#281">281</a> <em class="jxr_javadoccomment"> * @deprecated Use suppressionsLocation instead.</em>
+<a class="jxr_linenumber" name="282" href="#282">282</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="283" href="#283">283</a> @Parameter
+<a class="jxr_linenumber" name="284" href="#284">284</a> <strong class="jxr_keyword">private</strong> String suppressionsFile;
+<a class="jxr_linenumber" name="285" href="#285">285</a>
+<a class="jxr_linenumber" name="286" href="#286">286</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="287" href="#287">287</a> <em class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="288" href="#288">288</a> <em class="jxr_javadoccomment"> * Specifies the location of the package names XML to be used to configure</em>
+<a class="jxr_linenumber" name="289" href="#289">289</a> <em class="jxr_javadoccomment"> * the Checkstyle <a</em>
+<a class="jxr_linenumber" name="290" href="#290">290</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">Packages</a>.</em>
+<a class="jxr_linenumber" name="291" href="#291">291</a> <em class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="292" href="#292">292</a> <em class="jxr_javadoccomment"> * <p/></em>
+<a class="jxr_linenumber" name="293" href="#293">293</a> <em class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="294" href="#294">294</a> <em class="jxr_javadoccomment"> * This parameter is resolved as resource, URL, then file. If resolved to a</em>
+<a class="jxr_linenumber" name="295" href="#295">295</a> <em class="jxr_javadoccomment"> * resource, or a URL, the contents of the package names XML is copied into</em>
+<a class="jxr_linenumber" name="296" href="#296">296</a> <em class="jxr_javadoccomment"> * the <code>${project.build.directory}/checkstyle-packagenames.xml</code></em>
+<a class="jxr_linenumber" name="297" href="#297">297</a> <em class="jxr_javadoccomment"> * file before being passed to Checkstyle for loading.</em>
+<a class="jxr_linenumber" name="298" href="#298">298</a> <em class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="299" href="#299">299</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="300" href="#300">300</a> <em class="jxr_javadoccomment"> * @since 2.0-beta-2</em>
+<a class="jxr_linenumber" name="301" href="#301">301</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="302" href="#302">302</a> @Parameter
+<a class="jxr_linenumber" name="303" href="#303">303</a> <strong class="jxr_keyword">private</strong> String packageNamesLocation;
+<a class="jxr_linenumber" name="304" href="#304">304</a>
+<a class="jxr_linenumber" name="305" href="#305">305</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="306" href="#306">306</a> <em class="jxr_javadoccomment"> * Specifies the location of the package names XML to be used to configure</em>
+<a class="jxr_linenumber" name="307" href="#307">307</a> <em class="jxr_javadoccomment"> * Checkstyle.</em>
+<a class="jxr_linenumber" name="308" href="#308">308</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="309" href="#309">309</a> <em class="jxr_javadoccomment"> * @deprecated Use packageNamesLocation instead.</em>
+<a class="jxr_linenumber" name="310" href="#310">310</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="311" href="#311">311</a> @Parameter
+<a class="jxr_linenumber" name="312" href="#312">312</a> <strong class="jxr_keyword">private</strong> String packageNamesFile;
+<a class="jxr_linenumber" name="313" href="#313">313</a>
+<a class="jxr_linenumber" name="314" href="#314">314</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="315" href="#315">315</a> <em class="jxr_javadoccomment"> * Specifies if the build should fail upon a violation.</em>
+<a class="jxr_linenumber" name="316" href="#316">316</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="317" href="#317">317</a> @Parameter( defaultValue = <span class="jxr_string">"false"</span> )
+<a class="jxr_linenumber" name="318" href="#318">318</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> failsOnError;
+<a class="jxr_linenumber" name="319" href="#319">319</a>
+<a class="jxr_linenumber" name="320" href="#320">320</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="321" href="#321">321</a> <em class="jxr_javadoccomment"> * Specifies the location of the source directory to be used for Checkstyle.</em>
+<a class="jxr_linenumber" name="322" href="#322">322</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="323" href="#323">323</a> @Parameter( defaultValue = <span class="jxr_string">"${project.build.sourceDirectory}"</span>, required = <strong class="jxr_keyword">true</strong> )
+<a class="jxr_linenumber" name="324" href="#324">324</a> <strong class="jxr_keyword">private</strong> File sourceDirectory;
+<a class="jxr_linenumber" name="325" href="#325">325</a>
+<a class="jxr_linenumber" name="326" href="#326">326</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="327" href="#327">327</a> <em class="jxr_javadoccomment"> * Specifies the location of the test source directory to be used for</em>
+<a class="jxr_linenumber" name="328" href="#328">328</a> <em class="jxr_javadoccomment"> * Checkstyle.</em>
+<a class="jxr_linenumber" name="329" href="#329">329</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="330" href="#330">330</a> <em class="jxr_javadoccomment"> * @since 2.2</em>
+<a class="jxr_linenumber" name="331" href="#331">331</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="332" href="#332">332</a> @Parameter( defaultValue = <span class="jxr_string">"${project.build.testSourceDirectory}"</span> )
+<a class="jxr_linenumber" name="333" href="#333">333</a> <strong class="jxr_keyword">private</strong> File testSourceDirectory;
+<a class="jxr_linenumber" name="334" href="#334">334</a>
+<a class="jxr_linenumber" name="335" href="#335">335</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="336" href="#336">336</a> <em class="jxr_javadoccomment"> * Include or not the test source directory to be used for Checkstyle.</em>
+<a class="jxr_linenumber" name="337" href="#337">337</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="338" href="#338">338</a> <em class="jxr_javadoccomment"> * @since 2.2</em>
+<a class="jxr_linenumber" name="339" href="#339">339</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="340" href="#340">340</a> @Parameter( defaultValue = <span class="jxr_string">"false"</span> )
+<a class="jxr_linenumber" name="341" href="#341">341</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> includeTestSourceDirectory;
+<a class="jxr_linenumber" name="342" href="#342">342</a>
+<a class="jxr_linenumber" name="343" href="#343">343</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="344" href="#344">344</a> <em class="jxr_javadoccomment"> * Output errors to console.</em>
+<a class="jxr_linenumber" name="345" href="#345">345</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="346" href="#346">346</a> @Parameter( defaultValue = <span class="jxr_string">"false"</span> )
+<a class="jxr_linenumber" name="347" href="#347">347</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> consoleOutput;
+<a class="jxr_linenumber" name="348" href="#348">348</a>
+<a class="jxr_linenumber" name="349" href="#349">349</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="350" href="#350">350</a> <em class="jxr_javadoccomment"> * The file encoding to use when reading the source files. If the property <code>project.build.sourceEncoding</code></em>
+<a class="jxr_linenumber" name="351" href="#351">351</a> <em class="jxr_javadoccomment"> * is not set, the platform default encoding is used. <strong>Note:</strong> This parameter always overrides the</em>
+<a class="jxr_linenumber" name="352" href="#352">352</a> <em class="jxr_javadoccomment"> * property <code>charset</code> from Checkstyle's <code>TreeWalker</code> module.</em>
+<a class="jxr_linenumber" name="353" href="#353">353</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="354" href="#354">354</a> <em class="jxr_javadoccomment"> * @since 2.2</em>
+<a class="jxr_linenumber" name="355" href="#355">355</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="356" href="#356">356</a> @Parameter( property = <span class="jxr_string">"encoding"</span>, defaultValue = <span class="jxr_string">"${project.build.sourceEncoding}"</span> )
+<a class="jxr_linenumber" name="357" href="#357">357</a> <strong class="jxr_keyword">private</strong> String encoding;
+<a class="jxr_linenumber" name="358" href="#358">358</a>
+<a class="jxr_linenumber" name="359" href="#359">359</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a class="jxr_linenumber" name="360" href="#360">360</a> <strong class="jxr_keyword">protected</strong> MavenProject getProject()
+<a class="jxr_linenumber" name="361" href="#361">361</a> {
+<a class="jxr_linenumber" name="362" href="#362">362</a> <strong class="jxr_keyword">return</strong> project;
+<a class="jxr_linenumber" name="363" href="#363">363</a> }
+<a class="jxr_linenumber" name="364" href="#364">364</a>
+<a class="jxr_linenumber" name="365" href="#365">365</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a class="jxr_linenumber" name="366" href="#366">366</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> executeReport( Locale locale )
+<a class="jxr_linenumber" name="367" href="#367">367</a> <strong class="jxr_keyword">throws</strong> MavenReportException
+<a class="jxr_linenumber" name="368" href="#368">368</a> {
+<a class="jxr_linenumber" name="369" href="#369">369</a> mergeDeprecatedInfo();
+<a class="jxr_linenumber" name="370" href="#370">370</a> <strong class="jxr_keyword">super</strong>.executeReport( locale );
+<a class="jxr_linenumber" name="371" href="#371">371</a> }
+<a class="jxr_linenumber" name="372" href="#372">372</a>
+<a class="jxr_linenumber" name="373" href="#373">373</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="374" href="#374">374</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em>
+<a class="jxr_linenumber" name="375" href="#375">375</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="376" href="#376">376</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/maven/plugin/checkstyle/CheckstyleExecutorRequest.html">CheckstyleExecutorRequest</a> createRequest()
+<a class="jxr_linenumber" name="377" href="#377">377</a> <strong class="jxr_keyword">throws</strong> MavenReportException
+<a class="jxr_linenumber" name="378" href="#378">378</a> {
+<a class="jxr_linenumber" name="379" href="#379">379</a> <a href="../../../../../org/apache/maven/plugin/checkstyle/CheckstyleExecutorRequest.html">CheckstyleExecutorRequest</a> request = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/checkstyle/CheckstyleExecutorRequest.html">CheckstyleExecutorRequest</a>();
+<a class="jxr_linenumber" name="380" href="#380">380</a> request.setConsoleListener( getConsoleListener() ).setConsoleOutput( consoleOutput )
+<a class="jxr_linenumber" name="381" href="#381">381</a> .setExcludes( excludes ).setFailsOnError( failsOnError ).setIncludes( includes )
+<a class="jxr_linenumber" name="382" href="#382">382</a> .setResourceIncludes( resourceIncludes )
+<a class="jxr_linenumber" name="383" href="#383">383</a> .setResourceExcludes( resourceExcludes )
+<a class="jxr_linenumber" name="384" href="#384">384</a> .setIncludeResources( includeResources )
+<a class="jxr_linenumber" name="385" href="#385">385</a> .setIncludeTestResources( includeTestResources )
+<a class="jxr_linenumber" name="386" href="#386">386</a> .setIncludeTestSourceDirectory( includeTestSourceDirectory ).setListener( getListener() )
+<a class="jxr_linenumber" name="387" href="#387">387</a> .setLog( getLog() ).setProject( project ).setSourceDirectory( sourceDirectory ).setResources( resources )
+<a class="jxr_linenumber" name="388" href="#388">388</a> .setStringOutputStream( stringOutputStream ).setSuppressionsLocation( suppressionsLocation )
+<a class="jxr_linenumber" name="389" href="#389">389</a> .setTestSourceDirectory( testSourceDirectory ).setConfigLocation( configLocation )
+<a class="jxr_linenumber" name="390" href="#390">390</a> .setPropertyExpansion( propertyExpansion ).setHeaderLocation( headerLocation )
+<a class="jxr_linenumber" name="391" href="#391">391</a> .setCacheFile( cacheFile ).setSuppressionsFileExpression( suppressionsFileExpression )
+<a class="jxr_linenumber" name="392" href="#392">392</a> .setEncoding( encoding ).setPropertiesLocation( propertiesLocation );
+<a class="jxr_linenumber" name="393" href="#393">393</a> <strong class="jxr_keyword">return</strong> request;
+<a class="jxr_linenumber" name="394" href="#394">394</a> }
+<a class="jxr_linenumber" name="395" href="#395">395</a>
+<a class="jxr_linenumber" name="396" href="#396">396</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a class="jxr_linenumber" name="397" href="#397">397</a> <strong class="jxr_keyword">public</strong> String getOutputName()
+<a class="jxr_linenumber" name="398" href="#398">398</a> {
+<a class="jxr_linenumber" name="399" href="#399">399</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"checkstyle"</span>;
+<a class="jxr_linenumber" name="400" href="#400">400</a> }
+<a class="jxr_linenumber" name="401" href="#401">401</a>
+<a class="jxr_linenumber" name="402" href="#402">402</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em>
+<a class="jxr_linenumber" name="403" href="#403">403</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport()
+<a class="jxr_linenumber" name="404" href="#404">404</a> {
+<a class="jxr_linenumber" name="405" href="#405">405</a> <em class="jxr_comment">// TODO: would be good to scan the files here</em>
+<a class="jxr_linenumber" name="406" href="#406">406</a> <strong class="jxr_keyword">return</strong> !skip && ( sourceDirectory.exists() || ( includeTestSourceDirectory && testSourceDirectory.exists() ) );
+<a class="jxr_linenumber" name="407" href="#407">407</a> }
+<a class="jxr_linenumber" name="408" href="#408">408</a>
+<a class="jxr_linenumber" name="409" href="#409">409</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="410" href="#410">410</a> <em class="jxr_javadoccomment"> * Merge in the deprecated parameters to the new ones, unless the new</em>
+<a class="jxr_linenumber" name="411" href="#411">411</a> <em class="jxr_javadoccomment"> * parameters have values.</em>
+<a class="jxr_linenumber" name="412" href="#412">412</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="413" href="#413">413</a> <em class="jxr_javadoccomment"> * @deprecated Remove when deprecated params are removed.</em>
+<a class="jxr_linenumber" name="414" href="#414">414</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="415" href="#415">415</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> mergeDeprecatedInfo()
+<a class="jxr_linenumber" name="416" href="#416">416</a> {
+<a class="jxr_linenumber" name="417" href="#417">417</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"config/sun_checks.xml"</span>.equals( configLocation ) && !<span class="jxr_string">"sun"</span>.equals( format ) )
+<a class="jxr_linenumber" name="418" href="#418">418</a> {
+<a class="jxr_linenumber" name="419" href="#419">419</a> configLocation = FORMAT_TO_CONFIG_LOCATION.get( format );
+<a class="jxr_linenumber" name="420" href="#420">420</a> }
+<a class="jxr_linenumber" name="421" href="#421">421</a>
+<a class="jxr_linenumber" name="422" href="#422">422</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( propertiesLocation ) )
+<a class="jxr_linenumber" name="423" href="#423">423</a> {
+<a class="jxr_linenumber" name="424" href="#424">424</a> <strong class="jxr_keyword">if</strong> ( propertiesFile != <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="425" href="#425">425</a> {
+<a class="jxr_linenumber" name="426" href="#426">426</a> propertiesLocation = propertiesFile.getPath();
+<a class="jxr_linenumber" name="427" href="#427">427</a> }
+<a class="jxr_linenumber" name="428" href="#428">428</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( propertiesURL != <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="429" href="#429">429</a> {
+<a class="jxr_linenumber" name="430" href="#430">430</a> propertiesLocation = propertiesURL.toExternalForm();
+<a class="jxr_linenumber" name="431" href="#431">431</a> }
+<a class="jxr_linenumber" name="432" href="#432">432</a> }
+<a class="jxr_linenumber" name="433" href="#433">433</a>
+<a class="jxr_linenumber" name="434" href="#434">434</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"LICENSE.txt"</span>.equals( headerLocation ) )
+<a class="jxr_linenumber" name="435" href="#435">435</a> {
+<a class="jxr_linenumber" name="436" href="#436">436</a> File defaultHeaderFile = <strong class="jxr_keyword">new</strong> File( project.getBasedir(), <span class="jxr_string">"LICENSE.txt"</span> );
+<a class="jxr_linenumber" name="437" href="#437">437</a> <strong class="jxr_keyword">if</strong> ( !defaultHeaderFile.equals( headerFile ) )
+<a class="jxr_linenumber" name="438" href="#438">438</a> {
+<a class="jxr_linenumber" name="439" href="#439">439</a> headerLocation = headerFile.getPath();
+<a class="jxr_linenumber" name="440" href="#440">440</a> }
+<a class="jxr_linenumber" name="441" href="#441">441</a> }
+<a class="jxr_linenumber" name="442" href="#442">442</a>
+<a class="jxr_linenumber" name="443" href="#443">443</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( suppressionsLocation ) )
+<a class="jxr_linenumber" name="444" href="#444">444</a> {
+<a class="jxr_linenumber" name="445" href="#445">445</a> suppressionsLocation = suppressionsFile;
+<a class="jxr_linenumber" name="446" href="#446">446</a> }
+<a class="jxr_linenumber" name="447" href="#447">447</a>
+<a class="jxr_linenumber" name="448" href="#448">448</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( packageNamesLocation ) )
+<a class="jxr_linenumber" name="449" href="#449">449</a> {
+<a class="jxr_linenumber" name="450" href="#450">450</a> packageNamesLocation = packageNamesFile;
+<a class="jxr_linenumber" name="451" href="#451">451</a> }
+<a class="jxr_linenumber" name="452" href="#452">452</a> }
+<a class="jxr_linenumber" name="453" href="#453">453</a>
+<a class="jxr_linenumber" name="454" href="#454">454</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
Propchange: websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT/xref/org/apache/maven/plugin/checkstyle/CheckstyleReport.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT/xref/org/apache/maven/plugin/checkstyle/CheckstyleReport.html
------------------------------------------------------------------------------
svn:mime-type = text/html