Added:
websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/CheckstyleAggregateReport.html
==============================================================================
---
websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/CheckstyleAggregateReport.html
(added)
+++
websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/CheckstyleAggregateReport.html
Tue May 8 14:02:08 2012
@@ -0,0 +1,301 @@
+<!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>CheckstyleAggregateReport xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a
href="../../../../../../apidocs/org/apache/maven/plugin/checkstyle/CheckstyleAggregateReport.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> java.io.File;
+<a class="jxr_linenumber" name="23" href="#23">23</a> <strong
class="jxr_keyword">import</strong> java.util.List;
+<a class="jxr_linenumber" name="24" href="#24">24</a>
+<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>
+<a class="jxr_linenumber" name="28" href="#28">28</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="29" href="#29">29</a> <em
class="jxr_javadoccomment"> * Perform a Checkstyle analysis, and generate a
report on violations,</em>
+<a class="jxr_linenumber" name="30" href="#30">30</a> <em
class="jxr_javadoccomment"> * aggregating the result in the project which
started this mojo.</em>
+<a class="jxr_linenumber" name="31" href="#31">31</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="32" href="#32">32</a> <em
class="jxr_javadoccomment"> * @version $Id$</em>
+<a class="jxr_linenumber" name="33" href="#33">33</a> <em
class="jxr_javadoccomment"> * @goal checkstyle-aggregate</em>
+<a class="jxr_linenumber" name="34" href="#34">34</a> <em
class="jxr_javadoccomment"> * @aggregator</em>
+<a class="jxr_linenumber" name="35" href="#35">35</a> <em
class="jxr_javadoccomment"> * @requiresDependencyResolution compile</em>
+<a class="jxr_linenumber" name="36" href="#36">36</a> <em
class="jxr_javadoccomment"> * @threadSafe</em>
+<a class="jxr_linenumber" name="37" href="#37">37</a> <em
class="jxr_javadoccomment"> * @since 2.8</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> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong>
<a
href="../../../../../org/apache/maven/plugin/checkstyle/CheckstyleAggregateReport.html">CheckstyleAggregateReport</a>
+<a class="jxr_linenumber" name="40" href="#40">40</a> <strong
class="jxr_keyword">extends</strong> <a
href="../../../../../org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.html">AbstractCheckstyleReport</a>
+<a class="jxr_linenumber" name="41" href="#41">41</a> {
+<a class="jxr_linenumber" name="42" href="#42">42</a>
+<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> <em
class="jxr_javadoccomment"> * Specifies the names filter of the source
files to be used for Checkstyle.</em>
+<a class="jxr_linenumber" name="45" href="#45">45</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="46" href="#46">46</a> <em
class="jxr_javadoccomment"> * @parameter
expression="${checkstyle.includes}" default-value="**\/*.java"</em>
+<a class="jxr_linenumber" name="47" href="#47">47</a> <em
class="jxr_javadoccomment"> * @required</em>
+<a class="jxr_linenumber" name="48" href="#48">48</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="49" href="#49">49</a> <strong
class="jxr_keyword">private</strong> String includes;
+<a class="jxr_linenumber" name="50" href="#50">50</a>
+<a class="jxr_linenumber" name="51" href="#51">51</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="52" href="#52">52</a> <em
class="jxr_javadoccomment"> * Specifies the names filter of the source
files to be excluded for</em>
+<a class="jxr_linenumber" name="53" href="#53">53</a> <em
class="jxr_javadoccomment"> * Checkstyle.</em>
+<a class="jxr_linenumber" name="54" href="#54">54</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="55" href="#55">55</a> <em
class="jxr_javadoccomment"> * @parameter
expression="${checkstyle.excludes}"</em>
+<a class="jxr_linenumber" name="56" href="#56">56</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="57" href="#57">57</a> <strong
class="jxr_keyword">private</strong> String excludes;
+<a class="jxr_linenumber" name="58" href="#58">58</a>
+<a class="jxr_linenumber" name="59" href="#59">59</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="60" href="#60">60</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="61" href="#61">61</a> <em
class="jxr_javadoccomment"> * Specifies the location of the XML
configuration to use.</em>
+<a class="jxr_linenumber" name="62" href="#62">62</a> <em
class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="63" href="#63">63</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="64" href="#64">64</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="65" href="#65">65</a> <em
class="jxr_javadoccomment"> * Potential values are a filesystem path, a
URL, or a classpath resource.</em>
+<a class="jxr_linenumber" name="66" href="#66">66</a> <em
class="jxr_javadoccomment"> * This parameter expects that the contents of
the location conform to the</em>
+<a class="jxr_linenumber" name="67" href="#67">67</a> <em
class="jxr_javadoccomment"> * xml format (Checkstyle <a</em>
+<a class="jxr_linenumber" name="68" href="#68">68</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="69" href="#69">69</a> <em
class="jxr_javadoccomment"> * module</a>) configuration of
rulesets.</em>
+<a class="jxr_linenumber" name="70" href="#70">70</a> <em
class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="71" href="#71">71</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="72" href="#72">72</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="73" href="#73">73</a> <em
class="jxr_javadoccomment"> * This parameter is resolved as resource, URL,
then file. If successfully</em>
+<a class="jxr_linenumber" name="74" href="#74">74</a> <em
class="jxr_javadoccomment"> * resolved, the contents of the configuration
is copied into the</em>
+<a class="jxr_linenumber" name="75" href="#75">75</a> <em
class="jxr_javadoccomment"> *
<code>${project.build.directory}/checkstyle-configuration.xml</code></em>
+<a class="jxr_linenumber" name="76" href="#76">76</a> <em
class="jxr_javadoccomment"> * file before being passed to Checkstyle as a
configuration.</em>
+<a class="jxr_linenumber" name="77" href="#77">77</a> <em
class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="78" href="#78">78</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="79" href="#79">79</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="80" href="#80">80</a> <em
class="jxr_javadoccomment"> * There are 4 predefined rulesets.</em>
+<a class="jxr_linenumber" name="81" href="#81">81</a> <em
class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="82" href="#82">82</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="83" href="#83">83</a> <em
class="jxr_javadoccomment"> * <ul></em>
+<a class="jxr_linenumber" name="84" href="#84">84</a> <em
class="jxr_javadoccomment"> *
<li><code>config/sun_checks.xml</code>: Sun
Checks.</li></em>
+<a class="jxr_linenumber" name="85" href="#85">85</a> <em
class="jxr_javadoccomment"> *
<li><code>config/turbine_checks.xml</code>: Turbine
Checks.</li></em>
+<a class="jxr_linenumber" name="86" href="#86">86</a> <em
class="jxr_javadoccomment"> *
<li><code>config/avalon_checks.xml</code>: Avalon
Checks.</li></em>
+<a class="jxr_linenumber" name="87" href="#87">87</a> <em
class="jxr_javadoccomment"> *
<li><code>config/maven_checks.xml</code>: Maven Source
Checks.</li></em>
+<a class="jxr_linenumber" name="88" href="#88">88</a> <em
class="jxr_javadoccomment"> * </ul></em>
+<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"> * @parameter
expression="${checkstyle.config.location}"</em>
+<a class="jxr_linenumber" name="91" href="#91">91</a> <em
class="jxr_javadoccomment"> *
default-value="config/sun_checks.xml"</em>
+<a class="jxr_linenumber" name="92" href="#92">92</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="93" href="#93">93</a> <strong
class="jxr_keyword">private</strong> String configLocation;
+<a class="jxr_linenumber" name="94" href="#94">94</a>
+<a class="jxr_linenumber" name="95" href="#95">95</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="96" href="#96">96</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="97" href="#97">97</a> <em
class="jxr_javadoccomment"> * Specifies the location of the properties
file.</em>
+<a class="jxr_linenumber" name="98" href="#98">98</a> <em
class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="99" href="#99">99</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="100" href="#100">100</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="101" href="#101">101</a> <em
class="jxr_javadoccomment"> * This parameter is resolved as URL, File then
resource. If successfully</em>
+<a class="jxr_linenumber" name="102" href="#102">102</a> <em
class="jxr_javadoccomment"> * resolved, the contents of the properties
location is copied into the</em>
+<a class="jxr_linenumber" name="103" href="#103">103</a> <em
class="jxr_javadoccomment"> *
<code>${project.build.directory}/checkstyle-checker.properties</code></em>
+<a class="jxr_linenumber" name="104" href="#104">104</a> <em
class="jxr_javadoccomment"> * file before being passed to Checkstyle for
loading.</em>
+<a class="jxr_linenumber" name="105" href="#105">105</a> <em
class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="106" href="#106">106</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="107" href="#107">107</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="108" href="#108">108</a> <em
class="jxr_javadoccomment"> * The contents of the
<code>propertiesLocation</code> will be made</em>
+<a class="jxr_linenumber" name="109" href="#109">109</a> <em
class="jxr_javadoccomment"> * available to Checkstyle for specifying values
for parameters within the</em>
+<a class="jxr_linenumber" name="110" href="#110">110</a> <em
class="jxr_javadoccomment"> * xml configuration (specified in the
<code>configLocation</code></em>
+<a class="jxr_linenumber" name="111" href="#111">111</a> <em
class="jxr_javadoccomment"> * parameter).</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"> *</em>
+<a class="jxr_linenumber" name="114" href="#114">114</a> <em
class="jxr_javadoccomment"> * @parameter
expression="${checkstyle.properties.location}"</em>
+<a class="jxr_linenumber" name="115" href="#115">115</a> <em
class="jxr_javadoccomment"> * @since 2.0-beta-2</em>
+<a class="jxr_linenumber" name="116" href="#116">116</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="117" href="#117">117</a> <strong
class="jxr_keyword">private</strong> String propertiesLocation;
+<a class="jxr_linenumber" name="118" href="#118">118</a>
+<a class="jxr_linenumber" name="119" href="#119">119</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="120" href="#120">120</a> <em
class="jxr_javadoccomment"> * Allows for specifying raw property expansion
information.</em>
+<a class="jxr_linenumber" name="121" href="#121">121</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="122" href="#122">122</a> <em
class="jxr_javadoccomment"> * @parameter</em>
+<a class="jxr_linenumber" name="123" href="#123">123</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="124" href="#124">124</a> <strong
class="jxr_keyword">private</strong> String propertyExpansion;
+<a class="jxr_linenumber" name="125" href="#125">125</a>
+<a class="jxr_linenumber" name="126" href="#126">126</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="127" href="#127">127</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="128" href="#128">128</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="129" href="#129">129</a> <em
class="jxr_javadoccomment"> * can be used by Checkstyle to verify that
source code has the correct</em>
+<a class="jxr_linenumber" name="130" href="#130">130</a> <em
class="jxr_javadoccomment"> * license header.</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"> * <p></em>
+<a class="jxr_linenumber" name="133" href="#133">133</a> <em
class="jxr_javadoccomment"> * You need to use ${checkstyle.header.file} in
your Checkstyle xml</em>
+<a class="jxr_linenumber" name="134" href="#134">134</a> <em
class="jxr_javadoccomment"> * configuration to reference the name of this
header file.</em>
+<a class="jxr_linenumber" name="135" href="#135">135</a> <em
class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="136" href="#136">136</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="137" href="#137">137</a> <em
class="jxr_javadoccomment"> * For instance:</em>
+<a class="jxr_linenumber" name="138" href="#138">138</a> <em
class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="139" href="#139">139</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="140" href="#140">140</a> <em
class="jxr_javadoccomment"> * <code></em>
+<a class="jxr_linenumber" name="141" href="#141">141</a> <em
class="jxr_javadoccomment"> * &lt;module name="RegexpHeader"></em>
+<a class="jxr_linenumber" name="142" href="#142">142</a> <em
class="jxr_javadoccomment"> * &lt;property name="headerFile"
value="${checkstyle.header.file}"/></em>
+<a class="jxr_linenumber" name="143" href="#143">143</a> <em
class="jxr_javadoccomment"> * &lt;/module></em>
+<a class="jxr_linenumber" name="144" href="#144">144</a> <em
class="jxr_javadoccomment"> * </code></em>
+<a class="jxr_linenumber" name="145" href="#145">145</a> <em
class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="146" href="#146">146</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="147" href="#147">147</a> <em
class="jxr_javadoccomment"> * @parameter
expression="${checkstyle.header.file}" default-value="LICENSE.txt"</em>
+<a class="jxr_linenumber" name="148" href="#148">148</a> <em
class="jxr_javadoccomment"> * @since 2.0-beta-2</em>
+<a class="jxr_linenumber" name="149" href="#149">149</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="150" href="#150">150</a> <strong
class="jxr_keyword">private</strong> String headerLocation;
+<a class="jxr_linenumber" name="151" href="#151">151</a>
+<a class="jxr_linenumber" name="152" href="#152">152</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="153" href="#153">153</a> <em
class="jxr_javadoccomment"> * Specifies the cache file used to speed up
Checkstyle on successive runs.</em>
+<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"> * @parameter
default-value="${project.build.directory}/checkstyle-cachefile"</em>
+<a class="jxr_linenumber" name="156" href="#156">156</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="157" href="#157">157</a> <strong
class="jxr_keyword">private</strong> String cacheFile;
+<a class="jxr_linenumber" name="158" href="#158">158</a>
+<a class="jxr_linenumber" name="159" href="#159">159</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="160" href="#160">160</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="161" href="#161">161</a> <em
class="jxr_javadoccomment"> * Specifies the location of the suppressions
XML file to use.</em>
+<a class="jxr_linenumber" name="162" href="#162">162</a> <em
class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="163" href="#163">163</a> <em
class="jxr_javadoccomment"> *</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"> * This parameter is resolved as resource, URL,
then file. If successfully</em>
+<a class="jxr_linenumber" name="166" href="#166">166</a> <em
class="jxr_javadoccomment"> * resolved, the contents of the suppressions
XML is copied into the</em>
+<a class="jxr_linenumber" name="167" href="#167">167</a> <em
class="jxr_javadoccomment"> *
<code>${project.build.directory}/checkstyle-supressions.xml</code>
file</em>
+<a class="jxr_linenumber" name="168" href="#168">168</a> <em
class="jxr_javadoccomment"> * before being passed to Checkstyle for
loading.</em>
+<a class="jxr_linenumber" name="169" href="#169">169</a> <em
class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="170" href="#170">170</a> <em
class="jxr_javadoccomment"> *</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"> * See
<code>suppressionsFileExpression</code> for the property that
will</em>
+<a class="jxr_linenumber" name="173" href="#173">173</a> <em
class="jxr_javadoccomment"> * be made available to your checkstyle
configuration.</em>
+<a class="jxr_linenumber" name="174" href="#174">174</a> <em
class="jxr_javadoccomment"> * </p></em>
+<a class="jxr_linenumber" name="175" href="#175">175</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="176" href="#176">176</a> <em
class="jxr_javadoccomment"> * @parameter
expression="${checkstyle.suppressions.location}"</em>
+<a class="jxr_linenumber" name="177" href="#177">177</a> <em
class="jxr_javadoccomment"> * @since 2.0-beta-2</em>
+<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> <strong
class="jxr_keyword">private</strong> String suppressionsLocation;
+<a class="jxr_linenumber" name="180" href="#180">180</a>
+<a class="jxr_linenumber" name="181" href="#181">181</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="182" href="#182">182</a> <em
class="jxr_javadoccomment"> * The key to be used in the properties for the
suppressions file.</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> <em
class="jxr_javadoccomment"> * @parameter
expression="${checkstyle.suppression.expression}"</em>
+<a class="jxr_linenumber" name="185" href="#185">185</a> <em
class="jxr_javadoccomment"> *
default-value="checkstyle.suppressions.file"</em>
+<a class="jxr_linenumber" name="186" href="#186">186</a> <em
class="jxr_javadoccomment"> * @since 2.1</em>
+<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> <strong
class="jxr_keyword">private</strong> String suppressionsFileExpression;
+<a class="jxr_linenumber" name="189" href="#189">189</a>
+<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"> * Specifies if the build should fail upon a
violation.</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> <em
class="jxr_javadoccomment"> * @parameter default-value="false"</em>
+<a class="jxr_linenumber" name="194" href="#194">194</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="195" href="#195">195</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> failsOnError;
+<a class="jxr_linenumber" name="196" href="#196">196</a>
+<a class="jxr_linenumber" name="197" href="#197">197</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="198" href="#198">198</a> <em
class="jxr_javadoccomment"> * Specifies the location of the source
directory to be used for Checkstyle.</em>
+<a class="jxr_linenumber" name="199" href="#199">199</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="200" href="#200">200</a> <em
class="jxr_javadoccomment"> * @parameter
default-value="${project.build.sourceDirectory}"</em>
+<a class="jxr_linenumber" name="201" href="#201">201</a> <em
class="jxr_javadoccomment"> * @required</em>
+<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> <strong
class="jxr_keyword">private</strong> File sourceDirectory;
+<a class="jxr_linenumber" name="204" href="#204">204</a>
+<a class="jxr_linenumber" name="205" href="#205">205</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="206" href="#206">206</a> <em
class="jxr_javadoccomment"> * Specifies the location of the test source
directory to be used for</em>
+<a class="jxr_linenumber" name="207" href="#207">207</a> <em
class="jxr_javadoccomment"> * Checkstyle.</em>
+<a class="jxr_linenumber" name="208" href="#208">208</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="209" href="#209">209</a> <em
class="jxr_javadoccomment"> * @parameter
default-value="${project.build.testSourceDirectory}"</em>
+<a class="jxr_linenumber" name="210" href="#210">210</a> <em
class="jxr_javadoccomment"> * @since 2.2</em>
+<a class="jxr_linenumber" name="211" href="#211">211</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="212" href="#212">212</a> <strong
class="jxr_keyword">private</strong> File testSourceDirectory;
+<a class="jxr_linenumber" name="213" href="#213">213</a>
+<a class="jxr_linenumber" name="214" href="#214">214</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="215" href="#215">215</a> <em
class="jxr_javadoccomment"> * Include or not the test source directory to
be used for Checkstyle.</em>
+<a class="jxr_linenumber" name="216" href="#216">216</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="217" href="#217">217</a> <em
class="jxr_javadoccomment"> * @parameter default-value="${false}"</em>
+<a class="jxr_linenumber" name="218" href="#218">218</a> <em
class="jxr_javadoccomment"> * @since 2.2</em>
+<a class="jxr_linenumber" name="219" href="#219">219</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="220" href="#220">220</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> includeTestSourceDirectory;
+<a class="jxr_linenumber" name="221" href="#221">221</a>
+<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"> * Output errors to console.</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> <em
class="jxr_javadoccomment"> * @parameter default-value="false"</em>
+<a class="jxr_linenumber" name="226" href="#226">226</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="227" href="#227">227</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> consoleOutput;
+<a class="jxr_linenumber" name="228" href="#228">228</a>
+<a class="jxr_linenumber" name="229" href="#229">229</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="230" href="#230">230</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="231" href="#231">231</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="232" href="#232">232</a> <em
class="jxr_javadoccomment"> * property <code>charset</code>
from Checkstyle's <code>TreeWalker</code> module.</em>
+<a class="jxr_linenumber" name="233" href="#233">233</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="234" href="#234">234</a> <em
class="jxr_javadoccomment"> * @parameter expression="${encoding}"
default-value="${project.build.sourceEncoding}"</em>
+<a class="jxr_linenumber" name="235" href="#235">235</a> <em
class="jxr_javadoccomment"> * @since 2.2</em>
+<a class="jxr_linenumber" name="236" href="#236">236</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="237" href="#237">237</a> <strong
class="jxr_keyword">private</strong> String encoding;
+<a class="jxr_linenumber" name="238" href="#238">238</a>
+<a class="jxr_linenumber" name="239" href="#239">239</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="240" href="#240">240</a> <em
class="jxr_javadoccomment"> * The projects in the reactor for aggregation
report.</em>
+<a class="jxr_linenumber" name="241" href="#241">241</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="242" href="#242">242</a> <em
class="jxr_javadoccomment"> * @parameter
expression="${reactorProjects}"</em>
+<a class="jxr_linenumber" name="243" href="#243">243</a> <em
class="jxr_javadoccomment"> * @readonly</em>
+<a class="jxr_linenumber" name="244" href="#244">244</a> <em
class="jxr_javadoccomment"> * @since 2.8</em>
+<a class="jxr_linenumber" name="245" href="#245">245</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="246" href="#246">246</a> <strong
class="jxr_keyword">private</strong> List<MavenProject> reactorProjects;
+<a class="jxr_linenumber" name="247" href="#247">247</a>
+<a class="jxr_linenumber" name="248" href="#248">248</a> <em
class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment">
{@inheritDoc} */</em>
+<a class="jxr_linenumber" name="249" href="#249">249</a> <strong
class="jxr_keyword">protected</strong> MavenProject getProject()
+<a class="jxr_linenumber" name="250" href="#250">250</a> {
+<a class="jxr_linenumber" name="251" href="#251">251</a> <strong
class="jxr_keyword">return</strong> project;
+<a class="jxr_linenumber" name="252" href="#252">252</a> }
+<a class="jxr_linenumber" name="253" href="#253">253</a>
+<a class="jxr_linenumber" name="254" href="#254">254</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="255" href="#255">255</a> <em
class="jxr_javadoccomment"> * {@inheritDoc}</em>
+<a class="jxr_linenumber" name="256" href="#256">256</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="257" href="#257">257</a> <strong
class="jxr_keyword">protected</strong> <a
href="../../../../../org/apache/maven/plugin/checkstyle/CheckstyleExecutorRequest.html">CheckstyleExecutorRequest</a>
createRequest()
+<a class="jxr_linenumber" name="258" href="#258">258</a> <strong
class="jxr_keyword">throws</strong> MavenReportException
+<a class="jxr_linenumber" name="259" href="#259">259</a> {
+<a class="jxr_linenumber" name="260" href="#260">260</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="261" href="#261">261</a>
request.setAggregate( <strong class="jxr_keyword">true</strong> )
+<a class="jxr_linenumber" name="262" href="#262">262</a>
.setReactorProjects( reactorProjects )
+<a class="jxr_linenumber" name="263" href="#263">263</a>
.setConsoleListener( getConsoleListener() ).setConsoleOutput( consoleOutput )
+<a class="jxr_linenumber" name="264" href="#264">264</a>
.setExcludes( excludes ).setFailsOnError( failsOnError ).setIncludes( includes )
+<a class="jxr_linenumber" name="265" href="#265">265</a>
.setIncludeTestSourceDirectory( includeTestSourceDirectory ).setListener(
getListener() )
+<a class="jxr_linenumber" name="266" href="#266">266</a> .setLog(
getLog() ).setProject( project ).setSourceDirectory( sourceDirectory )
+<a class="jxr_linenumber" name="267" href="#267">267</a>
.setStringOutputStream( stringOutputStream ).setSuppressionsLocation(
suppressionsLocation )
+<a class="jxr_linenumber" name="268" href="#268">268</a>
.setTestSourceDirectory( testSourceDirectory ).setConfigLocation(
configLocation )
+<a class="jxr_linenumber" name="269" href="#269">269</a>
.setPropertyExpansion( propertyExpansion ).setHeaderLocation( headerLocation )
+<a class="jxr_linenumber" name="270" href="#270">270</a>
.setCacheFile( cacheFile ).setSuppressionsFileExpression(
suppressionsFileExpression )
+<a class="jxr_linenumber" name="271" href="#271">271</a>
.setEncoding( encoding ).setPropertiesLocation( propertiesLocation );
+<a class="jxr_linenumber" name="272" href="#272">272</a> <strong
class="jxr_keyword">return</strong> request;
+<a class="jxr_linenumber" name="273" href="#273">273</a> }
+<a class="jxr_linenumber" name="274" href="#274">274</a>
+<a class="jxr_linenumber" name="275" href="#275">275</a>
+<a class="jxr_linenumber" name="276" href="#276">276</a> <em
class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment">
{@inheritDoc} */</em>
+<a class="jxr_linenumber" name="277" href="#277">277</a> <strong
class="jxr_keyword">public</strong> String getOutputName()
+<a class="jxr_linenumber" name="278" href="#278">278</a> {
+<a class="jxr_linenumber" name="279" href="#279">279</a> <strong
class="jxr_keyword">return</strong> <span
class="jxr_string">"checkstyle-aggregate"</span>;
+<a class="jxr_linenumber" name="280" href="#280">280</a> }
+<a class="jxr_linenumber" name="281" href="#281">281</a>
+<a class="jxr_linenumber" name="282" href="#282">282</a> <em
class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment">
{@inheritDoc} */</em>
+<a class="jxr_linenumber" name="283" href="#283">283</a> <strong
class="jxr_keyword">public</strong> <strong
class="jxr_keyword">boolean</strong> canGenerateReport()
+<a class="jxr_linenumber" name="284" href="#284">284</a> {
+<a class="jxr_linenumber" name="285" href="#285">285</a> <em
class="jxr_comment">// TODO: would be good to scan the files here</em>
+<a class="jxr_linenumber" name="286" href="#286">286</a> <strong
class="jxr_keyword">return</strong> !skip && project.isExecutionRoot();
+<a class="jxr_linenumber" name="287" href="#287">287</a> }
+<a class="jxr_linenumber" name="288" href="#288">288</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a
href="http://maven.apache.org/";>Maven</a></div></body>
+</html>
Propchange:
websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/CheckstyleAggregateReport.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/CheckstyleAggregateReport.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
