Modified: websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST/xref/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST/xref/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.html (original) +++ websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST/xref/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.html Tue Jan 27 00:57:50 2015 @@ -62,148 +62,148 @@ <a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.configuration.PlexusConfiguration; <a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.FileUtils; <a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.IOUtil; -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory; -<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; -<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.pull.MXParser; -<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.pull.XmlPullParser; -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.pull.XmlPullParserException; -<a class="jxr_linenumber" name="L62" href="#L62">62</a> -<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.DefaultLogger; -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.XMLLogger; -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.api.AuditListener; -<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.api.CheckstyleException; -<a class="jxr_linenumber" name="L67" href="#L67">67</a> -<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * Performs Checkstyle analysis and outputs violations or a count of violations</em> -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * to the console, potentially failing the build.</em> -<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * It can also be configured to re-use an earlier analysis.</em> -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:joa...@erdfelt.net" target="alexandria_uri">mailto:joa...@erdfelt.net</a>">Joakim Erdfelt</a></em> -<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * @version $Id: CheckstyleViolationCheckMojo.java 1621538 2014-08-30 21:12:11Z hboutemy $</em> -<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L76" href="#L76">76</a> @Mojo( name = <span class="jxr_string">"check"</span>, defaultPhase = LifecyclePhase.VERIFY, requiresDependencyResolution = ResolutionScope.TEST, -<a class="jxr_linenumber" name="L77" href="#L77">77</a> threadSafe = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L78" href="#L78">78</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 class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">extends</strong> AbstractMojo -<a class="jxr_linenumber" name="L80" href="#L80">80</a> { -<a class="jxr_linenumber" name="L81" href="#L81">81</a> -<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String JAVA_FILES = <span class="jxr_string">"**\\/*.java"</span>; -<a class="jxr_linenumber" name="L83" href="#L83">83</a> -<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CHECKSTYLE_FILE_HEADER = <span class="jxr_string">"<?xml version=\"1.0\"?>\n"</span> -<a class="jxr_linenumber" name="L85" href="#L85">85</a> + <span class="jxr_string">"<!DOCTYPE module PUBLIC \"-//Puppy Crawl//DTD Check Configuration 1.2//EN\"\n"</span> -<a class="jxr_linenumber" name="L86" href="#L86">86</a> + <span class="jxr_string">" \"http://www.puppycrawl.com/dtds/configuration_1_2.dtd\">\n"</span>; -<a class="jxr_linenumber" name="L87" href="#L87">87</a> -<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * Specifies the path and filename to save the Checkstyle output. The format</em> -<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * of the output file is determined by the <code>outputFileFormat</code></em> -<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * parameter.</em> -<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L93" href="#L93">93</a> @Parameter( property = <span class="jxr_string">"checkstyle.output.file"</span>, defaultValue = <span class="jxr_string">"${project.build.directory}/checkstyle-result.xml"</span> ) -<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">private</strong> File outputFile; -<a class="jxr_linenumber" name="L95" href="#L95">95</a> -<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * Specifies the format of the output to be used when writing to the output</em> -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * file. Valid values are "<code>plain</code>" and "<code>xml</code>".</em> -<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L100" href="#L100">100</a> @Parameter( property = <span class="jxr_string">"checkstyle.output.format"</span>, defaultValue = <span class="jxr_string">"xml"</span> ) -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">private</strong> String outputFileFormat; -<a class="jxr_linenumber" name="L102" href="#L102">102</a> -<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * Fail the build on a violation. The goal checks for the violations</em> -<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * after logging them (if {@link #logViolationsToConsole} is 'true').</em> -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * Compare this to {@link #failsOnError} which fails the build immediately</em> -<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * before examining the output log.</em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> @Parameter( property = <span class="jxr_string">"checkstyle.failOnViolation"</span>, defaultValue = <span class="jxr_string">"true"</span> ) -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> failOnViolation; -<a class="jxr_linenumber" name="L111" href="#L111">111</a> -<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * The maximum number of allowed violations. The execution fails only if the</em> -<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * number of violations is above this limit.</em> -<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * @since 2.3</em> -<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L118" href="#L118">118</a> @Parameter( property = <span class="jxr_string">"checkstyle.maxAllowedViolations"</span>, defaultValue = <span class="jxr_string">"0"</span> ) -<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> maxAllowedViolations; -<a class="jxr_linenumber" name="L120" href="#L120">120</a> -<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * The lowest severity level that is considered a violation.</em> -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * Valid values are "<code>error</code>", "<code>warning</code>" and "<code>info</code>".</em> -<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * @since 2.2</em> -<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L127" href="#L127">127</a> @Parameter( property = <span class="jxr_string">"checkstyle.violationSeverity"</span>, defaultValue = <span class="jxr_string">"error"</span> ) -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">private</strong> String violationSeverity = <span class="jxr_string">"error"</span>; -<a class="jxr_linenumber" name="L129" href="#L129">129</a> -<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * Violations to ignore. This is a comma-separated list, each value being either</em> -<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * a rule name, a rule category or a java package name of rule class.</em> -<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * @since 2.13</em> -<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L136" href="#L136">136</a> @Parameter( property = <span class="jxr_string">"checkstyle.violation.ignore"</span> ) -<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">private</strong> String violationIgnore; -<a class="jxr_linenumber" name="L138" href="#L138">138</a> -<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * Skip entire check.</em> -<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * @since 2.2</em> -<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L144" href="#L144">144</a> @Parameter( property = <span class="jxr_string">"checkstyle.skip"</span>, defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip; -<a class="jxr_linenumber" name="L146" href="#L146">146</a> -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * Skip Checkstyle execution will only scan the outputFile.</em> -<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * @since 2.5</em> -<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L152" href="#L152">152</a> @Parameter( property = <span class="jxr_string">"checkstyle.skipExec"</span>, defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skipExec; -<a class="jxr_linenumber" name="L154" href="#L154">154</a> -<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * Output the detected violations to the console.</em> -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * @since 2.3</em> -<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L160" href="#L160">160</a> @Parameter( property = <span class="jxr_string">"checkstyle.console"</span>, defaultValue = <span class="jxr_string">"true"</span> ) -<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> logViolationsToConsole; -<a class="jxr_linenumber" name="L162" href="#L162">162</a> -<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * Specifies the location of the resources to be used for Checkstyle.</em> -<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * @since 2.11</em> -<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L168" href="#L168">168</a> @Parameter( defaultValue = <span class="jxr_string">"${project.resources}"</span>, readonly = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">protected</strong> List<Resource> resources; -<a class="jxr_linenumber" name="L170" href="#L170">170</a> -<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * Specifies the location of the XML configuration to use.</em> -<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * <p/></em> -<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * Potential values are a filesystem path, a URL, or a classpath resource.</em> -<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * This parameter expects that the contents of the location conform to the</em> -<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * xml format (Checkstyle <a</em> -<a class="jxr_linenumber" name="L180" href="#L180">180</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="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * module</a>) configuration of rulesets.</em> -<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * <p/></em> -<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> * This parameter is resolved as resource, URL, then file. If successfully</em> -<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * resolved, the contents of the configuration is copied into the</em> -<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * <code>${project.build.directory}/checkstyle-configuration.xml</code></em> -<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * file before being passed to Checkstyle as a configuration.</em> -<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * <p/></em> -<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * There are 4 predefined rulesets.</em> -<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * <p/></em> -<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * <ul></em> -<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * <li><code>config/sun_checks.xml</code>: Sun Checks.</li></em> -<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * <li><code>config/turbine_checks.xml</code>: Turbine Checks.</li></em> -<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * <li><code>config/avalon_checks.xml</code>: Avalon Checks.</li></em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.PathTool; +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory; +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.pull.MXParser; +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.pull.XmlPullParser; +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.pull.XmlPullParserException; +<a class="jxr_linenumber" name="L63" href="#L63">63</a> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.DefaultLogger; +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.XMLLogger; +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.api.AuditListener; +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.api.CheckstyleException; +<a class="jxr_linenumber" name="L68" href="#L68">68</a> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * Performs Checkstyle analysis and outputs violations or a count of violations</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * to the console, potentially failing the build.</em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * It can also be configured to re-use an earlier analysis.</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:joa...@erdfelt.net" target="alexandria_uri">mailto:joa...@erdfelt.net</a>">Joakim Erdfelt</a></em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * @version $Id: CheckstyleViolationCheckMojo.java 1652790 2015-01-18 16:41:01Z hboutemy $</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> @Mojo( name = <span class="jxr_string">"check"</span>, defaultPhase = LifecyclePhase.VERIFY, requiresDependencyResolution = ResolutionScope.TEST, +<a class="jxr_linenumber" name="L78" href="#L78">78</a> threadSafe = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L79" href="#L79">79</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 class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">extends</strong> AbstractMojo +<a class="jxr_linenumber" name="L81" href="#L81">81</a> { +<a class="jxr_linenumber" name="L82" href="#L82">82</a> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String JAVA_FILES = <span class="jxr_string">"**\\/*.java"</span>; +<a class="jxr_linenumber" name="L84" href="#L84">84</a> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CHECKSTYLE_FILE_HEADER = <span class="jxr_string">"<?xml version=\"1.0\"?>\n"</span> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> + <span class="jxr_string">"<!DOCTYPE module PUBLIC \"-//Puppy Crawl//DTD Check Configuration 1.2//EN\"\n"</span> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> + <span class="jxr_string">" \"http://www.puppycrawl.com/dtds/configuration_1_2.dtd\">\n"</span>; +<a class="jxr_linenumber" name="L88" href="#L88">88</a> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * Specifies the path and filename to save the Checkstyle output. The format</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * of the output file is determined by the <code>outputFileFormat</code></em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * parameter.</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> @Parameter( property = <span class="jxr_string">"checkstyle.output.file"</span>, defaultValue = <span class="jxr_string">"${project.build.directory}/checkstyle-result.xml"</span> ) +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">private</strong> File outputFile; +<a class="jxr_linenumber" name="L96" href="#L96">96</a> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * Specifies the format of the output to be used when writing to the output</em> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * file. Valid values are "<code>plain</code>" and "<code>xml</code>".</em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> @Parameter( property = <span class="jxr_string">"checkstyle.output.format"</span>, defaultValue = <span class="jxr_string">"xml"</span> ) +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">private</strong> String outputFileFormat; +<a class="jxr_linenumber" name="L103" href="#L103">103</a> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * Fail the build on a violation. The goal checks for the violations</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * after logging them (if {@link #logViolationsToConsole} is 'true').</em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * Compare this to {@link #failsOnError} which fails the build immediately</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * before examining the output log.</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> @Parameter( property = <span class="jxr_string">"checkstyle.failOnViolation"</span>, defaultValue = <span class="jxr_string">"true"</span> ) +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> failOnViolation; +<a class="jxr_linenumber" name="L112" href="#L112">112</a> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * The maximum number of allowed violations. The execution fails only if the</em> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * number of violations is above this limit.</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * @since 2.3</em> +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> @Parameter( property = <span class="jxr_string">"checkstyle.maxAllowedViolations"</span>, defaultValue = <span class="jxr_string">"0"</span> ) +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> maxAllowedViolations; +<a class="jxr_linenumber" name="L121" href="#L121">121</a> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * The lowest severity level that is considered a violation.</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * Valid values are "<code>error</code>", "<code>warning</code>" and "<code>info</code>".</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @since 2.2</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> @Parameter( property = <span class="jxr_string">"checkstyle.violationSeverity"</span>, defaultValue = <span class="jxr_string">"error"</span> ) +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">private</strong> String violationSeverity = <span class="jxr_string">"error"</span>; +<a class="jxr_linenumber" name="L130" href="#L130">130</a> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * Violations to ignore. This is a comma-separated list, each value being either</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * a rule name, a rule category or a java package name of rule class.</em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * @since 2.13</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> @Parameter( property = <span class="jxr_string">"checkstyle.violation.ignore"</span> ) +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">private</strong> String violationIgnore; +<a class="jxr_linenumber" name="L139" href="#L139">139</a> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * Skip entire check.</em> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * @since 2.2</em> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> @Parameter( property = <span class="jxr_string">"checkstyle.skip"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip; +<a class="jxr_linenumber" name="L147" href="#L147">147</a> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * Skip Checkstyle execution will only scan the outputFile.</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * @since 2.5</em> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> @Parameter( property = <span class="jxr_string">"checkstyle.skipExec"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skipExec; +<a class="jxr_linenumber" name="L155" href="#L155">155</a> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * Output the detected violations to the console.</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * @since 2.3</em> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> @Parameter( property = <span class="jxr_string">"checkstyle.console"</span>, defaultValue = <span class="jxr_string">"true"</span> ) +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> logViolationsToConsole; +<a class="jxr_linenumber" name="L163" href="#L163">163</a> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * Specifies the location of the resources to be used for Checkstyle.</em> +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * @since 2.11</em> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> @Parameter( defaultValue = <span class="jxr_string">"${project.resources}"</span>, readonly = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">protected</strong> List<Resource> resources; +<a class="jxr_linenumber" name="L171" href="#L171">171</a> +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * Specifies the location of the XML configuration to use.</em> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * <p/></em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * Potential values are a filesystem path, a URL, or a classpath resource.</em> +<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * This parameter expects that the contents of the location conform to the</em> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * xml format (Checkstyle <a</em> +<a class="jxr_linenumber" name="L181" href="#L181">181</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="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * module</a>) configuration of rulesets.</em> +<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * <p/></em> +<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * This parameter is resolved as resource, URL, then file. If successfully</em> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * resolved, the contents of the configuration is copied into the</em> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * <code>${project.build.directory}/checkstyle-configuration.xml</code></em> +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * file before being passed to Checkstyle as a configuration.</em> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * <p/></em> +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * There are 3 predefined rulesets.</em> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * <p/></em> +<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * <li><code>config/sun_checks.xml</code>: Sun Checks.</li></em> +<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * <li><code>config/turbine_checks.xml</code>: Turbine Checks.</li></em> <a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * <li><code>config/maven_checks.xml</code>: Maven Source Checks.</li></em> <a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * </ul></em> <a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> *</em> @@ -528,7 +528,7 @@ <a class="jxr_linenumber" name="L520" href="#L520">520</a> .setIncludeResources( includeResources ) <a class="jxr_linenumber" name="L521" href="#L521">521</a> .setIncludeTestResources( includeTestResources ) <a class="jxr_linenumber" name="L522" href="#L522">522</a> .setIncludeTestSourceDirectory( includeTestSourceDirectory ).setListener( getListener() ) -<a class="jxr_linenumber" name="L523" href="#L523">523</a> .setLog( getLog() ).setProject( project ).setSourceDirectories( getSourceDirectories() ) +<a class="jxr_linenumber" name="L523" href="#L523">523</a> .setProject( project ).setSourceDirectories( getSourceDirectories() ) <a class="jxr_linenumber" name="L524" href="#L524">524</a> .setResources( resources ) <a class="jxr_linenumber" name="L525" href="#L525">525</a> .setStringOutputStream( stringOutputStream ).setSuppressionsLocation( suppressionsLocation ) <a class="jxr_linenumber" name="L526" href="#L526">526</a> .setTestSourceDirectories( getTestSourceDirectories() ).setConfigLocation( configLocation ) @@ -613,259 +613,279 @@ <a class="jxr_linenumber" name="L605" href="#L605">605</a> <strong class="jxr_keyword">throws</strong> XmlPullParserException, IOException <a class="jxr_linenumber" name="L606" href="#L606">606</a> { <a class="jxr_linenumber" name="L607" href="#L607">607</a> <strong class="jxr_keyword">int</strong> count = 0; -<a class="jxr_linenumber" name="L608" href="#L608">608</a> RuleUtil.Matcher[] ignores = -<a class="jxr_linenumber" name="L609" href="#L609">609</a> ( violationIgnore == <strong class="jxr_keyword">null</strong> ) ? <strong class="jxr_keyword">null</strong> : RuleUtil.parseMatchers( violationIgnore.split( <span class="jxr_string">","</span> ) ); -<a class="jxr_linenumber" name="L610" href="#L610">610</a> -<a class="jxr_linenumber" name="L611" href="#L611">611</a> <strong class="jxr_keyword">int</strong> eventType = xpp.getEventType(); -<a class="jxr_linenumber" name="L612" href="#L612">612</a> String file = <span class="jxr_string">""</span>; -<a class="jxr_linenumber" name="L613" href="#L613">613</a> <strong class="jxr_keyword">while</strong> ( eventType != XmlPullParser.END_DOCUMENT ) -<a class="jxr_linenumber" name="L614" href="#L614">614</a> { -<a class="jxr_linenumber" name="L615" href="#L615">615</a> <strong class="jxr_keyword">if</strong> ( eventType == XmlPullParser.START_TAG ) -<a class="jxr_linenumber" name="L616" href="#L616">616</a> { -<a class="jxr_linenumber" name="L617" href="#L617">617</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"file"</span>.equals( xpp.getName() ) ) -<a class="jxr_linenumber" name="L618" href="#L618">618</a> { -<a class="jxr_linenumber" name="L619" href="#L619">619</a> file = xpp.getAttributeValue( <span class="jxr_string">""</span>, <span class="jxr_string">"name"</span> ); -<a class="jxr_linenumber" name="L620" href="#L620">620</a> file = file.substring( file.lastIndexOf( File.separatorChar ) + 1 ); -<a class="jxr_linenumber" name="L621" href="#L621">621</a> } -<a class="jxr_linenumber" name="L622" href="#L622">622</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"error"</span>.equals( xpp.getName() ) ) -<a class="jxr_linenumber" name="L623" href="#L623">623</a> { -<a class="jxr_linenumber" name="L624" href="#L624">624</a> String severity = xpp.getAttributeValue( <span class="jxr_string">""</span>, <span class="jxr_string">"severity"</span> ); -<a class="jxr_linenumber" name="L625" href="#L625">625</a> String source = xpp.getAttributeValue( <span class="jxr_string">""</span>, <span class="jxr_string">"source"</span> ); -<a class="jxr_linenumber" name="L626" href="#L626">626</a> -<a class="jxr_linenumber" name="L627" href="#L627">627</a> <strong class="jxr_keyword">if</strong> ( isViolation( severity ) && !ignore( ignores, source ) ) -<a class="jxr_linenumber" name="L628" href="#L628">628</a> { -<a class="jxr_linenumber" name="L629" href="#L629">629</a> count++; -<a class="jxr_linenumber" name="L630" href="#L630">630</a> -<a class="jxr_linenumber" name="L631" href="#L631">631</a> <strong class="jxr_keyword">if</strong> ( logViolationsToConsole ) -<a class="jxr_linenumber" name="L632" href="#L632">632</a> { -<a class="jxr_linenumber" name="L633" href="#L633">633</a> String line = xpp.getAttributeValue( <span class="jxr_string">""</span>, <span class="jxr_string">"line"</span> ); -<a class="jxr_linenumber" name="L634" href="#L634">634</a> String column = xpp.getAttributeValue( <span class="jxr_string">""</span>, <span class="jxr_string">"column"</span> ); -<a class="jxr_linenumber" name="L635" href="#L635">635</a> String message = xpp.getAttributeValue( <span class="jxr_string">""</span>, <span class="jxr_string">"message"</span> ); -<a class="jxr_linenumber" name="L636" href="#L636">636</a> String rule = RuleUtil.getName( source ); -<a class="jxr_linenumber" name="L637" href="#L637">637</a> String category = RuleUtil.getCategory( source ); -<a class="jxr_linenumber" name="L638" href="#L638">638</a> -<a class="jxr_linenumber" name="L639" href="#L639">639</a> String logMessage = -<a class="jxr_linenumber" name="L640" href="#L640">640</a> file + '[' + line + ( ( column == <strong class="jxr_keyword">null</strong> ) ? <span class="jxr_string">""</span> : ( ':' + column ) ) + <span class="jxr_string">"] ("</span> + category -<a class="jxr_linenumber" name="L641" href="#L641">641</a> + <span class="jxr_string">") "</span> + rule + <span class="jxr_string">": "</span> + message; -<a class="jxr_linenumber" name="L642" href="#L642">642</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"info"</span>.equals( severity ) ) -<a class="jxr_linenumber" name="L643" href="#L643">643</a> { -<a class="jxr_linenumber" name="L644" href="#L644">644</a> getLog().info( logMessage ); -<a class="jxr_linenumber" name="L645" href="#L645">645</a> } -<a class="jxr_linenumber" name="L646" href="#L646">646</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"warning"</span>.equals( severity ) ) -<a class="jxr_linenumber" name="L647" href="#L647">647</a> { -<a class="jxr_linenumber" name="L648" href="#L648">648</a> getLog().warn( logMessage ); -<a class="jxr_linenumber" name="L649" href="#L649">649</a> } -<a class="jxr_linenumber" name="L650" href="#L650">650</a> <strong class="jxr_keyword">else</strong> -<a class="jxr_linenumber" name="L651" href="#L651">651</a> { -<a class="jxr_linenumber" name="L652" href="#L652">652</a> getLog().error( logMessage ); -<a class="jxr_linenumber" name="L653" href="#L653">653</a> } -<a class="jxr_linenumber" name="L654" href="#L654">654</a> } -<a class="jxr_linenumber" name="L655" href="#L655">655</a> } -<a class="jxr_linenumber" name="L656" href="#L656">656</a> } -<a class="jxr_linenumber" name="L657" href="#L657">657</a> } -<a class="jxr_linenumber" name="L658" href="#L658">658</a> eventType = xpp.next(); -<a class="jxr_linenumber" name="L659" href="#L659">659</a> } -<a class="jxr_linenumber" name="L660" href="#L660">660</a> -<a class="jxr_linenumber" name="L661" href="#L661">661</a> <strong class="jxr_keyword">return</strong> count; -<a class="jxr_linenumber" name="L662" href="#L662">662</a> } -<a class="jxr_linenumber" name="L663" href="#L663">663</a> -<a class="jxr_linenumber" name="L664" href="#L664">664</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L665" href="#L665">665</a> <em class="jxr_javadoccomment"> * Checks if the given severity is considered a violation.</em> -<a class="jxr_linenumber" name="L666" href="#L666">666</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L667" href="#L667">667</a> <em class="jxr_javadoccomment"> * @param severity The severity to check</em> -<a class="jxr_linenumber" name="L668" href="#L668">668</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the given severity is a violation, otherwise <code>false</code></em> -<a class="jxr_linenumber" name="L669" href="#L669">669</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L670" href="#L670">670</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isViolation( String severity ) -<a class="jxr_linenumber" name="L671" href="#L671">671</a> { -<a class="jxr_linenumber" name="L672" href="#L672">672</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"error"</span>.equals( severity ) ) -<a class="jxr_linenumber" name="L673" href="#L673">673</a> { -<a class="jxr_linenumber" name="L674" href="#L674">674</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"error"</span>.equals( violationSeverity ) || <span class="jxr_string">"warning"</span>.equals( violationSeverity ) -<a class="jxr_linenumber" name="L675" href="#L675">675</a> || <span class="jxr_string">"info"</span>.equals( violationSeverity ); -<a class="jxr_linenumber" name="L676" href="#L676">676</a> } -<a class="jxr_linenumber" name="L677" href="#L677">677</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"warning"</span>.equals( severity ) ) -<a class="jxr_linenumber" name="L678" href="#L678">678</a> { -<a class="jxr_linenumber" name="L679" href="#L679">679</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"warning"</span>.equals( violationSeverity ) || <span class="jxr_string">"info"</span>.equals( violationSeverity ); -<a class="jxr_linenumber" name="L680" href="#L680">680</a> } -<a class="jxr_linenumber" name="L681" href="#L681">681</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"info"</span>.equals( severity ) ) -<a class="jxr_linenumber" name="L682" href="#L682">682</a> { -<a class="jxr_linenumber" name="L683" href="#L683">683</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"info"</span>.equals( violationSeverity ); -<a class="jxr_linenumber" name="L684" href="#L684">684</a> } -<a class="jxr_linenumber" name="L685" href="#L685">685</a> <strong class="jxr_keyword">else</strong> -<a class="jxr_linenumber" name="L686" href="#L686">686</a> { -<a class="jxr_linenumber" name="L687" href="#L687">687</a> <strong class="jxr_keyword">return</strong> false; -<a class="jxr_linenumber" name="L688" href="#L688">688</a> } -<a class="jxr_linenumber" name="L689" href="#L689">689</a> } -<a class="jxr_linenumber" name="L690" href="#L690">690</a> -<a class="jxr_linenumber" name="L691" href="#L691">691</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> ignore( RuleUtil.Matcher[] ignores, String source ) -<a class="jxr_linenumber" name="L692" href="#L692">692</a> { -<a class="jxr_linenumber" name="L693" href="#L693">693</a> <strong class="jxr_keyword">if</strong> ( ignores != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L694" href="#L694">694</a> { -<a class="jxr_linenumber" name="L695" href="#L695">695</a> <strong class="jxr_keyword">for</strong> ( RuleUtil.Matcher ignore : ignores ) -<a class="jxr_linenumber" name="L696" href="#L696">696</a> { -<a class="jxr_linenumber" name="L697" href="#L697">697</a> <strong class="jxr_keyword">if</strong> ( ignore.match( source ) ) -<a class="jxr_linenumber" name="L698" href="#L698">698</a> { -<a class="jxr_linenumber" name="L699" href="#L699">699</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; -<a class="jxr_linenumber" name="L700" href="#L700">700</a> } -<a class="jxr_linenumber" name="L701" href="#L701">701</a> } -<a class="jxr_linenumber" name="L702" href="#L702">702</a> } -<a class="jxr_linenumber" name="L703" href="#L703">703</a> -<a class="jxr_linenumber" name="L704" href="#L704">704</a> <strong class="jxr_keyword">return</strong> false; -<a class="jxr_linenumber" name="L705" href="#L705">705</a> } -<a class="jxr_linenumber" name="L706" href="#L706">706</a> -<a class="jxr_linenumber" name="L707" href="#L707">707</a> <strong class="jxr_keyword">private</strong> DefaultLogger getConsoleListener() -<a class="jxr_linenumber" name="L708" href="#L708">708</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException -<a class="jxr_linenumber" name="L709" href="#L709">709</a> { -<a class="jxr_linenumber" name="L710" href="#L710">710</a> DefaultLogger consoleListener; -<a class="jxr_linenumber" name="L711" href="#L711">711</a> -<a class="jxr_linenumber" name="L712" href="#L712">712</a> <strong class="jxr_keyword">if</strong> ( useFile == <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L713" href="#L713">713</a> { -<a class="jxr_linenumber" name="L714" href="#L714">714</a> stringOutputStream = <strong class="jxr_keyword">new</strong> ByteArrayOutputStream(); -<a class="jxr_linenumber" name="L715" href="#L715">715</a> consoleListener = <strong class="jxr_keyword">new</strong> DefaultLogger( stringOutputStream, false ); -<a class="jxr_linenumber" name="L716" href="#L716">716</a> } -<a class="jxr_linenumber" name="L717" href="#L717">717</a> <strong class="jxr_keyword">else</strong> -<a class="jxr_linenumber" name="L718" href="#L718">718</a> { -<a class="jxr_linenumber" name="L719" href="#L719">719</a> OutputStream out = getOutputStream( useFile ); -<a class="jxr_linenumber" name="L720" href="#L720">720</a> -<a class="jxr_linenumber" name="L721" href="#L721">721</a> consoleListener = <strong class="jxr_keyword">new</strong> DefaultLogger( out, <strong class="jxr_keyword">true</strong> ); +<a class="jxr_linenumber" name="L608" href="#L608">608</a> <strong class="jxr_keyword">int</strong> ignoreCount = 0; +<a class="jxr_linenumber" name="L609" href="#L609">609</a> RuleUtil.Matcher[] ignores = +<a class="jxr_linenumber" name="L610" href="#L610">610</a> ( violationIgnore == <strong class="jxr_keyword">null</strong> ) ? <strong class="jxr_keyword">null</strong> : RuleUtil.parseMatchers( violationIgnore.split( <span class="jxr_string">","</span> ) ); +<a class="jxr_linenumber" name="L611" href="#L611">611</a> +<a class="jxr_linenumber" name="L612" href="#L612">612</a> String basedir = project.getBasedir().getAbsolutePath(); +<a class="jxr_linenumber" name="L613" href="#L613">613</a> String file = <span class="jxr_string">""</span>; +<a class="jxr_linenumber" name="L614" href="#L614">614</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> eventType = xpp.getEventType(); eventType != XmlPullParser.END_DOCUMENT; eventType = xpp.next() ) +<a class="jxr_linenumber" name="L615" href="#L615">615</a> { +<a class="jxr_linenumber" name="L616" href="#L616">616</a> <strong class="jxr_keyword">if</strong> ( eventType != XmlPullParser.START_TAG ) +<a class="jxr_linenumber" name="L617" href="#L617">617</a> { +<a class="jxr_linenumber" name="L618" href="#L618">618</a> <strong class="jxr_keyword">continue</strong>; +<a class="jxr_linenumber" name="L619" href="#L619">619</a> } +<a class="jxr_linenumber" name="L620" href="#L620">620</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"file"</span>.equals( xpp.getName() ) ) +<a class="jxr_linenumber" name="L621" href="#L621">621</a> { +<a class="jxr_linenumber" name="L622" href="#L622">622</a> file = PathTool.getRelativeFilePath( basedir, xpp.getAttributeValue( <span class="jxr_string">""</span>, <span class="jxr_string">"name"</span> ) ); +<a class="jxr_linenumber" name="L623" href="#L623">623</a> <em class="jxr_comment">//file = file.substring( file.lastIndexOf( File.separatorChar ) + 1 );</em> +<a class="jxr_linenumber" name="L624" href="#L624">624</a> } +<a class="jxr_linenumber" name="L625" href="#L625">625</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"error"</span>.equals( xpp.getName() ) ) +<a class="jxr_linenumber" name="L626" href="#L626">626</a> { +<a class="jxr_linenumber" name="L627" href="#L627">627</a> String severity = xpp.getAttributeValue( <span class="jxr_string">""</span>, <span class="jxr_string">"severity"</span> ); +<a class="jxr_linenumber" name="L628" href="#L628">628</a> +<a class="jxr_linenumber" name="L629" href="#L629">629</a> <strong class="jxr_keyword">if</strong> ( !isViolation( severity ) ) +<a class="jxr_linenumber" name="L630" href="#L630">630</a> { +<a class="jxr_linenumber" name="L631" href="#L631">631</a> <strong class="jxr_keyword">continue</strong>; +<a class="jxr_linenumber" name="L632" href="#L632">632</a> } +<a class="jxr_linenumber" name="L633" href="#L633">633</a> +<a class="jxr_linenumber" name="L634" href="#L634">634</a> String source = xpp.getAttributeValue( <span class="jxr_string">""</span>, <span class="jxr_string">"source"</span> ); +<a class="jxr_linenumber" name="L635" href="#L635">635</a> +<a class="jxr_linenumber" name="L636" href="#L636">636</a> <strong class="jxr_keyword">if</strong> ( ignore( ignores, source ) ) +<a class="jxr_linenumber" name="L637" href="#L637">637</a> { +<a class="jxr_linenumber" name="L638" href="#L638">638</a> ignoreCount++; +<a class="jxr_linenumber" name="L639" href="#L639">639</a> } +<a class="jxr_linenumber" name="L640" href="#L640">640</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="L641" href="#L641">641</a> { +<a class="jxr_linenumber" name="L642" href="#L642">642</a> count++; +<a class="jxr_linenumber" name="L643" href="#L643">643</a> +<a class="jxr_linenumber" name="L644" href="#L644">644</a> <strong class="jxr_keyword">if</strong> ( logViolationsToConsole ) +<a class="jxr_linenumber" name="L645" href="#L645">645</a> { +<a class="jxr_linenumber" name="L646" href="#L646">646</a> String line = xpp.getAttributeValue( <span class="jxr_string">""</span>, <span class="jxr_string">"line"</span> ); +<a class="jxr_linenumber" name="L647" href="#L647">647</a> String column = xpp.getAttributeValue( <span class="jxr_string">""</span>, <span class="jxr_string">"column"</span> ); +<a class="jxr_linenumber" name="L648" href="#L648">648</a> String message = xpp.getAttributeValue( <span class="jxr_string">""</span>, <span class="jxr_string">"message"</span> ); +<a class="jxr_linenumber" name="L649" href="#L649">649</a> String rule = RuleUtil.getName( source ); +<a class="jxr_linenumber" name="L650" href="#L650">650</a> String category = RuleUtil.getCategory( source ); +<a class="jxr_linenumber" name="L651" href="#L651">651</a> +<a class="jxr_linenumber" name="L652" href="#L652">652</a> log( severity, file + '[' + line + ( ( column == <strong class="jxr_keyword">null</strong> ) ? <span class="jxr_string">""</span> : ( ':' + column ) ) + <span class="jxr_string">"] ("</span> +<a class="jxr_linenumber" name="L653" href="#L653">653</a> + category + <span class="jxr_string">") "</span> + rule + <span class="jxr_string">": "</span> + message ); +<a class="jxr_linenumber" name="L654" href="#L654">654</a> } +<a class="jxr_linenumber" name="L655" href="#L655">655</a> } +<a class="jxr_linenumber" name="L656" href="#L656">656</a> } +<a class="jxr_linenumber" name="L657" href="#L657">657</a> } +<a class="jxr_linenumber" name="L658" href="#L658">658</a> +<a class="jxr_linenumber" name="L659" href="#L659">659</a> <strong class="jxr_keyword">if</strong> ( ignoreCount > 0 ) +<a class="jxr_linenumber" name="L660" href="#L660">660</a> { +<a class="jxr_linenumber" name="L661" href="#L661">661</a> getLog().info( <span class="jxr_string">"Ignored "</span> + ignoreCount + <span class="jxr_string">" error"</span> + ( ( ignoreCount > 1 ) ? <span class="jxr_string">"s"</span> : <span class="jxr_string">""</span> ) + <span class="jxr_string">", "</span> + count +<a class="jxr_linenumber" name="L662" href="#L662">662</a> + <span class="jxr_string">" violation"</span> + ( ( count > 1 ) ? <span class="jxr_string">"s"</span> : <span class="jxr_string">""</span> ) + <span class="jxr_string">" remaining."</span> ); +<a class="jxr_linenumber" name="L663" href="#L663">663</a> } +<a class="jxr_linenumber" name="L664" href="#L664">664</a> +<a class="jxr_linenumber" name="L665" href="#L665">665</a> <strong class="jxr_keyword">return</strong> count; +<a class="jxr_linenumber" name="L666" href="#L666">666</a> } +<a class="jxr_linenumber" name="L667" href="#L667">667</a> +<a class="jxr_linenumber" name="L668" href="#L668">668</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> log( String severity, String message ) +<a class="jxr_linenumber" name="L669" href="#L669">669</a> { +<a class="jxr_linenumber" name="L670" href="#L670">670</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"info"</span>.equals( severity ) ) +<a class="jxr_linenumber" name="L671" href="#L671">671</a> { +<a class="jxr_linenumber" name="L672" href="#L672">672</a> getLog().info( message ); +<a class="jxr_linenumber" name="L673" href="#L673">673</a> } +<a class="jxr_linenumber" name="L674" href="#L674">674</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"warning"</span>.equals( severity ) ) +<a class="jxr_linenumber" name="L675" href="#L675">675</a> { +<a class="jxr_linenumber" name="L676" href="#L676">676</a> getLog().warn( message ); +<a class="jxr_linenumber" name="L677" href="#L677">677</a> } +<a class="jxr_linenumber" name="L678" href="#L678">678</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="L679" href="#L679">679</a> { +<a class="jxr_linenumber" name="L680" href="#L680">680</a> getLog().error( message ); +<a class="jxr_linenumber" name="L681" href="#L681">681</a> } +<a class="jxr_linenumber" name="L682" href="#L682">682</a> } +<a class="jxr_linenumber" name="L683" href="#L683">683</a> +<a class="jxr_linenumber" name="L684" href="#L684">684</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L685" href="#L685">685</a> <em class="jxr_javadoccomment"> * Checks if the given severity is considered a violation.</em> +<a class="jxr_linenumber" name="L686" href="#L686">686</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L687" href="#L687">687</a> <em class="jxr_javadoccomment"> * @param severity The severity to check</em> +<a class="jxr_linenumber" name="L688" href="#L688">688</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the given severity is a violation, otherwise <code>false</code></em> +<a class="jxr_linenumber" name="L689" href="#L689">689</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L690" href="#L690">690</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isViolation( String severity ) +<a class="jxr_linenumber" name="L691" href="#L691">691</a> { +<a class="jxr_linenumber" name="L692" href="#L692">692</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"error"</span>.equals( severity ) ) +<a class="jxr_linenumber" name="L693" href="#L693">693</a> { +<a class="jxr_linenumber" name="L694" href="#L694">694</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"error"</span>.equals( violationSeverity ) || <span class="jxr_string">"warning"</span>.equals( violationSeverity ) +<a class="jxr_linenumber" name="L695" href="#L695">695</a> || <span class="jxr_string">"info"</span>.equals( violationSeverity ); +<a class="jxr_linenumber" name="L696" href="#L696">696</a> } +<a class="jxr_linenumber" name="L697" href="#L697">697</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"warning"</span>.equals( severity ) ) +<a class="jxr_linenumber" name="L698" href="#L698">698</a> { +<a class="jxr_linenumber" name="L699" href="#L699">699</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"warning"</span>.equals( violationSeverity ) || <span class="jxr_string">"info"</span>.equals( violationSeverity ); +<a class="jxr_linenumber" name="L700" href="#L700">700</a> } +<a class="jxr_linenumber" name="L701" href="#L701">701</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"info"</span>.equals( severity ) ) +<a class="jxr_linenumber" name="L702" href="#L702">702</a> { +<a class="jxr_linenumber" name="L703" href="#L703">703</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"info"</span>.equals( violationSeverity ); +<a class="jxr_linenumber" name="L704" href="#L704">704</a> } +<a class="jxr_linenumber" name="L705" href="#L705">705</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="L706" href="#L706">706</a> { +<a class="jxr_linenumber" name="L707" href="#L707">707</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L708" href="#L708">708</a> } +<a class="jxr_linenumber" name="L709" href="#L709">709</a> } +<a class="jxr_linenumber" name="L710" href="#L710">710</a> +<a class="jxr_linenumber" name="L711" href="#L711">711</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> ignore( RuleUtil.Matcher[] ignores, String source ) +<a class="jxr_linenumber" name="L712" href="#L712">712</a> { +<a class="jxr_linenumber" name="L713" href="#L713">713</a> <strong class="jxr_keyword">if</strong> ( ignores != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L714" href="#L714">714</a> { +<a class="jxr_linenumber" name="L715" href="#L715">715</a> <strong class="jxr_keyword">for</strong> ( RuleUtil.Matcher ignore : ignores ) +<a class="jxr_linenumber" name="L716" href="#L716">716</a> { +<a class="jxr_linenumber" name="L717" href="#L717">717</a> <strong class="jxr_keyword">if</strong> ( ignore.match( source ) ) +<a class="jxr_linenumber" name="L718" href="#L718">718</a> { +<a class="jxr_linenumber" name="L719" href="#L719">719</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L720" href="#L720">720</a> } +<a class="jxr_linenumber" name="L721" href="#L721">721</a> } <a class="jxr_linenumber" name="L722" href="#L722">722</a> } <a class="jxr_linenumber" name="L723" href="#L723">723</a> -<a class="jxr_linenumber" name="L724" href="#L724">724</a> <strong class="jxr_keyword">return</strong> consoleListener; +<a class="jxr_linenumber" name="L724" href="#L724">724</a> <strong class="jxr_keyword">return</strong> false; <a class="jxr_linenumber" name="L725" href="#L725">725</a> } <a class="jxr_linenumber" name="L726" href="#L726">726</a> -<a class="jxr_linenumber" name="L727" href="#L727">727</a> <strong class="jxr_keyword">private</strong> OutputStream getOutputStream( File file ) +<a class="jxr_linenumber" name="L727" href="#L727">727</a> <strong class="jxr_keyword">private</strong> DefaultLogger getConsoleListener() <a class="jxr_linenumber" name="L728" href="#L728">728</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException <a class="jxr_linenumber" name="L729" href="#L729">729</a> { -<a class="jxr_linenumber" name="L730" href="#L730">730</a> File parentFile = file.getAbsoluteFile().getParentFile(); +<a class="jxr_linenumber" name="L730" href="#L730">730</a> DefaultLogger consoleListener; <a class="jxr_linenumber" name="L731" href="#L731">731</a> -<a class="jxr_linenumber" name="L732" href="#L732">732</a> <strong class="jxr_keyword">if</strong> ( !parentFile.exists() ) +<a class="jxr_linenumber" name="L732" href="#L732">732</a> <strong class="jxr_keyword">if</strong> ( useFile == <strong class="jxr_keyword">null</strong> ) <a class="jxr_linenumber" name="L733" href="#L733">733</a> { -<a class="jxr_linenumber" name="L734" href="#L734">734</a> parentFile.mkdirs(); -<a class="jxr_linenumber" name="L735" href="#L735">735</a> } -<a class="jxr_linenumber" name="L736" href="#L736">736</a> -<a class="jxr_linenumber" name="L737" href="#L737">737</a> FileOutputStream fileOutputStream; -<a class="jxr_linenumber" name="L738" href="#L738">738</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L739" href="#L739">739</a> { -<a class="jxr_linenumber" name="L740" href="#L740">740</a> fileOutputStream = <strong class="jxr_keyword">new</strong> FileOutputStream( file ); -<a class="jxr_linenumber" name="L741" href="#L741">741</a> } -<a class="jxr_linenumber" name="L742" href="#L742">742</a> <strong class="jxr_keyword">catch</strong> ( FileNotFoundException e ) -<a class="jxr_linenumber" name="L743" href="#L743">743</a> { -<a class="jxr_linenumber" name="L744" href="#L744">744</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Unable to create output stream: "</span> + file, e ); -<a class="jxr_linenumber" name="L745" href="#L745">745</a> } -<a class="jxr_linenumber" name="L746" href="#L746">746</a> <strong class="jxr_keyword">return</strong> fileOutputStream; -<a class="jxr_linenumber" name="L747" href="#L747">747</a> } -<a class="jxr_linenumber" name="L748" href="#L748">748</a> -<a class="jxr_linenumber" name="L749" href="#L749">749</a> <strong class="jxr_keyword">private</strong> AuditListener getListener() -<a class="jxr_linenumber" name="L750" href="#L750">750</a> <strong class="jxr_keyword">throws</strong> MojoFailureException, MojoExecutionException -<a class="jxr_linenumber" name="L751" href="#L751">751</a> { -<a class="jxr_linenumber" name="L752" href="#L752">752</a> AuditListener listener = <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L753" href="#L753">753</a> -<a class="jxr_linenumber" name="L754" href="#L754">754</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isNotEmpty( outputFileFormat ) ) -<a class="jxr_linenumber" name="L755" href="#L755">755</a> { -<a class="jxr_linenumber" name="L756" href="#L756">756</a> File resultFile = outputFile; -<a class="jxr_linenumber" name="L757" href="#L757">757</a> -<a class="jxr_linenumber" name="L758" href="#L758">758</a> OutputStream out = getOutputStream( resultFile ); -<a class="jxr_linenumber" name="L759" href="#L759">759</a> -<a class="jxr_linenumber" name="L760" href="#L760">760</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"xml"</span>.equals( outputFileFormat ) ) -<a class="jxr_linenumber" name="L761" href="#L761">761</a> { -<a class="jxr_linenumber" name="L762" href="#L762">762</a> listener = <strong class="jxr_keyword">new</strong> XMLLogger( out, <strong class="jxr_keyword">true</strong> ); -<a class="jxr_linenumber" name="L763" href="#L763">763</a> } -<a class="jxr_linenumber" name="L764" href="#L764">764</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"plain"</span>.equals( outputFileFormat ) ) -<a class="jxr_linenumber" name="L765" href="#L765">765</a> { -<a class="jxr_linenumber" name="L766" href="#L766">766</a> listener = <strong class="jxr_keyword">new</strong> DefaultLogger( out, <strong class="jxr_keyword">true</strong> ); -<a class="jxr_linenumber" name="L767" href="#L767">767</a> } -<a class="jxr_linenumber" name="L768" href="#L768">768</a> <strong class="jxr_keyword">else</strong> -<a class="jxr_linenumber" name="L769" href="#L769">769</a> { -<a class="jxr_linenumber" name="L770" href="#L770">770</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException( <span class="jxr_string">"Invalid output file format: ("</span> + outputFileFormat -<a class="jxr_linenumber" name="L771" href="#L771">771</a> + <span class="jxr_string">"). Must be 'plain' or 'xml'."</span> ); -<a class="jxr_linenumber" name="L772" href="#L772">772</a> } -<a class="jxr_linenumber" name="L773" href="#L773">773</a> } -<a class="jxr_linenumber" name="L774" href="#L774">774</a> -<a class="jxr_linenumber" name="L775" href="#L775">775</a> <strong class="jxr_keyword">return</strong> listener; -<a class="jxr_linenumber" name="L776" href="#L776">776</a> } -<a class="jxr_linenumber" name="L777" href="#L777">777</a> -<a class="jxr_linenumber" name="L778" href="#L778">778</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> ) -<a class="jxr_linenumber" name="L779" href="#L779">779</a> <strong class="jxr_keyword">private</strong> List<Artifact> collectArtifacts( String hint ) -<a class="jxr_linenumber" name="L780" href="#L780">780</a> { -<a class="jxr_linenumber" name="L781" href="#L781">781</a> <strong class="jxr_keyword">if</strong> ( plugin == <strong class="jxr_keyword">null</strong> || plugin.getGroupId() == <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L782" href="#L782">782</a> { -<a class="jxr_linenumber" name="L783" href="#L783">783</a> <em class="jxr_comment">// Maven 2.x workaround</em> -<a class="jxr_linenumber" name="L784" href="#L784">784</a> plugin = mojoExecution.getMojoDescriptor().getPluginDescriptor(); -<a class="jxr_linenumber" name="L785" href="#L785">785</a> } -<a class="jxr_linenumber" name="L786" href="#L786">786</a> -<a class="jxr_linenumber" name="L787" href="#L787">787</a> List<Artifact> artifacts = <strong class="jxr_keyword">new</strong> ArrayList<Artifact>(); -<a class="jxr_linenumber" name="L788" href="#L788">788</a> -<a class="jxr_linenumber" name="L789" href="#L789">789</a> PluginManagement pluginManagement = project.getBuild().getPluginManagement(); -<a class="jxr_linenumber" name="L790" href="#L790">790</a> <strong class="jxr_keyword">if</strong> ( pluginManagement != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L791" href="#L791">791</a> { -<a class="jxr_linenumber" name="L792" href="#L792">792</a> artifacts.addAll( getCheckstylePluginDependenciesAsArtifacts( pluginManagement.getPluginsAsMap(), hint ) ); +<a class="jxr_linenumber" name="L734" href="#L734">734</a> stringOutputStream = <strong class="jxr_keyword">new</strong> ByteArrayOutputStream(); +<a class="jxr_linenumber" name="L735" href="#L735">735</a> consoleListener = <strong class="jxr_keyword">new</strong> DefaultLogger( stringOutputStream, false ); +<a class="jxr_linenumber" name="L736" href="#L736">736</a> } +<a class="jxr_linenumber" name="L737" href="#L737">737</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="L738" href="#L738">738</a> { +<a class="jxr_linenumber" name="L739" href="#L739">739</a> OutputStream out = getOutputStream( useFile ); +<a class="jxr_linenumber" name="L740" href="#L740">740</a> +<a class="jxr_linenumber" name="L741" href="#L741">741</a> consoleListener = <strong class="jxr_keyword">new</strong> DefaultLogger( out, <strong class="jxr_keyword">true</strong> ); +<a class="jxr_linenumber" name="L742" href="#L742">742</a> } +<a class="jxr_linenumber" name="L743" href="#L743">743</a> +<a class="jxr_linenumber" name="L744" href="#L744">744</a> <strong class="jxr_keyword">return</strong> consoleListener; +<a class="jxr_linenumber" name="L745" href="#L745">745</a> } +<a class="jxr_linenumber" name="L746" href="#L746">746</a> +<a class="jxr_linenumber" name="L747" href="#L747">747</a> <strong class="jxr_keyword">private</strong> OutputStream getOutputStream( File file ) +<a class="jxr_linenumber" name="L748" href="#L748">748</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException +<a class="jxr_linenumber" name="L749" href="#L749">749</a> { +<a class="jxr_linenumber" name="L750" href="#L750">750</a> File parentFile = file.getAbsoluteFile().getParentFile(); +<a class="jxr_linenumber" name="L751" href="#L751">751</a> +<a class="jxr_linenumber" name="L752" href="#L752">752</a> <strong class="jxr_keyword">if</strong> ( !parentFile.exists() ) +<a class="jxr_linenumber" name="L753" href="#L753">753</a> { +<a class="jxr_linenumber" name="L754" href="#L754">754</a> parentFile.mkdirs(); +<a class="jxr_linenumber" name="L755" href="#L755">755</a> } +<a class="jxr_linenumber" name="L756" href="#L756">756</a> +<a class="jxr_linenumber" name="L757" href="#L757">757</a> FileOutputStream fileOutputStream; +<a class="jxr_linenumber" name="L758" href="#L758">758</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L759" href="#L759">759</a> { +<a class="jxr_linenumber" name="L760" href="#L760">760</a> fileOutputStream = <strong class="jxr_keyword">new</strong> FileOutputStream( file ); +<a class="jxr_linenumber" name="L761" href="#L761">761</a> } +<a class="jxr_linenumber" name="L762" href="#L762">762</a> <strong class="jxr_keyword">catch</strong> ( FileNotFoundException e ) +<a class="jxr_linenumber" name="L763" href="#L763">763</a> { +<a class="jxr_linenumber" name="L764" href="#L764">764</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Unable to create output stream: "</span> + file, e ); +<a class="jxr_linenumber" name="L765" href="#L765">765</a> } +<a class="jxr_linenumber" name="L766" href="#L766">766</a> <strong class="jxr_keyword">return</strong> fileOutputStream; +<a class="jxr_linenumber" name="L767" href="#L767">767</a> } +<a class="jxr_linenumber" name="L768" href="#L768">768</a> +<a class="jxr_linenumber" name="L769" href="#L769">769</a> <strong class="jxr_keyword">private</strong> AuditListener getListener() +<a class="jxr_linenumber" name="L770" href="#L770">770</a> <strong class="jxr_keyword">throws</strong> MojoFailureException, MojoExecutionException +<a class="jxr_linenumber" name="L771" href="#L771">771</a> { +<a class="jxr_linenumber" name="L772" href="#L772">772</a> AuditListener listener = <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L773" href="#L773">773</a> +<a class="jxr_linenumber" name="L774" href="#L774">774</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isNotEmpty( outputFileFormat ) ) +<a class="jxr_linenumber" name="L775" href="#L775">775</a> { +<a class="jxr_linenumber" name="L776" href="#L776">776</a> File resultFile = outputFile; +<a class="jxr_linenumber" name="L777" href="#L777">777</a> +<a class="jxr_linenumber" name="L778" href="#L778">778</a> OutputStream out = getOutputStream( resultFile ); +<a class="jxr_linenumber" name="L779" href="#L779">779</a> +<a class="jxr_linenumber" name="L780" href="#L780">780</a> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"xml"</span>.equals( outputFileFormat ) ) +<a class="jxr_linenumber" name="L781" href="#L781">781</a> { +<a class="jxr_linenumber" name="L782" href="#L782">782</a> listener = <strong class="jxr_keyword">new</strong> XMLLogger( out, <strong class="jxr_keyword">true</strong> ); +<a class="jxr_linenumber" name="L783" href="#L783">783</a> } +<a class="jxr_linenumber" name="L784" href="#L784">784</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( <span class="jxr_string">"plain"</span>.equals( outputFileFormat ) ) +<a class="jxr_linenumber" name="L785" href="#L785">785</a> { +<a class="jxr_linenumber" name="L786" href="#L786">786</a> listener = <strong class="jxr_keyword">new</strong> DefaultLogger( out, <strong class="jxr_keyword">true</strong> ); +<a class="jxr_linenumber" name="L787" href="#L787">787</a> } +<a class="jxr_linenumber" name="L788" href="#L788">788</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="L789" href="#L789">789</a> { +<a class="jxr_linenumber" name="L790" href="#L790">790</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException( <span class="jxr_string">"Invalid output file format: ("</span> + outputFileFormat +<a class="jxr_linenumber" name="L791" href="#L791">791</a> + <span class="jxr_string">"). Must be 'plain' or 'xml'."</span> ); +<a class="jxr_linenumber" name="L792" href="#L792">792</a> } <a class="jxr_linenumber" name="L793" href="#L793">793</a> } <a class="jxr_linenumber" name="L794" href="#L794">794</a> -<a class="jxr_linenumber" name="L795" href="#L795">795</a> artifacts.addAll( getCheckstylePluginDependenciesAsArtifacts( project.getBuild().getPluginsAsMap(), hint ) ); -<a class="jxr_linenumber" name="L796" href="#L796">796</a> -<a class="jxr_linenumber" name="L797" href="#L797">797</a> <strong class="jxr_keyword">return</strong> artifacts; -<a class="jxr_linenumber" name="L798" href="#L798">798</a> } -<a class="jxr_linenumber" name="L799" href="#L799">799</a> -<a class="jxr_linenumber" name="L800" href="#L800">800</a> <strong class="jxr_keyword">private</strong> List<Artifact> getCheckstylePluginDependenciesAsArtifacts( Map<String, Plugin> plugins, String hint ) -<a class="jxr_linenumber" name="L801" href="#L801">801</a> { -<a class="jxr_linenumber" name="L802" href="#L802">802</a> List<Artifact> artifacts = <strong class="jxr_keyword">new</strong> ArrayList<Artifact>(); -<a class="jxr_linenumber" name="L803" href="#L803">803</a> -<a class="jxr_linenumber" name="L804" href="#L804">804</a> Plugin checkstylePlugin = plugins.get( plugin.getGroupId() + <span class="jxr_string">":"</span> + plugin.getArtifactId() ); -<a class="jxr_linenumber" name="L805" href="#L805">805</a> <strong class="jxr_keyword">if</strong> ( checkstylePlugin != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L806" href="#L806">806</a> { -<a class="jxr_linenumber" name="L807" href="#L807">807</a> <strong class="jxr_keyword">for</strong> ( Dependency dep : checkstylePlugin.getDependencies() ) -<a class="jxr_linenumber" name="L808" href="#L808">808</a> { -<a class="jxr_linenumber" name="L809" href="#L809">809</a> <em class="jxr_comment">// @todo if we can filter on hints, it should be done here...</em> -<a class="jxr_linenumber" name="L810" href="#L810">810</a> String depKey = dep.getGroupId() + <span class="jxr_string">":"</span> + dep.getArtifactId(); -<a class="jxr_linenumber" name="L811" href="#L811">811</a> artifacts.add( (Artifact) plugin.getArtifactMap().get( depKey ) ); -<a class="jxr_linenumber" name="L812" href="#L812">812</a> } +<a class="jxr_linenumber" name="L795" href="#L795">795</a> <strong class="jxr_keyword">return</strong> listener; +<a class="jxr_linenumber" name="L796" href="#L796">796</a> } +<a class="jxr_linenumber" name="L797" href="#L797">797</a> +<a class="jxr_linenumber" name="L798" href="#L798">798</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> ) +<a class="jxr_linenumber" name="L799" href="#L799">799</a> <strong class="jxr_keyword">private</strong> List<Artifact> collectArtifacts( String hint ) +<a class="jxr_linenumber" name="L800" href="#L800">800</a> { +<a class="jxr_linenumber" name="L801" href="#L801">801</a> <strong class="jxr_keyword">if</strong> ( plugin == <strong class="jxr_keyword">null</strong> || plugin.getGroupId() == <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L802" href="#L802">802</a> { +<a class="jxr_linenumber" name="L803" href="#L803">803</a> <em class="jxr_comment">// Maven 2.x workaround</em> +<a class="jxr_linenumber" name="L804" href="#L804">804</a> plugin = mojoExecution.getMojoDescriptor().getPluginDescriptor(); +<a class="jxr_linenumber" name="L805" href="#L805">805</a> } +<a class="jxr_linenumber" name="L806" href="#L806">806</a> +<a class="jxr_linenumber" name="L807" href="#L807">807</a> List<Artifact> artifacts = <strong class="jxr_keyword">new</strong> ArrayList<Artifact>(); +<a class="jxr_linenumber" name="L808" href="#L808">808</a> +<a class="jxr_linenumber" name="L809" href="#L809">809</a> PluginManagement pluginManagement = project.getBuild().getPluginManagement(); +<a class="jxr_linenumber" name="L810" href="#L810">810</a> <strong class="jxr_keyword">if</strong> ( pluginManagement != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L811" href="#L811">811</a> { +<a class="jxr_linenumber" name="L812" href="#L812">812</a> artifacts.addAll( getCheckstylePluginDependenciesAsArtifacts( pluginManagement.getPluginsAsMap(), hint ) ); <a class="jxr_linenumber" name="L813" href="#L813">813</a> } -<a class="jxr_linenumber" name="L814" href="#L814">814</a> <strong class="jxr_keyword">return</strong> artifacts; -<a class="jxr_linenumber" name="L815" href="#L815">815</a> } -<a class="jxr_linenumber" name="L816" href="#L816">816</a> -<a class="jxr_linenumber" name="L817" href="#L817">817</a> <strong class="jxr_keyword">private</strong> List<File> getSourceDirectories() -<a class="jxr_linenumber" name="L818" href="#L818">818</a> { -<a class="jxr_linenumber" name="L819" href="#L819">819</a> List<File> sourceDirs = <strong class="jxr_keyword">null</strong>; -<a class="jxr_linenumber" name="L820" href="#L820">820</a> <em class="jxr_comment">// if sourceDirectory is explicitly set, use it</em> -<a class="jxr_linenumber" name="L821" href="#L821">821</a> <strong class="jxr_keyword">if</strong>( sourceDirectory != <strong class="jxr_keyword">null</strong> )
[... 104 lines stripped ...]