You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2012/05/08 15:52:36 UTC
svn commit: r816652 [21/21] - in
/websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest:
./ apidocs/ apidocs/org/apache/maven/plugin/checkstyle/
apidocs/org/apache/maven/plugin/checkstyle/class-use/ cobertura/ css/
examples/ imag...
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.html (original)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.html Tue May 8 13:52:31 2012
@@ -32,175 +32,214 @@
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException;
-<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.pull.MXParser;
-<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.pull.XmlPullParser;
-<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.pull.XmlPullParserException;
-<a name="28" href="#28">28</a>
-<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.io.BufferedReader;
-<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.io.File;
-<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream;
+<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory;
+<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.pull.MXParser;
+<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.pull.XmlPullParser;
+<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.pull.XmlPullParserException;
+<a name="29" href="#29">29</a>
+<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.io.BufferedReader;
+<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
-<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> java.io.InputStreamReader;
-<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> java.io.Reader;
-<a name="35" href="#35">35</a>
-<a name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em>
-<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * Perform a violation check against the last Checkstyle run to see if there are</em>
-<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * any violations. It reads the Checkstyle output file, counts the number of</em>
-<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * violations found and displays it on the console.</em>
-<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> *</em>
-<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:joakim@erdfelt.net" target="alexandria_uri">mailto:joakim@erdfelt.net</a>">Joakim Erdfelt</a></em>
-<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @goal check</em>
-<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @phase verify</em>
-<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * @execute goal="checkstyle"</em>
-<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * @requiresDependencyResolution compile</em>
-<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> */</em>
-<a name="47" href="#47">47</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.html">CheckstyleViolationCheckMojo</a>
-<a name="48" href="#48">48</a> <strong class="jxr_keyword">extends</strong> AbstractMojo
-<a name="49" href="#49">49</a> {
-<a name="50" href="#50">50</a> <em class="jxr_javadoccomment">/**</em>
-<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * Specifies the path and filename to save the Checkstyle output. The format</em>
-<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * of the output file is determined by the <code>outputFileFormat</code></em>
-<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * parameter.</em>
-<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> *</em>
-<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * @parameter expression="${checkstyle.output.file}"</em>
-<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * default-value="${project.build.directory}/checkstyle-result.xml"</em>
-<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em>
-<a name="58" href="#58">58</a> <strong class="jxr_keyword">private</strong> File outputFile;
-<a name="59" href="#59">59</a>
-<a name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em>
-<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * Specifies the format of the output to be used when writing to the output</em>
-<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * file. Valid values are "plain" and "xml".</em>
-<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> *</em>
-<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @parameter expression="${checkstyle.output.format}" default-value="xml"</em>
-<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em>
-<a name="66" href="#66">66</a> <strong class="jxr_keyword">private</strong> String outputFileFormat;
-<a name="67" href="#67">67</a>
-<a name="68" href="#68">68</a> <em class="jxr_javadoccomment">/**</em>
-<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * Do we fail the build on a violation?</em>
-<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> *</em>
-<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @parameter expression="${checkstyle.failOnViolation}"</em>
-<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * default-value="true"</em>
-<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> */</em>
-<a name="74" href="#74">74</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> failOnViolation;
-<a name="75" href="#75">75</a>
-<a name="76" href="#76">76</a> <em class="jxr_javadoccomment">/**</em>
-<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * The lowest severity level that is considered a violation.</em>
-<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * Valid values are "error", "warning" and "info".</em>
-<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> *</em>
-<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * @parameter expression="${checkstyle.violationSeverity}" default-value="error"</em>
-<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * @since 2.2</em>
-<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> */</em>
-<a name="83" href="#83">83</a> <strong class="jxr_keyword">private</strong> String violationSeverity = <span class="jxr_string">"error"</span>;
-<a name="84" href="#84">84</a>
-<a name="85" href="#85">85</a> <em class="jxr_javadoccomment">/**</em>
-<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * Skip entire check.</em>
+<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> java.io.Reader;
+<a name="34" href="#34">34</a>
+<a name="35" href="#35">35</a> <em class="jxr_javadoccomment">/**</em>
+<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * Perform a violation check against the last Checkstyle run to see if there are</em>
+<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * any violations. It reads the Checkstyle output file, counts the number of</em>
+<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * violations found and displays it on the console.</em>
+<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> *</em>
+<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:joakim@erdfelt.net" target="alexandria_uri">mailto:joakim@erdfelt.net</a>">Joakim Erdfelt</a></em>
+<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @goal check</em>
+<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @phase verify</em>
+<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @execute goal="checkstyle"</em>
+<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * @requiresDependencyResolution compile</em>
+<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> */</em>
+<a name="46" href="#46">46</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.html">CheckstyleViolationCheckMojo</a>
+<a name="47" href="#47">47</a> <strong class="jxr_keyword">extends</strong> AbstractMojo
+<a name="48" href="#48">48</a> {
+<a name="49" href="#49">49</a> <em class="jxr_javadoccomment">/**</em>
+<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * Specifies the path and filename to save the Checkstyle output. The format</em>
+<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * of the output file is determined by the <code>outputFileFormat</code></em>
+<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * parameter.</em>
+<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> *</em>
+<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @parameter expression="${checkstyle.output.file}"</em>
+<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * default-value="${project.build.directory}/checkstyle-result.xml"</em>
+<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> */</em>
+<a name="57" href="#57">57</a> <strong class="jxr_keyword">private</strong> File outputFile;
+<a name="58" href="#58">58</a>
+<a name="59" href="#59">59</a> <em class="jxr_javadoccomment">/**</em>
+<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * Specifies the format of the output to be used when writing to the output</em>
+<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * file. Valid values are "plain" and "xml".</em>
+<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> *</em>
+<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * @parameter expression="${checkstyle.output.format}" default-value="xml"</em>
+<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> */</em>
+<a name="65" href="#65">65</a> <strong class="jxr_keyword">private</strong> String outputFileFormat;
+<a name="66" href="#66">66</a>
+<a name="67" href="#67">67</a> <em class="jxr_javadoccomment">/**</em>
+<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * Do we fail the build on a violation?</em>
+<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> *</em>
+<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * @parameter expression="${checkstyle.failOnViolation}"</em>
+<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * default-value="true"</em>
+<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> */</em>
+<a name="73" href="#73">73</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> failOnViolation;
+<a name="74" href="#74">74</a>
+<a name="75" href="#75">75</a> <em class="jxr_javadoccomment">/**</em>
+<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * The maximum number of allowed violations. The execution fails only if the</em>
+<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * number of violations is above this limit.</em>
+<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> *</em>
+<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * @parameter expression="${checkstyle.maxAllowedViolations}" default-value="0"</em>
+<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * @since 2.3</em>
+<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> */</em>
+<a name="82" href="#82">82</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> maxAllowedViolations = 0;
+<a name="83" href="#83">83</a>
+<a name="84" href="#84">84</a> <em class="jxr_javadoccomment">/**</em>
+<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * The lowest severity level that is considered a violation.</em>
+<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * Valid values are "error", "warning" and "info".</em>
<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> *</em>
-<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * @parameter expression="${checkstyle.skip}" default-value="false"</em>
+<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * @parameter expression="${checkstyle.violationSeverity}" default-value="error"</em>
<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * @since 2.2</em>
<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> */</em>
-<a name="91" href="#91">91</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip;
+<a name="91" href="#91">91</a> <strong class="jxr_keyword">private</strong> String violationSeverity = <span class="jxr_string">"error"</span>;
<a name="92" href="#92">92</a>
<a name="93" href="#93">93</a> <em class="jxr_javadoccomment">/**</em>
-<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * @see org.apache.maven.plugin.Mojo#execute()</em>
-<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> */</em>
-<a name="96" href="#96">96</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute()
-<a name="97" href="#97">97</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException
-<a name="98" href="#98">98</a> {
-<a name="99" href="#99">99</a> <strong class="jxr_keyword">if</strong> ( !skip )
-<a name="100" href="#100">100</a> {
-<a name="101" href="#101">101</a> <strong class="jxr_keyword">if</strong> ( !<span class="jxr_string">"xml"</span>.equals( outputFileFormat ) )
-<a name="102" href="#102">102</a> {
-<a name="103" href="#103">103</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Output format is '"</span> + outputFileFormat
-<a name="104" href="#104">104</a> + <span class="jxr_string">"', checkstyle:check requires format to be 'xml'."</span> );
-<a name="105" href="#105">105</a> }
-<a name="106" href="#106">106</a>
-<a name="107" href="#107">107</a> <strong class="jxr_keyword">if</strong> ( !outputFile.exists() )
-<a name="108" href="#108">108</a> {
-<a name="109" href="#109">109</a> getLog().info(
-<a name="110" href="#110">110</a> <span class="jxr_string">"Unable to perform checkstyle:check, "</span>
-<a name="111" href="#111">111</a> + <span class="jxr_string">"unable to find checkstyle:checkstyle outputFile."</span> );
-<a name="112" href="#112">112</a> <strong class="jxr_keyword">return</strong>;
-<a name="113" href="#113">113</a> }
-<a name="114" href="#114">114</a>
-<a name="115" href="#115">115</a> <strong class="jxr_keyword">try</strong>
-<a name="116" href="#116">116</a> {
-<a name="117" href="#117">117</a> XmlPullParser xpp = <strong class="jxr_keyword">new</strong> MXParser();
-<a name="118" href="#118">118</a> <em class="jxr_comment">// TODO: use ReaderFactory.newXmlReader() when plexus-utils can be upgraded</em>
-<a name="119" href="#119">119</a> Reader freader = <strong class="jxr_keyword">new</strong> InputStreamReader( <strong class="jxr_keyword">new</strong> FileInputStream( outputFile ), <span class="jxr_string">"UTF-8"</span> );
-<a name="120" href="#120">120</a> BufferedReader breader = <strong class="jxr_keyword">new</strong> BufferedReader( freader );
-<a name="121" href="#121">121</a> xpp.setInput( breader );
+<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * Skip entire check.</em>
+<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> *</em>
+<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * @parameter expression="${checkstyle.skip}" default-value="false"</em>
+<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * @since 2.2</em>
+<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> */</em>
+<a name="99" href="#99">99</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip;
+<a name="100" href="#100">100</a>
+<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">/**</em>
+<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * Output the detected violations to the console.</em>
+<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> *</em>
+<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * @parameter expression="${checkstyle.console}" default-value="false"</em>
+<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * @since 2.3</em>
+<a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> */</em>
+<a name="107" href="#107">107</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> logViolationsToConsole;
+<a name="108" href="#108">108</a>
+<a name="109" href="#109">109</a> <em class="jxr_javadoccomment">/**</em>
+<a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * @see org.apache.maven.plugin.Mojo#execute()</em>
+<a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> */</em>
+<a name="112" href="#112">112</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute()
+<a name="113" href="#113">113</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException
+<a name="114" href="#114">114</a> {
+<a name="115" href="#115">115</a> <strong class="jxr_keyword">if</strong> ( !skip )
+<a name="116" href="#116">116</a> {
+<a name="117" href="#117">117</a> <strong class="jxr_keyword">if</strong> ( !<span class="jxr_string">"xml"</span>.equals( outputFileFormat ) )
+<a name="118" href="#118">118</a> {
+<a name="119" href="#119">119</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Output format is '"</span> + outputFileFormat
+<a name="120" href="#120">120</a> + <span class="jxr_string">"', checkstyle:check requires format to be 'xml'."</span> );
+<a name="121" href="#121">121</a> }
<a name="122" href="#122">122</a>
-<a name="123" href="#123">123</a> <strong class="jxr_keyword">int</strong> violations = countViolations( xpp );
-<a name="124" href="#124">124</a> <strong class="jxr_keyword">if</strong> ( violations > 0 )
-<a name="125" href="#125">125</a> {
-<a name="126" href="#126">126</a> <strong class="jxr_keyword">if</strong> ( failOnViolation )
-<a name="127" href="#127">127</a> {
-<a name="128" href="#128">128</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException( <span class="jxr_string">"You have "</span> + violations + <span class="jxr_string">" Checkstyle violation"</span>
-<a name="129" href="#129">129</a> + ( ( violations > 1 ) ? <span class="jxr_string">"s"</span> : <span class="jxr_string">""</span> ) + <span class="jxr_string">"."</span> );
-<a name="130" href="#130">130</a> }
-<a name="131" href="#131">131</a>
-<a name="132" href="#132">132</a> getLog().warn( <span class="jxr_string">"checkstyle:check violations detected but failOnViolation set to false"</span> );
-<a name="133" href="#133">133</a> }
-<a name="134" href="#134">134</a> }
-<a name="135" href="#135">135</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
-<a name="136" href="#136">136</a> {
-<a name="137" href="#137">137</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Unable to read Checkstyle results xml: "</span>
-<a name="138" href="#138">138</a> + outputFile.getAbsolutePath(), e );
-<a name="139" href="#139">139</a> }
-<a name="140" href="#140">140</a> <strong class="jxr_keyword">catch</strong> ( XmlPullParserException e )
-<a name="141" href="#141">141</a> {
-<a name="142" href="#142">142</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Unable to read Checkstyle results xml: "</span>
-<a name="143" href="#143">143</a> + outputFile.getAbsolutePath(), e );
-<a name="144" href="#144">144</a> }
-<a name="145" href="#145">145</a> }
-<a name="146" href="#146">146</a> }
-<a name="147" href="#147">147</a>
-<a name="148" href="#148">148</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> countViolations( XmlPullParser xpp )
-<a name="149" href="#149">149</a> <strong class="jxr_keyword">throws</strong> XmlPullParserException, IOException
-<a name="150" href="#150">150</a> {
-<a name="151" href="#151">151</a> <strong class="jxr_keyword">int</strong> count = 0;
-<a name="152" href="#152">152</a>
-<a name="153" href="#153">153</a> <strong class="jxr_keyword">int</strong> eventType = xpp.getEventType();
-<a name="154" href="#154">154</a> <strong class="jxr_keyword">while</strong> ( eventType != XmlPullParser.END_DOCUMENT )
-<a name="155" href="#155">155</a> {
-<a name="156" href="#156">156</a> <strong class="jxr_keyword">if</strong> ( eventType == XmlPullParser.START_TAG && <span class="jxr_string">"error"</span>.equals( xpp.getName() )
-<a name="157" href="#157">157</a> && isViolation( xpp.getAttributeValue( <span class="jxr_string">""</span>, <span class="jxr_string">"severity"</span> ) ) )
-<a name="158" href="#158">158</a> {
-<a name="159" href="#159">159</a> count++;
-<a name="160" href="#160">160</a> }
-<a name="161" href="#161">161</a> eventType = xpp.next();
-<a name="162" href="#162">162</a> }
-<a name="163" href="#163">163</a>
-<a name="164" href="#164">164</a> <strong class="jxr_keyword">return</strong> count;
-<a name="165" href="#165">165</a> }
-<a name="166" href="#166">166</a>
-<a name="167" href="#167">167</a> <em class="jxr_javadoccomment">/**</em>
-<a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * Checks if the given severity is considered a violation.</em>
-<a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> *</em>
-<a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * @param severity The severity to check</em>
-<a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the given severity is a violation, otherwise <code>false</code></em>
-<a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> */</em>
-<a name="173" href="#173">173</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isViolation( String severity )
-<a name="174" href="#174">174</a> {
-<a name="175" href="#175">175</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"error"</span>.equals( severity ) )
+<a name="123" href="#123">123</a> <strong class="jxr_keyword">if</strong> ( !outputFile.exists() )
+<a name="124" href="#124">124</a> {
+<a name="125" href="#125">125</a> getLog().info(
+<a name="126" href="#126">126</a> <span class="jxr_string">"Unable to perform checkstyle:check, "</span>
+<a name="127" href="#127">127</a> + <span class="jxr_string">"unable to find checkstyle:checkstyle outputFile."</span> );
+<a name="128" href="#128">128</a> <strong class="jxr_keyword">return</strong>;
+<a name="129" href="#129">129</a> }
+<a name="130" href="#130">130</a>
+<a name="131" href="#131">131</a> <strong class="jxr_keyword">try</strong>
+<a name="132" href="#132">132</a> {
+<a name="133" href="#133">133</a> XmlPullParser xpp = <strong class="jxr_keyword">new</strong> MXParser();
+<a name="134" href="#134">134</a> Reader freader = ReaderFactory.newXmlReader( outputFile );
+<a name="135" href="#135">135</a> BufferedReader breader = <strong class="jxr_keyword">new</strong> BufferedReader( freader );
+<a name="136" href="#136">136</a> xpp.setInput( breader );
+<a name="137" href="#137">137</a>
+<a name="138" href="#138">138</a> <strong class="jxr_keyword">int</strong> violations = countViolations( xpp );
+<a name="139" href="#139">139</a> <strong class="jxr_keyword">if</strong> ( violations > maxAllowedViolations )
+<a name="140" href="#140">140</a> {
+<a name="141" href="#141">141</a> <strong class="jxr_keyword">if</strong> ( failOnViolation )
+<a name="142" href="#142">142</a> {
+<a name="143" href="#143">143</a> String msg = <span class="jxr_string">"You have "</span> + violations + <span class="jxr_string">" Checkstyle violation"</span>
+<a name="144" href="#144">144</a> + ( ( violations > 1 ) ? <span class="jxr_string">"s"</span> : <span class="jxr_string">""</span> ) + <span class="jxr_string">"."</span>;
+<a name="145" href="#145">145</a> <strong class="jxr_keyword">if</strong> ( maxAllowedViolations > 0 )
+<a name="146" href="#146">146</a> {
+<a name="147" href="#147">147</a> msg += <span class="jxr_string">" The maximum number of allowed violations is "</span> + maxAllowedViolations + <span class="jxr_string">"."</span>;
+<a name="148" href="#148">148</a> }
+<a name="149" href="#149">149</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException( msg );
+<a name="150" href="#150">150</a> }
+<a name="151" href="#151">151</a>
+<a name="152" href="#152">152</a> getLog().warn( <span class="jxr_string">"checkstyle:check violations detected but failOnViolation set to false"</span> );
+<a name="153" href="#153">153</a> }
+<a name="154" href="#154">154</a> }
+<a name="155" href="#155">155</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
+<a name="156" href="#156">156</a> {
+<a name="157" href="#157">157</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Unable to read Checkstyle results xml: "</span>
+<a name="158" href="#158">158</a> + outputFile.getAbsolutePath(), e );
+<a name="159" href="#159">159</a> }
+<a name="160" href="#160">160</a> <strong class="jxr_keyword">catch</strong> ( XmlPullParserException e )
+<a name="161" href="#161">161</a> {
+<a name="162" href="#162">162</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Unable to read Checkstyle results xml: "</span>
+<a name="163" href="#163">163</a> + outputFile.getAbsolutePath(), e );
+<a name="164" href="#164">164</a> }
+<a name="165" href="#165">165</a> }
+<a name="166" href="#166">166</a> }
+<a name="167" href="#167">167</a>
+<a name="168" href="#168">168</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> countViolations( XmlPullParser xpp )
+<a name="169" href="#169">169</a> <strong class="jxr_keyword">throws</strong> XmlPullParserException, IOException
+<a name="170" href="#170">170</a> {
+<a name="171" href="#171">171</a> <strong class="jxr_keyword">int</strong> count = 0;
+<a name="172" href="#172">172</a>
+<a name="173" href="#173">173</a> <strong class="jxr_keyword">int</strong> eventType = xpp.getEventType();
+<a name="174" href="#174">174</a> String file = <span class="jxr_string">""</span>;
+<a name="175" href="#175">175</a> <strong class="jxr_keyword">while</strong> ( eventType != XmlPullParser.END_DOCUMENT )
<a name="176" href="#176">176</a> {
-<a name="177" href="#177">177</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"error"</span>.equals( violationSeverity ) || <span class="jxr_string">"warning"</span>.equals( violationSeverity )
-<a name="178" href="#178">178</a> || <span class="jxr_string">"info"</span>.equals( violationSeverity );
-<a name="179" href="#179">179</a> }
-<a name="180" href="#180">180</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"warning"</span>.equals( severity ) )
-<a name="181" href="#181">181</a> {
-<a name="182" href="#182">182</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"warning"</span>.equals( violationSeverity ) || <span class="jxr_string">"info"</span>.equals( violationSeverity );
-<a name="183" href="#183">183</a> }
-<a name="184" href="#184">184</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"info"</span>.equals( severity ) )
-<a name="185" href="#185">185</a> {
-<a name="186" href="#186">186</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"info"</span>.equals( violationSeverity );
-<a name="187" href="#187">187</a> }
-<a name="188" href="#188">188</a> <strong class="jxr_keyword">else</strong>
-<a name="189" href="#189">189</a> {
-<a name="190" href="#190">190</a> <strong class="jxr_keyword">return</strong> false;
-<a name="191" href="#191">191</a> }
-<a name="192" href="#192">192</a> }
-<a name="193" href="#193">193</a> }
+<a name="177" href="#177">177</a> <strong class="jxr_keyword">if</strong> ( eventType == XmlPullParser.START_TAG && <span class="jxr_string">"file"</span>.equals( xpp.getName() ) )
+<a name="178" href="#178">178</a> {
+<a name="179" href="#179">179</a> file = xpp.getAttributeValue( <span class="jxr_string">""</span>, <span class="jxr_string">"name"</span> );
+<a name="180" href="#180">180</a> file = file.substring( file.lastIndexOf( File.separatorChar ) + 1 );
+<a name="181" href="#181">181</a> }
+<a name="182" href="#182">182</a>
+<a name="183" href="#183">183</a> <strong class="jxr_keyword">if</strong> ( eventType == XmlPullParser.START_TAG && <span class="jxr_string">"error"</span>.equals( xpp.getName() )
+<a name="184" href="#184">184</a> && isViolation( xpp.getAttributeValue( <span class="jxr_string">""</span>, <span class="jxr_string">"severity"</span> ) ) )
+<a name="185" href="#185">185</a> {
+<a name="186" href="#186">186</a> <strong class="jxr_keyword">if</strong> ( logViolationsToConsole )
+<a name="187" href="#187">187</a> {
+<a name="188" href="#188">188</a> StringBuffer stb = <strong class="jxr_keyword">new</strong> StringBuffer();
+<a name="189" href="#189">189</a> stb.append( file );
+<a name="190" href="#190">190</a> stb.append( '[' );
+<a name="191" href="#191">191</a> stb.append( xpp.getAttributeValue( <span class="jxr_string">""</span>, <span class="jxr_string">"line"</span> ) );
+<a name="192" href="#192">192</a> stb.append( ':' );
+<a name="193" href="#193">193</a> stb.append( xpp.getAttributeValue( <span class="jxr_string">""</span>, <span class="jxr_string">"column"</span> ) );
+<a name="194" href="#194">194</a> stb.append( <span class="jxr_string">"] "</span> );
+<a name="195" href="#195">195</a> stb.append( xpp.getAttributeValue( <span class="jxr_string">""</span>, <span class="jxr_string">"message"</span> ) );
+<a name="196" href="#196">196</a> getLog().error( stb.toString() );
+<a name="197" href="#197">197</a> }
+<a name="198" href="#198">198</a> count++;
+<a name="199" href="#199">199</a> }
+<a name="200" href="#200">200</a> eventType = xpp.next();
+<a name="201" href="#201">201</a> }
+<a name="202" href="#202">202</a>
+<a name="203" href="#203">203</a> <strong class="jxr_keyword">return</strong> count;
+<a name="204" href="#204">204</a> }
+<a name="205" href="#205">205</a>
+<a name="206" href="#206">206</a> <em class="jxr_javadoccomment">/**</em>
+<a name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * Checks if the given severity is considered a violation.</em>
+<a name="208" href="#208">208</a> <em class="jxr_javadoccomment"> *</em>
+<a name="209" href="#209">209</a> <em class="jxr_javadoccomment"> * @param severity The severity to check</em>
+<a name="210" href="#210">210</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the given severity is a violation, otherwise <code>false</code></em>
+<a name="211" href="#211">211</a> <em class="jxr_javadoccomment"> */</em>
+<a name="212" href="#212">212</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isViolation( String severity )
+<a name="213" href="#213">213</a> {
+<a name="214" href="#214">214</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"error"</span>.equals( severity ) )
+<a name="215" href="#215">215</a> {
+<a name="216" href="#216">216</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"error"</span>.equals( violationSeverity ) || <span class="jxr_string">"warning"</span>.equals( violationSeverity )
+<a name="217" href="#217">217</a> || <span class="jxr_string">"info"</span>.equals( violationSeverity );
+<a name="218" href="#218">218</a> }
+<a name="219" href="#219">219</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"warning"</span>.equals( severity ) )
+<a name="220" href="#220">220</a> {
+<a name="221" href="#221">221</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"warning"</span>.equals( violationSeverity ) || <span class="jxr_string">"info"</span>.equals( violationSeverity );
+<a name="222" href="#222">222</a> }
+<a name="223" href="#223">223</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"info"</span>.equals( severity ) )
+<a name="224" href="#224">224</a> {
+<a name="225" href="#225">225</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"info"</span>.equals( violationSeverity );
+<a name="226" href="#226">226</a> }
+<a name="227" href="#227">227</a> <strong class="jxr_keyword">else</strong>
+<a name="228" href="#228">228</a> {
+<a name="229" href="#229">229</a> <strong class="jxr_keyword">return</strong> false;
+<a name="230" href="#230">230</a> }
+<a name="231" href="#231">231</a> }
+<a name="232" href="#232">232</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/VelocityTemplate.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/VelocityTemplate.html (original)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/VelocityTemplate.html Tue May 8 13:52:31 2012
@@ -54,115 +54,114 @@
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * <pre></em>
<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * /&#042;&#042;</em>
<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * &#042; Velocity Component</em>
-<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * &#042; &#064;parameter expression="${component.org.codehaus.plexus.velocity.VelocityComponent}"</em>
-<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * &#042; &#064;readonly</em>
-<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * &#042;/</em>
-<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * private VelocityComponent velocity;</em>
-<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * </pre></em>
-<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> *</em>
-<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:joakim@erdfelt.net" target="alexandria_uri">mailto:joakim@erdfelt.net</a>">Joakim Erdfelt</a></em>
-<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> */</em>
-<a name="55" href="#55">55</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugin/checkstyle/VelocityTemplate.html">VelocityTemplate</a>
-<a name="56" href="#56">56</a> {
-<a name="57" href="#57">57</a> <strong class="jxr_keyword">private</strong> String templateDirectory;
-<a name="58" href="#58">58</a>
-<a name="59" href="#59">59</a> <strong class="jxr_keyword">private</strong> Log log;
-<a name="60" href="#60">60</a>
-<a name="61" href="#61">61</a> <strong class="jxr_keyword">private</strong> VelocityComponent velocity;
-<a name="62" href="#62">62</a>
-<a name="63" href="#63">63</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/maven/plugin/checkstyle/VelocityTemplate.html">VelocityTemplate</a>( VelocityComponent velocityComponent, String templateBaseDirectory )
-<a name="64" href="#64">64</a> {
-<a name="65" href="#65">65</a> <strong class="jxr_keyword">this</strong>.velocity = velocityComponent;
-<a name="66" href="#66">66</a> <strong class="jxr_keyword">this</strong>.templateDirectory = templateBaseDirectory;
-<a name="67" href="#67">67</a> }
-<a name="68" href="#68">68</a>
-<a name="69" href="#69">69</a> <strong class="jxr_keyword">public</strong> String getTemplateDirectory()
-<a name="70" href="#70">70</a> {
-<a name="71" href="#71">71</a> <strong class="jxr_keyword">return</strong> templateDirectory;
-<a name="72" href="#72">72</a> }
-<a name="73" href="#73">73</a>
-<a name="74" href="#74">74</a> <strong class="jxr_keyword">public</strong> VelocityComponent getVelocity()
-<a name="75" href="#75">75</a> {
-<a name="76" href="#76">76</a> <strong class="jxr_keyword">return</strong> velocity;
-<a name="77" href="#77">77</a> }
-<a name="78" href="#78">78</a>
-<a name="79" href="#79">79</a> <em class="jxr_javadoccomment">/**</em>
-<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * Using a specified Velocity Template and provided context, create the outputFilename.</em>
-<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> *</em>
-<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * @param outputFilename the file to be generated.</em>
-<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * @param template the velocity template to use.</em>
-<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * @param context the velocity context map.</em>
-<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @throws VelocityException if the template was not found or any other Velocity exception.</em>
-<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException</em>
-<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * @throws IOException</em>
-<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> */</em>
-<a name="89" href="#89">89</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> generate( String outputFilename, String template, Context context )
-<a name="90" href="#90">90</a> <strong class="jxr_keyword">throws</strong> VelocityException, MojoExecutionException, IOException
-<a name="91" href="#91">91</a> {
-<a name="92" href="#92">92</a> File f;
-<a name="93" href="#93">93</a>
-<a name="94" href="#94">94</a> <strong class="jxr_keyword">try</strong>
-<a name="95" href="#95">95</a> {
-<a name="96" href="#96">96</a> f = <strong class="jxr_keyword">new</strong> File( outputFilename );
-<a name="97" href="#97">97</a>
-<a name="98" href="#98">98</a> <strong class="jxr_keyword">if</strong> ( !f.getParentFile().exists() )
-<a name="99" href="#99">99</a> {
-<a name="100" href="#100">100</a> f.getParentFile().mkdirs();
-<a name="101" href="#101">101</a> }
-<a name="102" href="#102">102</a>
-<a name="103" href="#103">103</a> Writer writer = <strong class="jxr_keyword">new</strong> FileWriter( f );
-<a name="104" href="#104">104</a>
-<a name="105" href="#105">105</a> getVelocity().getEngine().mergeTemplate( templateDirectory + <span class="jxr_string">"/"</span> + template, context, writer );
-<a name="106" href="#106">106</a>
-<a name="107" href="#107">107</a> writer.flush();
-<a name="108" href="#108">108</a> writer.close();
-<a name="109" href="#109">109</a>
-<a name="110" href="#110">110</a> getLog().debug( <span class="jxr_string">"File "</span> + outputFilename + <span class="jxr_string">" created..."</span> );
-<a name="111" href="#111">111</a> }
-<a name="112" href="#112">112</a>
-<a name="113" href="#113">113</a> <strong class="jxr_keyword">catch</strong> ( ResourceNotFoundException e )
-<a name="114" href="#114">114</a> {
-<a name="115" href="#115">115</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ResourceNotFoundException( <span class="jxr_string">"Template not found: "</span> + templateDirectory + <span class="jxr_string">"/"</span> + template );
-<a name="116" href="#116">116</a> }
-<a name="117" href="#117">117</a> <strong class="jxr_keyword">catch</strong> ( VelocityException e )
-<a name="118" href="#118">118</a> {
-<a name="119" href="#119">119</a> <strong class="jxr_keyword">throw</strong> e; <em class="jxr_comment">// to get past generic catch for Exception.</em>
-<a name="120" href="#120">120</a> }
-<a name="121" href="#121">121</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
-<a name="122" href="#122">122</a> {
-<a name="123" href="#123">123</a> <strong class="jxr_keyword">throw</strong> e; <em class="jxr_comment">// to get past generic catch for Exception.</em>
-<a name="124" href="#124">124</a> }
-<a name="125" href="#125">125</a> <strong class="jxr_keyword">catch</strong> ( Exception e )
-<a name="126" href="#126">126</a> {
-<a name="127" href="#127">127</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( e.getMessage(), e );
-<a name="128" href="#128">128</a> }
-<a name="129" href="#129">129</a> }
-<a name="130" href="#130">130</a>
-<a name="131" href="#131">131</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setTemplateDirectory( String templateDirectory )
-<a name="132" href="#132">132</a> {
-<a name="133" href="#133">133</a> <strong class="jxr_keyword">this</strong>.templateDirectory = templateDirectory;
-<a name="134" href="#134">134</a> }
-<a name="135" href="#135">135</a>
-<a name="136" href="#136">136</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setVelocity( VelocityComponent velocity )
-<a name="137" href="#137">137</a> {
-<a name="138" href="#138">138</a> <strong class="jxr_keyword">this</strong>.velocity = velocity;
-<a name="139" href="#139">139</a> }
-<a name="140" href="#140">140</a>
-<a name="141" href="#141">141</a> <strong class="jxr_keyword">public</strong> Log getLog()
-<a name="142" href="#142">142</a> {
-<a name="143" href="#143">143</a> <strong class="jxr_keyword">if</strong> ( <strong class="jxr_keyword">this</strong>.log == <strong class="jxr_keyword">null</strong> )
-<a name="144" href="#144">144</a> {
-<a name="145" href="#145">145</a> <strong class="jxr_keyword">this</strong>.log = <strong class="jxr_keyword">new</strong> SystemStreamLog();
-<a name="146" href="#146">146</a> }
-<a name="147" href="#147">147</a> <strong class="jxr_keyword">return</strong> log;
-<a name="148" href="#148">148</a> }
-<a name="149" href="#149">149</a>
-<a name="150" href="#150">150</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLog( Log log )
-<a name="151" href="#151">151</a> {
-<a name="152" href="#152">152</a> <strong class="jxr_keyword">this</strong>.log = log;
-<a name="153" href="#153">153</a> }
-<a name="154" href="#154">154</a>
-<a name="155" href="#155">155</a> }
+<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * &#042; &#064;component</em>
+<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * &#042;/</em>
+<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * private VelocityComponent velocity;</em>
+<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * </pre></em>
+<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> *</em>
+<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:joakim@erdfelt.net" target="alexandria_uri">mailto:joakim@erdfelt.net</a>">Joakim Erdfelt</a></em>
+<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> */</em>
+<a name="54" href="#54">54</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugin/checkstyle/VelocityTemplate.html">VelocityTemplate</a>
+<a name="55" href="#55">55</a> {
+<a name="56" href="#56">56</a> <strong class="jxr_keyword">private</strong> String templateDirectory;
+<a name="57" href="#57">57</a>
+<a name="58" href="#58">58</a> <strong class="jxr_keyword">private</strong> Log log;
+<a name="59" href="#59">59</a>
+<a name="60" href="#60">60</a> <strong class="jxr_keyword">private</strong> VelocityComponent velocity;
+<a name="61" href="#61">61</a>
+<a name="62" href="#62">62</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/maven/plugin/checkstyle/VelocityTemplate.html">VelocityTemplate</a>( VelocityComponent velocityComponent, String templateBaseDirectory )
+<a name="63" href="#63">63</a> {
+<a name="64" href="#64">64</a> <strong class="jxr_keyword">this</strong>.velocity = velocityComponent;
+<a name="65" href="#65">65</a> <strong class="jxr_keyword">this</strong>.templateDirectory = templateBaseDirectory;
+<a name="66" href="#66">66</a> }
+<a name="67" href="#67">67</a>
+<a name="68" href="#68">68</a> <strong class="jxr_keyword">public</strong> String getTemplateDirectory()
+<a name="69" href="#69">69</a> {
+<a name="70" href="#70">70</a> <strong class="jxr_keyword">return</strong> templateDirectory;
+<a name="71" href="#71">71</a> }
+<a name="72" href="#72">72</a>
+<a name="73" href="#73">73</a> <strong class="jxr_keyword">public</strong> VelocityComponent getVelocity()
+<a name="74" href="#74">74</a> {
+<a name="75" href="#75">75</a> <strong class="jxr_keyword">return</strong> velocity;
+<a name="76" href="#76">76</a> }
+<a name="77" href="#77">77</a>
+<a name="78" href="#78">78</a> <em class="jxr_javadoccomment">/**</em>
+<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * Using a specified Velocity Template and provided context, create the outputFilename.</em>
+<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> *</em>
+<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * @param outputFilename the file to be generated.</em>
+<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * @param template the velocity template to use.</em>
+<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * @param context the velocity context map.</em>
+<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * @throws VelocityException if the template was not found or any other Velocity exception.</em>
+<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException</em>
+<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * @throws IOException</em>
+<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> */</em>
+<a name="88" href="#88">88</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> generate( String outputFilename, String template, Context context )
+<a name="89" href="#89">89</a> <strong class="jxr_keyword">throws</strong> VelocityException, MojoExecutionException, IOException
+<a name="90" href="#90">90</a> {
+<a name="91" href="#91">91</a> File f;
+<a name="92" href="#92">92</a>
+<a name="93" href="#93">93</a> <strong class="jxr_keyword">try</strong>
+<a name="94" href="#94">94</a> {
+<a name="95" href="#95">95</a> f = <strong class="jxr_keyword">new</strong> File( outputFilename );
+<a name="96" href="#96">96</a>
+<a name="97" href="#97">97</a> <strong class="jxr_keyword">if</strong> ( !f.getParentFile().exists() )
+<a name="98" href="#98">98</a> {
+<a name="99" href="#99">99</a> f.getParentFile().mkdirs();
+<a name="100" href="#100">100</a> }
+<a name="101" href="#101">101</a>
+<a name="102" href="#102">102</a> Writer writer = <strong class="jxr_keyword">new</strong> FileWriter( f );
+<a name="103" href="#103">103</a>
+<a name="104" href="#104">104</a> getVelocity().getEngine().mergeTemplate( templateDirectory + <span class="jxr_string">"/"</span> + template, context, writer );
+<a name="105" href="#105">105</a>
+<a name="106" href="#106">106</a> writer.flush();
+<a name="107" href="#107">107</a> writer.close();
+<a name="108" href="#108">108</a>
+<a name="109" href="#109">109</a> getLog().debug( <span class="jxr_string">"File "</span> + outputFilename + <span class="jxr_string">" created..."</span> );
+<a name="110" href="#110">110</a> }
+<a name="111" href="#111">111</a>
+<a name="112" href="#112">112</a> <strong class="jxr_keyword">catch</strong> ( ResourceNotFoundException e )
+<a name="113" href="#113">113</a> {
+<a name="114" href="#114">114</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ResourceNotFoundException( <span class="jxr_string">"Template not found: "</span> + templateDirectory + <span class="jxr_string">"/"</span> + template );
+<a name="115" href="#115">115</a> }
+<a name="116" href="#116">116</a> <strong class="jxr_keyword">catch</strong> ( VelocityException e )
+<a name="117" href="#117">117</a> {
+<a name="118" href="#118">118</a> <strong class="jxr_keyword">throw</strong> e; <em class="jxr_comment">// to get past generic catch for Exception.</em>
+<a name="119" href="#119">119</a> }
+<a name="120" href="#120">120</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
+<a name="121" href="#121">121</a> {
+<a name="122" href="#122">122</a> <strong class="jxr_keyword">throw</strong> e; <em class="jxr_comment">// to get past generic catch for Exception.</em>
+<a name="123" href="#123">123</a> }
+<a name="124" href="#124">124</a> <strong class="jxr_keyword">catch</strong> ( Exception e )
+<a name="125" href="#125">125</a> {
+<a name="126" href="#126">126</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( e.getMessage(), e );
+<a name="127" href="#127">127</a> }
+<a name="128" href="#128">128</a> }
+<a name="129" href="#129">129</a>
+<a name="130" href="#130">130</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setTemplateDirectory( String templateDirectory )
+<a name="131" href="#131">131</a> {
+<a name="132" href="#132">132</a> <strong class="jxr_keyword">this</strong>.templateDirectory = templateDirectory;
+<a name="133" href="#133">133</a> }
+<a name="134" href="#134">134</a>
+<a name="135" href="#135">135</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setVelocity( VelocityComponent velocity )
+<a name="136" href="#136">136</a> {
+<a name="137" href="#137">137</a> <strong class="jxr_keyword">this</strong>.velocity = velocity;
+<a name="138" href="#138">138</a> }
+<a name="139" href="#139">139</a>
+<a name="140" href="#140">140</a> <strong class="jxr_keyword">public</strong> Log getLog()
+<a name="141" href="#141">141</a> {
+<a name="142" href="#142">142</a> <strong class="jxr_keyword">if</strong> ( <strong class="jxr_keyword">this</strong>.log == <strong class="jxr_keyword">null</strong> )
+<a name="143" href="#143">143</a> {
+<a name="144" href="#144">144</a> <strong class="jxr_keyword">this</strong>.log = <strong class="jxr_keyword">new</strong> SystemStreamLog();
+<a name="145" href="#145">145</a> }
+<a name="146" href="#146">146</a> <strong class="jxr_keyword">return</strong> log;
+<a name="147" href="#147">147</a> }
+<a name="148" href="#148">148</a>
+<a name="149" href="#149">149</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLog( Log log )
+<a name="150" href="#150">150</a> {
+<a name="151" href="#151">151</a> <strong class="jxr_keyword">this</strong>.log = log;
+<a name="152" href="#152">152</a> }
+<a name="153" href="#153">153</a>
+<a name="154" href="#154">154</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/package-frame.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/package-frame.html (original)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/package-frame.html Tue May 8 13:52:31 2012
@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
- <title>Maven Checkstyle Plugin 2.2 Reference Package org.apache.maven.plugin.checkstyle</title>
+ <title>Maven Checkstyle Plugin 2.3 Reference Package org.apache.maven.plugin.checkstyle</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" />
</head>
<body>
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/package-summary.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/package-summary.html (original)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/org/apache/maven/plugin/checkstyle/package-summary.html Tue May 8 13:52:31 2012
@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
- <title>Maven Checkstyle Plugin 2.2 Reference Package org.apache.maven.plugin.checkstyle</title>
+ <title>Maven Checkstyle Plugin 2.3 Reference Package org.apache.maven.plugin.checkstyle</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" />
</head>
<body>
@@ -92,6 +92,6 @@
</ul>
</div>
<hr />
- Copyright © 2005-2008 The Apache Software Foundation. All Rights Reserved.
+ Copyright © 2005-2009 The Apache Software Foundation. All Rights Reserved.
</body>
</html>
\ No newline at end of file
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/overview-frame.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/overview-frame.html (original)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/overview-frame.html Tue May 8 13:52:31 2012
@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
- <title>Maven Checkstyle Plugin 2.2 Reference</title>
+ <title>Maven Checkstyle Plugin 2.3 Reference</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="style" />
</head>
<body>
Modified: websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/overview-summary.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/overview-summary.html (original)
+++ websites/production/maventest/content/plugins/maven-checkstyle-plugin-latest/xref/overview-summary.html Tue May 8 13:52:31 2012
@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
- <title>Maven Checkstyle Plugin 2.2 Reference</title>
+ <title>Maven Checkstyle Plugin 2.3 Reference</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="style" />
</head>
<body>
@@ -24,7 +24,7 @@
</ul>
</div>
- <h2>Maven Checkstyle Plugin 2.2 Reference</h2>
+ <h2>Maven Checkstyle Plugin 2.3 Reference</h2>
<table class="summary">
<thead>
@@ -59,6 +59,6 @@
</div>
<hr />
- Copyright © 2005-2008 The Apache Software Foundation. All Rights Reserved.
+ Copyright © 2005-2009 The Apache Software Foundation. All Rights Reserved.
</body>
</html>
\ No newline at end of file