Modified:
maven/website/components/plugins-archives/maven-checkstyle-plugin-LATEST/xref/org/apache/maven/plugins/checkstyle/AbstractCheckstyleReport.html
==============================================================================
---
maven/website/components/plugins-archives/maven-checkstyle-plugin-LATEST/xref/org/apache/maven/plugins/checkstyle/AbstractCheckstyleReport.html
(original)
+++
maven/website/components/plugins-archives/maven-checkstyle-plugin-LATEST/xref/org/apache/maven/plugins/checkstyle/AbstractCheckstyleReport.html
Sun Jun 2 14:48:29 2024
@@ -39,722 +39,730 @@
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong
class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="L32" href="#L32">32</a>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong
class="jxr_keyword">import</strong>
com.puppycrawl.tools.checkstyle.DefaultLogger;
-<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong
class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.XMLLogger;
-<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong
class="jxr_keyword">import</strong>
com.puppycrawl.tools.checkstyle.api.AuditListener;
-<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong
class="jxr_keyword">import</strong>
com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions;
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong
class="jxr_keyword">import</strong>
com.puppycrawl.tools.checkstyle.api.CheckstyleException;
-<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.artifact.Artifact;
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.execution.MavenSession;
-<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.model.Dependency;
-<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.model.Plugin;
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.model.PluginManagement;
-<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.model.ReportPlugin;
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.model.Resource;
-<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugin.descriptor.PluginDescriptor;
-<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.annotations.Component;
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.annotations.Parameter;
-<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutor;
-<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorException;
-<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest;
-<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.checkstyle.exec.CheckstyleResults;
-<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.reporting.AbstractMavenReport;
-<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.reporting.MavenReportException;
-<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.i18n.I18N;
-<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong
class="jxr_keyword">import</strong>
org.codehaus.plexus.resource.ResourceManager;
-<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong
class="jxr_keyword">import</strong>
org.codehaus.plexus.resource.loader.FileResourceLoader;
-<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong
class="jxr_keyword">import</strong> org.codehaus.plexus.util.FileUtils;
-<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong
class="jxr_keyword">import</strong> org.codehaus.plexus.util.PathTool;
-<a class="jxr_linenumber" name="L60" href="#L60">60</a>
-<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em
class="jxr_javadoccomment"> * Base abstract class for Checkstyle reports.</em>
-<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong
class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.SarifLogger;
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong
class="jxr_keyword">import</strong> com.puppycrawl.tools.checkstyle.XMLLogger;
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong
class="jxr_keyword">import</strong>
com.puppycrawl.tools.checkstyle.api.AuditListener;
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong
class="jxr_keyword">import</strong>
com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions;
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong
class="jxr_keyword">import</strong>
com.puppycrawl.tools.checkstyle.api.CheckstyleException;
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.artifact.Artifact;
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.execution.MavenSession;
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.model.Dependency;
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.model.Plugin;
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.model.PluginManagement;
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.model.ReportPlugin;
+<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.model.Resource;
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugin.descriptor.PluginDescriptor;
+<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.annotations.Component;
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.annotations.Parameter;
+<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutor;
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorException;
+<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest;
+<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.plugins.checkstyle.exec.CheckstyleResults;
+<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.reporting.AbstractMavenReport;
+<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.reporting.MavenReportException;
+<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong
class="jxr_keyword">import</strong>
org.codehaus.plexus.configuration.PlexusConfiguration;
+<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong
class="jxr_keyword">import</strong> org.codehaus.plexus.i18n.I18N;
+<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong
class="jxr_keyword">import</strong>
org.codehaus.plexus.resource.ResourceManager;
+<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong
class="jxr_keyword">import</strong>
org.codehaus.plexus.resource.loader.FileResourceLoader;
+<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong
class="jxr_keyword">import</strong> org.codehaus.plexus.util.FileUtils;
+<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong
class="jxr_keyword">import</strong> org.codehaus.plexus.util.PathTool;
+<a class="jxr_linenumber" name="L61" href="#L61">61</a>
+<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em
class="jxr_javadoccomment"> * Base abstract class for Checkstyle reports.</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong
class="jxr_keyword">public</strong> <strong
class="jxr_keyword">abstract</strong> <strong
class="jxr_keyword">class</strong> <a name="AbstractCheckstyleReport"
href="../../../../../org/apache/maven/plugins/checkstyle/AbstractCheckstyleReport.html#AbstractCheckstyleReport">AbstractCheckstyleReport</a>
<strong class="jxr_keyword">extends</strong> AbstractMavenReport {
-<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong
class="jxr_keyword">protected</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="L68" href="#L68">68</a>
-<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong>
String DEFAULT_CONFIG_LOCATION = <span
class="jxr_string">"sun_checks.xml"</span>;
-<a class="jxr_linenumber" name="L70" href="#L70">70</a>
-<a class="jxr_linenumber" name="L71" href="#L71">71</a>
@Parameter(defaultValue = <span class="jxr_string">"${session}"</span>,
readonly = <strong class="jxr_keyword">true</strong>, required = <strong
class="jxr_keyword">true</strong>)
-<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong
class="jxr_keyword">private</strong> MavenSession session;
-<a class="jxr_linenumber" name="L73" href="#L73">73</a>
-<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em
class="jxr_javadoccomment"> * Specifies the cache file used to speed up
Checkstyle on successive runs.</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>
@Parameter(defaultValue = <span
class="jxr_string">"${project.build.directory}/checkstyle-cachefile"</span>)
-<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong
class="jxr_keyword">protected</strong> String cacheFile;
-<a class="jxr_linenumber" name="L79" href="#L79">79</a>
-<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em
class="jxr_javadoccomment"> * Specifies the location of the XML
configuration to use.</em>
-<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em
class="jxr_javadoccomment"> * Potential values are a filesystem path, a
URL, or a classpath resource.</em>
-<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em
class="jxr_javadoccomment"> * This parameter expects that the contents of
the location conform to the</em>
-<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em
class="jxr_javadoccomment"> * xml format (Checkstyle <a</em>
-<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em
class="jxr_javadoccomment"> * href="<a
href="https://checkstyle.org/config.html";
target="alexandria_uri">https://checkstyle.org/config.html</a>#Modules">Checker</em>
-<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em
class="jxr_javadoccomment"> * module</a>) configuration of
rulesets.</em>
-<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em
class="jxr_javadoccomment"> * This parameter is resolved as resource, URL,
then file. If successfully</em>
-<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em
class="jxr_javadoccomment"> * resolved, the contents of the configuration
is copied into the</em>
-<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em
class="jxr_javadoccomment"> *
<code>${project.build.directory}/checkstyle-configuration.xml</code></em>
-<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em
class="jxr_javadoccomment"> * file before being passed to Checkstyle as a
configuration.</em>
-<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em
class="jxr_javadoccomment"> * There are 2 predefined rulesets included in
Maven Checkstyle Plugin:</em>
-<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em
class="jxr_javadoccomment"> * <ul></em>
-<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em
class="jxr_javadoccomment"> *
<li><code>sun_checks.xml</code>: Sun Checks.</li></em>
-<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em
class="jxr_javadoccomment"> *
<li><code>google_checks.xml</code>: Google
Checks.</li></em>
-<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em
class="jxr_javadoccomment"> * </ul></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.config.location"</span>, defaultValue =
DEFAULT_CONFIG_LOCATION)
-<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong
class="jxr_keyword">protected</strong> String configLocation;
-<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"> * Output errors to console.</em>
-<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L107" href="#L107">107</a>
@Parameter(property = <span
class="jxr_string">"checkstyle.consoleOutput"</span>, defaultValue = <span
class="jxr_string">"false"</span>)
-<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">boolean</strong> consoleOutput;
-<a class="jxr_linenumber" name="L109" href="#L109">109</a>
-<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em
class="jxr_javadoccomment"> * Specifies if the build should fail upon a
violation.</em>
-<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>
@Parameter(defaultValue = <span class="jxr_string">"false"</span>)
-<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">boolean</strong> failsOnError;
-<a class="jxr_linenumber" name="L115" href="#L115">115</a>
-<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"> * <p></em>
-<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em
class="jxr_javadoccomment"> * Specifies the location of the License file
(a.k.a. the header file) that</em>
-<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em
class="jxr_javadoccomment"> * can be used by Checkstyle to verify that
source code has the correct</em>
-<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em
class="jxr_javadoccomment"> * license header.</em>
-<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em
class="jxr_javadoccomment"> * You need to use
<code>${checkstyle.header.file}</code> in your Checkstyle xml</em>
-<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em
class="jxr_javadoccomment"> * configuration to reference the name of this
header file.</em>
-<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em
class="jxr_javadoccomment"> * For instance:</em>
-<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em
class="jxr_javadoccomment"> * <pre></em>
-<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em
class="jxr_javadoccomment"> * &lt;module
name="RegexpHeader"&gt;</em>
-<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em
class="jxr_javadoccomment"> * &lt;property name="headerFile"
value="${checkstyle.header.file}"/&gt;</em>
-<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em
class="jxr_javadoccomment"> * &lt;/module&gt;</em>
-<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em
class="jxr_javadoccomment"> * </pre></em>
-<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"> * @since 2.0-beta-2</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>
@Parameter(property = <span class="jxr_string">"checkstyle.header.file"</span>,
defaultValue = <span class="jxr_string">"LICENSE.txt"</span>)
-<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong
class="jxr_keyword">protected</strong> String headerLocation;
-<a class="jxr_linenumber" name="L136" href="#L136">136</a>
-<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em
class="jxr_javadoccomment"> * Skip entire check.</em>
-<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"> * @since 2.2</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>
@Parameter(property = <span class="jxr_string">"checkstyle.skip"</span>,
defaultValue = <span class="jxr_string">"false"</span>)
-<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">boolean</strong> skip;
-<a class="jxr_linenumber" name="L144" href="#L144">144</a>
-<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em
class="jxr_javadoccomment"> * Specifies the path and filename to save the
Checkstyle output. The format</em>
-<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em
class="jxr_javadoccomment"> * of the output file is determined by the
<code>outputFileFormat</code></em>
-<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em
class="jxr_javadoccomment"> * parameter.</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>
@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="L151" href="#L151">151</a> <strong
class="jxr_keyword">private</strong> File outputFile;
-<a class="jxr_linenumber" name="L152" href="#L152">152</a>
-<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em
class="jxr_javadoccomment"> * Specifies the location of the properties
file.</em>
-<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em
class="jxr_javadoccomment"> * This parameter is resolved as URL, File then
resource. If successfully</em>
-<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em
class="jxr_javadoccomment"> * resolved, the contents of the properties
location is copied into the</em>
-<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em
class="jxr_javadoccomment"> *
<code>${project.build.directory}/checkstyle-checker.properties</code></em>
-<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em
class="jxr_javadoccomment"> * file before being passed to Checkstyle for
loading.</em>
-<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em
class="jxr_javadoccomment"> * The contents of the
<code>propertiesLocation</code> will be made</em>
-<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em
class="jxr_javadoccomment"> * available to Checkstyle for specifying values
for parameters within the</em>
-<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em
class="jxr_javadoccomment"> * xml configuration (specified in the
<code>configLocation</code></em>
-<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em
class="jxr_javadoccomment"> * parameter).</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.0-beta-2</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(property = <span
class="jxr_string">"checkstyle.properties.location"</span>)
-<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong
class="jxr_keyword">protected</strong> String propertiesLocation;
-<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"> * Allows for specifying raw property expansion
information.</em>
-<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L175" href="#L175">175</a> @Parameter
-<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong
class="jxr_keyword">protected</strong> String propertyExpansion;
-<a class="jxr_linenumber" name="L177" href="#L177">177</a>
-<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em
class="jxr_javadoccomment"> * Specifies the location of the resources to be
used for Checkstyle.</em>
-<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em
class="jxr_javadoccomment"> * @since 2.10</em>
-<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L183" href="#L183">183</a>
@Parameter(defaultValue = <span
class="jxr_string">"${project.resources}"</span>, readonly = <strong
class="jxr_keyword">true</strong>)
-<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong
class="jxr_keyword">protected</strong> List<Resource> resources;
-<a class="jxr_linenumber" name="L185" href="#L185">185</a>
-<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em
class="jxr_javadoccomment"> * Specifies the location of the test resources
to be used for Checkstyle.</em>
-<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em
class="jxr_javadoccomment"> * @since 2.11</em>
-<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L191" href="#L191">191</a>
@Parameter(defaultValue = <span
class="jxr_string">"${project.testResources}"</span>, readonly = <strong
class="jxr_keyword">true</strong>)
-<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong
class="jxr_keyword">protected</strong> List<Resource> testResources;
-<a class="jxr_linenumber" name="L193" href="#L193">193</a>
-<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em
class="jxr_javadoccomment"> * Specifies the names filter of the source
files to be used for Checkstyle.</em>
-<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L197" href="#L197">197</a>
@Parameter(property = <span class="jxr_string">"checkstyle.includes"</span>,
defaultValue = JAVA_FILES, required = <strong class="jxr_keyword">true</strong>)
-<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong
class="jxr_keyword">protected</strong> String includes;
-<a class="jxr_linenumber" name="L199" href="#L199">199</a>
-<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em
class="jxr_javadoccomment"> * Specifies the names filter of the source
files to be excluded for</em>
-<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em
class="jxr_javadoccomment"> * Checkstyle.</em>
-<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L204" href="#L204">204</a>
@Parameter(property = <span class="jxr_string">"checkstyle.excludes"</span>)
-<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong
class="jxr_keyword">protected</strong> String excludes;
-<a class="jxr_linenumber" name="L206" href="#L206">206</a>
-<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em
class="jxr_javadoccomment"> * Specifies the names filter of the resource
files to be used for Checkstyle.</em>
-<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em
class="jxr_javadoccomment"> * @since 2.11</em>
-<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L211" href="#L211">211</a>
@Parameter(property = <span
class="jxr_string">"checkstyle.resourceIncludes"</span>, defaultValue = <span
class="jxr_string">"**/*.properties"</span>, required = <strong
class="jxr_keyword">true</strong>)
-<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong
class="jxr_keyword">protected</strong> String resourceIncludes;
-<a class="jxr_linenumber" name="L213" href="#L213">213</a>
-<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em
class="jxr_javadoccomment"> * Specifies the names filter of the resource
files to be excluded for</em>
-<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em
class="jxr_javadoccomment"> * Checkstyle.</em>
-<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em
class="jxr_javadoccomment"> * @since 2.11</em>
-<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L219" href="#L219">219</a>
@Parameter(property = <span
class="jxr_string">"checkstyle.resourceExcludes"</span>)
-<a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong
class="jxr_keyword">protected</strong> String resourceExcludes;
-<a class="jxr_linenumber" name="L221" href="#L221">221</a>
-<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em
class="jxr_javadoccomment"> * Specifies whether to include the resource
directories in the check.</em>
-<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em
class="jxr_javadoccomment"> * @since 2.11</em>
-<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L226" href="#L226">226</a>
@Parameter(property = <span
class="jxr_string">"checkstyle.includeResources"</span>, defaultValue = <span
class="jxr_string">"true"</span>, required = <strong
class="jxr_keyword">true</strong>)
-<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">boolean</strong> includeResources;
-<a class="jxr_linenumber" name="L228" href="#L228">228</a>
-<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em
class="jxr_javadoccomment"> * Specifies whether to include the test
resource directories in the check.</em>
-<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em
class="jxr_javadoccomment"> * @since 2.11</em>
-<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L233" href="#L233">233</a>
@Parameter(property = <span
class="jxr_string">"checkstyle.includeTestResources"</span>, defaultValue =
<span class="jxr_string">"true"</span>, required = <strong
class="jxr_keyword">true</strong>)
-<a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">boolean</strong> includeTestResources;
-<a class="jxr_linenumber" name="L235" href="#L235">235</a>
-<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em
class="jxr_javadoccomment"> * Specifies the location of the source
directory to be used for Checkstyle.</em>
-<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em
class="jxr_javadoccomment"> * @deprecated instead use {@link
#sourceDirectories}. For version 3.0.0, this parameter is only defined to
break</em>
-<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em
class="jxr_javadoccomment"> * the build if you use it!</em>
-<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L242" href="#L242">242</a> @Deprecated
-<a class="jxr_linenumber" name="L243" href="#L243">243</a> @Parameter
-<a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong
class="jxr_keyword">private</strong> File sourceDirectory;
-<a class="jxr_linenumber" name="L245" href="#L245">245</a>
-<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em
class="jxr_javadoccomment"> * Specifies the location of the source
directories to be used for Checkstyle.</em>
-<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em
class="jxr_javadoccomment"> * Default value is
<code>${project.compileSourceRoots}</code>.</em>
-<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em
class="jxr_javadoccomment"> * @since 2.13</em>
-<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em
class="jxr_comment">// Compatibility with all Maven 3: default of
'project.compileSourceRoots' is done manually because of MNG-5440</em>
-<a class="jxr_linenumber" name="L252" href="#L252">252</a> @Parameter
-<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong
class="jxr_keyword">private</strong> List<String> sourceDirectories;
-<a class="jxr_linenumber" name="L254" href="#L254">254</a>
-<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em
class="jxr_javadoccomment"> * Specifies the location of the test source
directory to be used for Checkstyle.</em>
-<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em
class="jxr_javadoccomment"> * @since 2.2</em>
-<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em
class="jxr_javadoccomment"> * @deprecated instead use {@link
#testSourceDirectories}. For version 3.0.0, this parameter is only defined
to</em>
-<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em
class="jxr_javadoccomment"> * break the build if you use
it!</em>
-<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L262" href="#L262">262</a> @Parameter
-<a class="jxr_linenumber" name="L263" href="#L263">263</a> @Deprecated
-<a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong
class="jxr_keyword">private</strong> File testSourceDirectory;
-<a class="jxr_linenumber" name="L265" href="#L265">265</a>
-<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em
class="jxr_javadoccomment"> * Specifies the location of the test source
directories to be used for Checkstyle.</em>
-<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em
class="jxr_javadoccomment"> * Default value is
<code>${project.testCompileSourceRoots}</code>.</em>
-<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em
class="jxr_javadoccomment"> * @since 2.13</em>
-<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em
class="jxr_comment">// Compatibility with all Maven 3: default of
'project.testCompileSourceRoots' is done manually because of MNG-5440</em>
-<a class="jxr_linenumber" name="L272" href="#L272">272</a> @Parameter
-<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong
class="jxr_keyword">private</strong> List<String> testSourceDirectories;
-<a class="jxr_linenumber" name="L274" href="#L274">274</a>
-<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em
class="jxr_javadoccomment"> * Include or not the test source
directory/directories to be used for Checkstyle.</em>
-<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em
class="jxr_javadoccomment"> * @since 2.2</em>
-<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L280" href="#L280">280</a>
@Parameter(defaultValue = <span class="jxr_string">"false"</span>)
-<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">boolean</strong> includeTestSourceDirectory;
-<a class="jxr_linenumber" name="L282" href="#L282">282</a>
-<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em
class="jxr_javadoccomment"> * The key to be used in the properties for the
suppressions file.</em>
-<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em
class="jxr_javadoccomment"> * @since 2.1</em>
-<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L288" href="#L288">288</a>
@Parameter(property = <span
class="jxr_string">"checkstyle.suppression.expression"</span>, defaultValue =
<span class="jxr_string">"checkstyle.suppressions.file"</span>)
-<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong
class="jxr_keyword">protected</strong> String suppressionsFileExpression;
-<a class="jxr_linenumber" name="L290" href="#L290">290</a>
-<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em
class="jxr_javadoccomment"> * Specifies the location of the suppressions
XML file to use.</em>
-<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em
class="jxr_javadoccomment"> * This parameter is resolved as resource, URL,
then file. If successfully</em>
-<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em
class="jxr_javadoccomment"> * resolved, the contents of the suppressions
XML is copied into the</em>
-<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em
class="jxr_javadoccomment"> *
<code>${project.build.directory}/checkstyle-supressions.xml</code>
file</em>
-<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em
class="jxr_javadoccomment"> * before being passed to Checkstyle for
loading.</em>
-<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em
class="jxr_javadoccomment"> * See
<code>suppressionsFileExpression</code> for the property that
will</em>
-<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em
class="jxr_javadoccomment"> * be made available to your Checkstyle
configuration.</em>
-<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em
class="jxr_javadoccomment"> * @since 2.0-beta-2</em>
-<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L305" href="#L305">305</a>
@Parameter(property = <span
class="jxr_string">"checkstyle.suppressions.location"</span>)
-<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong
class="jxr_keyword">protected</strong> String suppressionsLocation;
-<a class="jxr_linenumber" name="L307" href="#L307">307</a>
-<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em
class="jxr_javadoccomment"> * If <code>null</code>, the
Checkstyle plugin will display violations on stdout.</em>
-<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em
class="jxr_javadoccomment"> * Otherwise, a text file will be created with
the violations.</em>
-<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L312" href="#L312">312</a> @Parameter
-<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong
class="jxr_keyword">private</strong> File useFile;
-<a class="jxr_linenumber" name="L314" href="#L314">314</a>
-<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L316" href="#L316">316</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="L317" href="#L317">317</a> <em
class="jxr_javadoccomment"> * file. Valid values are
"<code>plain</code>" and "<code>xml</code>".</em>
-<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L319" href="#L319">319</a>
@Parameter(property = <span
class="jxr_string">"checkstyle.output.format"</span>, defaultValue = <span
class="jxr_string">"xml"</span>)
-<a class="jxr_linenumber" name="L320" href="#L320">320</a> <strong
class="jxr_keyword">private</strong> String outputFileFormat;
-<a class="jxr_linenumber" name="L321" href="#L321">321</a>
-<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em
class="jxr_javadoccomment"> * Specifies if the Rules summary should be
enabled or not.</em>
-<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L325" href="#L325">325</a>
@Parameter(property = <span
class="jxr_string">"checkstyle.enable.rules.summary"</span>, defaultValue =
<span class="jxr_string">"true"</span>)
-<a class="jxr_linenumber" name="L326" href="#L326">326</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> enableRulesSummary;
-<a class="jxr_linenumber" name="L327" href="#L327">327</a>
-<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em
class="jxr_javadoccomment"> * Specifies if the Severity summary should be
enabled or not.</em>
-<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L331" href="#L331">331</a>
@Parameter(property = <span
class="jxr_string">"checkstyle.enable.severity.summary"</span>, defaultValue =
<span class="jxr_string">"true"</span>)
-<a class="jxr_linenumber" name="L332" href="#L332">332</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> enableSeveritySummary;
-<a class="jxr_linenumber" name="L333" href="#L333">333</a>
-<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em
class="jxr_javadoccomment"> * Specifies if the Files summary should be
enabled or not.</em>
-<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L337" href="#L337">337</a>
@Parameter(property = <span
class="jxr_string">"checkstyle.enable.files.summary"</span>, defaultValue =
<span class="jxr_string">"true"</span>)
-<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> enableFilesSummary;
-<a class="jxr_linenumber" name="L339" href="#L339">339</a>
-<a class="jxr_linenumber" name="L340" href="#L340">340</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L341" href="#L341">341</a> <em
class="jxr_javadoccomment"> * The Plugin Descriptor</em>
-<a class="jxr_linenumber" name="L342" href="#L342">342</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L343" href="#L343">343</a>
@Parameter(defaultValue = <span class="jxr_string">"${plugin}"</span>, readonly
= <strong class="jxr_keyword">true</strong>, required = <strong
class="jxr_keyword">true</strong>)
-<a class="jxr_linenumber" name="L344" href="#L344">344</a> <strong
class="jxr_keyword">private</strong> PluginDescriptor plugin;
-<a class="jxr_linenumber" name="L345" href="#L345">345</a>
-<a class="jxr_linenumber" name="L346" href="#L346">346</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em
class="jxr_javadoccomment"> * Link the violation line numbers to the source
xref. Will link</em>
-<a class="jxr_linenumber" name="L348" href="#L348">348</a> <em
class="jxr_javadoccomment"> * automatically if Maven JXR plugin is being
used.</em>
-<a class="jxr_linenumber" name="L349" href="#L349">349</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em
class="jxr_javadoccomment"> * @since 2.1</em>
-<a class="jxr_linenumber" name="L351" href="#L351">351</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L352" href="#L352">352</a>
@Parameter(property = <span class="jxr_string">"linkXRef"</span>, defaultValue
= <span class="jxr_string">"true"</span>)
-<a class="jxr_linenumber" name="L353" href="#L353">353</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> linkXRef;
-<a class="jxr_linenumber" name="L354" href="#L354">354</a>
-<a class="jxr_linenumber" name="L355" href="#L355">355</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L356" href="#L356">356</a> <em
class="jxr_javadoccomment"> * Location of the Xrefs to link to.</em>
-<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L358" href="#L358">358</a>
@Parameter(defaultValue = <span
class="jxr_string">"${project.reporting.outputDirectory}/xref"</span>)
-<a class="jxr_linenumber" name="L359" href="#L359">359</a> <strong
class="jxr_keyword">private</strong> File xrefLocation;
-<a class="jxr_linenumber" name="L360" href="#L360">360</a>
-<a class="jxr_linenumber" name="L361" href="#L361">361</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L362" href="#L362">362</a> <em
class="jxr_javadoccomment"> * Location of the XrefTests to link to.</em>
-<a class="jxr_linenumber" name="L363" href="#L363">363</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L364" href="#L364">364</a>
@Parameter(defaultValue = <span
class="jxr_string">"${project.reporting.outputDirectory}/xref-test"</span>)
-<a class="jxr_linenumber" name="L365" href="#L365">365</a> <strong
class="jxr_keyword">private</strong> File xrefTestLocation;
-<a class="jxr_linenumber" name="L366" href="#L366">366</a>
-<a class="jxr_linenumber" name="L367" href="#L367">367</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L368" href="#L368">368</a> <em
class="jxr_javadoccomment"> * When using custom treeWalkers, specify their
names here so the checks</em>
-<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em
class="jxr_javadoccomment"> * inside the treeWalker end up the the
rule-summary.</em>
-<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em
class="jxr_javadoccomment"> * @since 2.11</em>
-<a class="jxr_linenumber" name="L372" href="#L372">372</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L373" href="#L373">373</a> @Parameter
-<a class="jxr_linenumber" name="L374" href="#L374">374</a> <strong
class="jxr_keyword">private</strong> List<String> treeWalkerNames;
-<a class="jxr_linenumber" name="L375" href="#L375">375</a>
-<a class="jxr_linenumber" name="L376" href="#L376">376</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L377" href="#L377">377</a> <em
class="jxr_javadoccomment"> * Specifies whether modules with a configured
severity of <code>ignore</code> should be omitted during
Checkstyle</em>
-<a class="jxr_linenumber" name="L378" href="#L378">378</a> <em
class="jxr_javadoccomment"> * invocation.</em>
-<a class="jxr_linenumber" name="L379" href="#L379">379</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L380" href="#L380">380</a> <em
class="jxr_javadoccomment"> * @since 3.0.0</em>
-<a class="jxr_linenumber" name="L381" href="#L381">381</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L382" href="#L382">382</a>
@Parameter(defaultValue = <span class="jxr_string">"false"</span>)
-<a class="jxr_linenumber" name="L383" href="#L383">383</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> omitIgnoredModules;
-<a class="jxr_linenumber" name="L384" href="#L384">384</a>
-<a class="jxr_linenumber" name="L385" href="#L385">385</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L386" href="#L386">386</a> <em
class="jxr_javadoccomment"> * By using this property, you can specify the
whole Checkstyle rules</em>
-<a class="jxr_linenumber" name="L387" href="#L387">387</a> <em
class="jxr_javadoccomment"> * inline directly inside this pom.</em>
-<a class="jxr_linenumber" name="L388" href="#L388">388</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em
class="jxr_javadoccomment"> * <pre></em>
-<a class="jxr_linenumber" name="L390" href="#L390">390</a> <em
class="jxr_javadoccomment"> * &lt;plugin&gt;</em>
-<a class="jxr_linenumber" name="L391" href="#L391">391</a> <em
class="jxr_javadoccomment"> * ...</em>
-<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em
class="jxr_javadoccomment"> * &lt;configuration&gt;</em>
-<a class="jxr_linenumber" name="L393" href="#L393">393</a> <em
class="jxr_javadoccomment"> * &lt;checkstyleRules&gt;</em>
-<a class="jxr_linenumber" name="L394" href="#L394">394</a> <em
class="jxr_javadoccomment"> * &lt;module
name="Checker"&gt;</em>
-<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em
class="jxr_javadoccomment"> * &lt;module
name="FileTabCharacter"&gt;</em>
-<a class="jxr_linenumber" name="L396" href="#L396">396</a> <em
class="jxr_javadoccomment"> * &lt;property name="eachLine"
value="true" /&gt;</em>
-<a class="jxr_linenumber" name="L397" href="#L397">397</a> <em
class="jxr_javadoccomment"> * &lt;/module&gt;</em>
-<a class="jxr_linenumber" name="L398" href="#L398">398</a> <em
class="jxr_javadoccomment"> * &lt;module
name="TreeWalker"&gt;</em>
-<a class="jxr_linenumber" name="L399" href="#L399">399</a> <em
class="jxr_javadoccomment"> * &lt;module
name="EmptyBlock"/&gt;</em>
-<a class="jxr_linenumber" name="L400" href="#L400">400</a> <em
class="jxr_javadoccomment"> * &lt;/module&gt;</em>
-<a class="jxr_linenumber" name="L401" href="#L401">401</a> <em
class="jxr_javadoccomment"> * &lt;/module&gt;</em>
-<a class="jxr_linenumber" name="L402" href="#L402">402</a> <em
class="jxr_javadoccomment"> * &lt;/checkstyleRules&gt;</em>
-<a class="jxr_linenumber" name="L403" href="#L403">403</a> <em
class="jxr_javadoccomment"> * &lt;/configuration&gt;</em>
-<a class="jxr_linenumber" name="L404" href="#L404">404</a> <em
class="jxr_javadoccomment"> * ...</em>
-<a class="jxr_linenumber" name="L405" href="#L405">405</a> <em
class="jxr_javadoccomment"> * </pre></em>
-<a class="jxr_linenumber" name="L406" href="#L406">406</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L407" href="#L407">407</a> <em
class="jxr_javadoccomment"> * @since 2.12</em>
-<a class="jxr_linenumber" name="L408" href="#L408">408</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L409" href="#L409">409</a> @Parameter
-<a class="jxr_linenumber" name="L410" href="#L410">410</a> <strong
class="jxr_keyword">private</strong> PlexusConfiguration checkstyleRules;
-<a class="jxr_linenumber" name="L411" href="#L411">411</a>
-<a class="jxr_linenumber" name="L412" href="#L412">412</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L413" href="#L413">413</a> <em
class="jxr_javadoccomment"> * Dump file for inlined Checkstyle rules.</em>
-<a class="jxr_linenumber" name="L414" href="#L414">414</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L415" href="#L415">415</a> @Parameter(
-<a class="jxr_linenumber" name="L416" href="#L416">416</a>
property = <span class="jxr_string">"checkstyle.output.rules.file"</span>,
-<a class="jxr_linenumber" name="L417" href="#L417">417</a>
defaultValue = <span
class="jxr_string">"${project.build.directory}/checkstyle-rules.xml"</span>)
-<a class="jxr_linenumber" name="L418" href="#L418">418</a> <strong
class="jxr_keyword">private</strong> File rulesFiles;
-<a class="jxr_linenumber" name="L419" href="#L419">419</a>
-<a class="jxr_linenumber" name="L420" href="#L420">420</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L421" href="#L421">421</a> <em
class="jxr_javadoccomment"> * The header to use for the inline
configuration.</em>
-<a class="jxr_linenumber" name="L422" href="#L422">422</a> <em
class="jxr_javadoccomment"> * Only used when you specify {@code
checkstyleRules}.</em>
-<a class="jxr_linenumber" name="L423" href="#L423">423</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L424" href="#L424">424</a> @Parameter(
-<a class="jxr_linenumber" name="L425" href="#L425">425</a>
defaultValue = <span class="jxr_string">"<?xml
version=\"1.0\"?>\n"</span>
-<a class="jxr_linenumber" name="L426" href="#L426">426</a>
+ <span class="jxr_string">"<!DOCTYPE module PUBLIC
\"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN\"\n"</span>
-<a class="jxr_linenumber" name="L427" href="#L427">427</a>
+ <span class="jxr_string">"
\"https://checkstyle.org/dtds/configuration_1_3.dtd\">\n";</span>)
-<a class="jxr_linenumber" name="L428" href="#L428">428</a> <strong
class="jxr_keyword">private</strong> String checkstyleRulesHeader;
-<a class="jxr_linenumber" name="L429" href="#L429">429</a>
-<a class="jxr_linenumber" name="L430" href="#L430">430</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L431" href="#L431">431</a> <em
class="jxr_javadoccomment"> * Specifies whether generated source files
should be excluded from Checkstyle.</em>
-<a class="jxr_linenumber" name="L432" href="#L432">432</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L433" href="#L433">433</a> <em
class="jxr_javadoccomment"> * @since 3.3.1</em>
-<a class="jxr_linenumber" name="L434" href="#L434">434</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L435" href="#L435">435</a>
@Parameter(property = <span
class="jxr_string">"checkstyle.excludeGeneratedSources"</span>, defaultValue =
<span class="jxr_string">"false"</span>)
-<a class="jxr_linenumber" name="L436" href="#L436">436</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> excludeGeneratedSources;
-<a class="jxr_linenumber" name="L437" href="#L437">437</a>
-<a class="jxr_linenumber" name="L438" href="#L438">438</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L439" href="#L439">439</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L440" href="#L440">440</a> @Component
-<a class="jxr_linenumber" name="L441" href="#L441">441</a> <strong
class="jxr_keyword">protected</strong> ResourceManager locator;
-<a class="jxr_linenumber" name="L442" href="#L442">442</a>
-<a class="jxr_linenumber" name="L443" href="#L443">443</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L444" href="#L444">444</a> <em
class="jxr_javadoccomment"> * @since 2.5</em>
-<a class="jxr_linenumber" name="L445" href="#L445">445</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L446" href="#L446">446</a> @Component(role
= CheckstyleExecutor.<strong class="jxr_keyword">class</strong>, hint = <span
class="jxr_string">"default"</span>)
-<a class="jxr_linenumber" name="L447" href="#L447">447</a> <strong
class="jxr_keyword">protected</strong> <a name="CheckstyleExecutor"
href="../../../../../org/apache/maven/plugins/checkstyle/exec/CheckstyleExecutor.html#CheckstyleExecutor">CheckstyleExecutor</a>
checkstyleExecutor;
-<a class="jxr_linenumber" name="L448" href="#L448">448</a>
-<a class="jxr_linenumber" name="L449" href="#L449">449</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L450" href="#L450">450</a> <em
class="jxr_javadoccomment"> * Internationalization component</em>
-<a class="jxr_linenumber" name="L451" href="#L451">451</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L452" href="#L452">452</a> @Component
-<a class="jxr_linenumber" name="L453" href="#L453">453</a> <strong
class="jxr_keyword">private</strong> I18N i18n;
-<a class="jxr_linenumber" name="L454" href="#L454">454</a>
-<a class="jxr_linenumber" name="L455" href="#L455">455</a> <strong
class="jxr_keyword">protected</strong> ByteArrayOutputStream stringOutputStream;
-<a class="jxr_linenumber" name="L456" href="#L456">456</a>
-<a class="jxr_linenumber" name="L457" href="#L457">457</a> <em
class="jxr_javadoccomment">/** {@inheritDoc} */</em>
-<a class="jxr_linenumber" name="L458" href="#L458">458</a> <strong
class="jxr_keyword">public</strong> String getName(Locale locale) {
-<a class="jxr_linenumber" name="L459" href="#L459">459</a> <strong
class="jxr_keyword">return</strong> getI18nString(locale, <span
class="jxr_string">"name"</span>);
-<a class="jxr_linenumber" name="L460" href="#L460">460</a> }
-<a class="jxr_linenumber" name="L461" href="#L461">461</a>
-<a class="jxr_linenumber" name="L462" href="#L462">462</a> <em
class="jxr_javadoccomment">/** {@inheritDoc} */</em>
-<a class="jxr_linenumber" name="L463" href="#L463">463</a> <strong
class="jxr_keyword">public</strong> String getDescription(Locale locale) {
-<a class="jxr_linenumber" name="L464" href="#L464">464</a> <strong
class="jxr_keyword">return</strong> getI18nString(locale, <span
class="jxr_string">"description"</span>);
-<a class="jxr_linenumber" name="L465" href="#L465">465</a> }
-<a class="jxr_linenumber" name="L466" href="#L466">466</a>
-<a class="jxr_linenumber" name="L467" href="#L467">467</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L468" href="#L468">468</a> <em
class="jxr_javadoccomment"> * @param locale The locale</em>
-<a class="jxr_linenumber" name="L469" href="#L469">469</a> <em
class="jxr_javadoccomment"> * @param key The key to search for</em>
-<a class="jxr_linenumber" name="L470" href="#L470">470</a> <em
class="jxr_javadoccomment"> * @return The text appropriate for the
locale.</em>
-<a class="jxr_linenumber" name="L471" href="#L471">471</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L472" href="#L472">472</a> <strong
class="jxr_keyword">protected</strong> String getI18nString(Locale locale,
String key) {
-<a class="jxr_linenumber" name="L473" href="#L473">473</a> <strong
class="jxr_keyword">return</strong> i18n.getString(<span
class="jxr_string">"checkstyle-report"</span>, locale, <span
class="jxr_string">"report.checkstyle."</span> + key);
-<a class="jxr_linenumber" name="L474" href="#L474">474</a> }
-<a class="jxr_linenumber" name="L475" href="#L475">475</a>
-<a class="jxr_linenumber" name="L476" href="#L476">476</a> <em
class="jxr_javadoccomment">/** {@inheritDoc} */</em>
-<a class="jxr_linenumber" name="L477" href="#L477">477</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
executeReport(Locale locale) <strong class="jxr_keyword">throws</strong>
MavenReportException {
-<a class="jxr_linenumber" name="L478" href="#L478">478</a>
checkDeprecatedParameterUsage(sourceDirectory, <span
class="jxr_string">"sourceDirectory"</span>, <span
class="jxr_string">"sourceDirectories"</span>);
-<a class="jxr_linenumber" name="L479" href="#L479">479</a>
checkDeprecatedParameterUsage(testSourceDirectory, <span
class="jxr_string">"testSourceDirectory"</span>, <span
class="jxr_string">"testSourceDirectories"</span>);
-<a class="jxr_linenumber" name="L480" href="#L480">480</a>
-<a class="jxr_linenumber" name="L481" href="#L481">481</a>
locator.addSearchPath(
-<a class="jxr_linenumber" name="L482" href="#L482">482</a>
FileResourceLoader.ID, project.getFile().getParentFile().getAbsolutePath());
-<a class="jxr_linenumber" name="L483" href="#L483">483</a>
locator.addSearchPath(<span class="jxr_string">"url"</span>, <span
class="jxr_string">""</span>);
-<a class="jxr_linenumber" name="L484" href="#L484">484</a>
-<a class="jxr_linenumber" name="L485" href="#L485">485</a>
locator.setOutputDirectory(<strong class="jxr_keyword">new</strong>
File(project.getBuild().getDirectory()));
-<a class="jxr_linenumber" name="L486" href="#L486">486</a>
-<a class="jxr_linenumber" name="L487" href="#L487">487</a> <em
class="jxr_comment">// for when we start using maven-shared-io and
maven-shared-monitor...</em>
-<a class="jxr_linenumber" name="L488" href="#L488">488</a> <em
class="jxr_comment">// locator = new Locator( new MojoLogMonitorAdaptor(
getLog() ) );</em>
-<a class="jxr_linenumber" name="L489" href="#L489">489</a>
-<a class="jxr_linenumber" name="L490" href="#L490">490</a> <em
class="jxr_comment">// locator = new Locator( getLog(), new File(
project.getBuild().getDirectory() ) );</em>
-<a class="jxr_linenumber" name="L491" href="#L491">491</a> String
effectiveConfigLocation = configLocation;
-<a class="jxr_linenumber" name="L492" href="#L492">492</a> <strong
class="jxr_keyword">if</strong> (checkstyleRules != <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L493" href="#L493">493</a> <strong
class="jxr_keyword">if</strong>
(!DEFAULT_CONFIG_LOCATION.equals(configLocation)) {
-<a class="jxr_linenumber" name="L494" href="#L494">494</a>
<strong class="jxr_keyword">throw</strong> <strong
class="jxr_keyword">new</strong> MavenReportException(
-<a class="jxr_linenumber" name="L495" href="#L495">495</a>
<span class="jxr_string">"If you use inline configuration for rules, don't
specify "</span> + <span class="jxr_string">"a configLocation"</span>);
-<a class="jxr_linenumber" name="L496" href="#L496">496</a> }
-<a class="jxr_linenumber" name="L497" href="#L497">497</a> <strong
class="jxr_keyword">if</strong> (checkstyleRules.getChildCount() > 1) {
-<a class="jxr_linenumber" name="L498" href="#L498">498</a>
<strong class="jxr_keyword">throw</strong> <strong
class="jxr_keyword">new</strong> MavenReportException(<span
class="jxr_string">"Currently only one root module is supported"</span>);
-<a class="jxr_linenumber" name="L499" href="#L499">499</a> }
-<a class="jxr_linenumber" name="L500" href="#L500">500</a>
PlexusConfiguration checkerModule = checkstyleRules.getChild(0);
-<a class="jxr_linenumber" name="L501" href="#L501">501</a>
-<a class="jxr_linenumber" name="L502" href="#L502">502</a> <strong
class="jxr_keyword">try</strong> {
-<a class="jxr_linenumber" name="L503" href="#L503">503</a>
FileUtils.forceMkdir(rulesFiles.getParentFile());
-<a class="jxr_linenumber" name="L504" href="#L504">504</a>
FileUtils.fileWrite(rulesFiles, checkstyleRulesHeader +
checkerModule.toString());
-<a class="jxr_linenumber" name="L505" href="#L505">505</a> }
<strong class="jxr_keyword">catch</strong> (<strong
class="jxr_keyword">final</strong> IOException e) {
-<a class="jxr_linenumber" name="L506" href="#L506">506</a>
<strong class="jxr_keyword">throw</strong> <strong
class="jxr_keyword">new</strong> MavenReportException(e.getMessage(), e);
-<a class="jxr_linenumber" name="L507" href="#L507">507</a> }
-<a class="jxr_linenumber" name="L508" href="#L508">508</a>
effectiveConfigLocation = rulesFiles.getAbsolutePath();
-<a class="jxr_linenumber" name="L509" href="#L509">509</a> }
-<a class="jxr_linenumber" name="L510" href="#L510">510</a> ClassLoader
currentClassLoader = Thread.currentThread().getContextClassLoader();
-<a class="jxr_linenumber" name="L511" href="#L511">511</a>
-<a class="jxr_linenumber" name="L512" href="#L512">512</a> <strong
class="jxr_keyword">try</strong> {
-<a class="jxr_linenumber" name="L513" href="#L513">513</a> <a
name="CheckstyleExecutorRequest"
href="../../../../../org/apache/maven/plugins/checkstyle/exec/CheckstyleExecutorRequest.html#CheckstyleExecutorRequest">CheckstyleExecutorRequest</a>
request = createRequest()
-<a class="jxr_linenumber" name="L514" href="#L514">514</a>
.setLicenseArtifacts(collectArtifacts(<span
class="jxr_string">"license"</span>))
-<a class="jxr_linenumber" name="L515" href="#L515">515</a>
.setConfigurationArtifacts(collectArtifacts(<span
class="jxr_string">"configuration"</span>))
-<a class="jxr_linenumber" name="L516" href="#L516">516</a>
.setOmitIgnoredModules(omitIgnoredModules)
-<a class="jxr_linenumber" name="L517" href="#L517">517</a>
.setConfigLocation(effectiveConfigLocation);
-<a class="jxr_linenumber" name="L518" href="#L518">518</a>
-<a class="jxr_linenumber" name="L519" href="#L519">519</a> <a
name="CheckstyleResults"
href="../../../../../org/apache/maven/plugins/checkstyle/exec/CheckstyleResults.html#CheckstyleResults">CheckstyleResults</a>
results = checkstyleExecutor.executeCheckstyle(request);
-<a class="jxr_linenumber" name="L520" href="#L520">520</a>
-<a class="jxr_linenumber" name="L521" href="#L521">521</a> <a
name="CheckstyleReportRenderer"
href="../../../../../org/apache/maven/plugins/checkstyle/CheckstyleReportRenderer.html#CheckstyleReportRenderer">CheckstyleReportRenderer</a>
r = <strong class="jxr_keyword">new</strong> <a
name="CheckstyleReportRenderer"
href="../../../../../org/apache/maven/plugins/checkstyle/CheckstyleReportRenderer.html#CheckstyleReportRenderer">CheckstyleReportRenderer</a>(
-<a class="jxr_linenumber" name="L522" href="#L522">522</a>
getSink(),
-<a class="jxr_linenumber" name="L523" href="#L523">523</a>
i18n,
-<a class="jxr_linenumber" name="L524" href="#L524">524</a>
locale,
-<a class="jxr_linenumber" name="L525" href="#L525">525</a>
project,
-<a class="jxr_linenumber" name="L526" href="#L526">526</a>
siteTool,
-<a class="jxr_linenumber" name="L527" href="#L527">527</a>
effectiveConfigLocation,
-<a class="jxr_linenumber" name="L528" href="#L528">528</a>
enableRulesSummary,
-<a class="jxr_linenumber" name="L529" href="#L529">529</a>
enableSeveritySummary,
-<a class="jxr_linenumber" name="L530" href="#L530">530</a>
enableFilesSummary,
-<a class="jxr_linenumber" name="L531" href="#L531">531</a>
results);
-<a class="jxr_linenumber" name="L532" href="#L532">532</a> <strong
class="jxr_keyword">if</strong> (linkXRef) {
-<a class="jxr_linenumber" name="L533" href="#L533">533</a>
initializeXrefLocation(r);
-<a class="jxr_linenumber" name="L534" href="#L534">534</a>
<strong class="jxr_keyword">if</strong> (r.getXrefLocation() == <strong
class="jxr_keyword">null</strong> && results.getFileCount() > 0) {
-<a class="jxr_linenumber" name="L535" href="#L535">535</a>
getLog().warn(<span class="jxr_string">"Unable to locate Source XRef to link to
- DISABLED"</span>);
-<a class="jxr_linenumber" name="L536" href="#L536">536</a> }
-<a class="jxr_linenumber" name="L537" href="#L537">537</a>
-<a class="jxr_linenumber" name="L538" href="#L538">538</a>
initializeXrefTestLocation(r);
-<a class="jxr_linenumber" name="L539" href="#L539">539</a>
<strong class="jxr_keyword">if</strong> (r.getXrefTestLocation() == <strong
class="jxr_keyword">null</strong> && results.getFileCount() > 0) {
-<a class="jxr_linenumber" name="L540" href="#L540">540</a>
getLog().warn(<span class="jxr_string">"Unable to locate Test Source XRef to
link to - DISABLED"</span>);
-<a class="jxr_linenumber" name="L541" href="#L541">541</a> }
-<a class="jxr_linenumber" name="L542" href="#L542">542</a>
-<a class="jxr_linenumber" name="L543" href="#L543">543</a>
r.setTestSourceDirectories(getTestSourceDirectories());
-<a class="jxr_linenumber" name="L544" href="#L544">544</a> }
-<a class="jxr_linenumber" name="L545" href="#L545">545</a> <strong
class="jxr_keyword">if</strong> (treeWalkerNames != <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L546" href="#L546">546</a>
r.setTreeWalkerNames(treeWalkerNames);
-<a class="jxr_linenumber" name="L547" href="#L547">547</a> }
-<a class="jxr_linenumber" name="L548" href="#L548">548</a>
r.render();
-<a class="jxr_linenumber" name="L549" href="#L549">549</a> } <strong
class="jxr_keyword">catch</strong> (CheckstyleException e) {
-<a class="jxr_linenumber" name="L550" href="#L550">550</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
MavenReportException(<span class="jxr_string">"Failed during checkstyle
configuration"</span>, e);
-<a class="jxr_linenumber" name="L551" href="#L551">551</a> } <strong
class="jxr_keyword">catch</strong> (<a name="CheckstyleExecutorException"
href="../../../../../org/apache/maven/plugins/checkstyle/exec/CheckstyleExecutorException.html#CheckstyleExecutorException">CheckstyleExecutorException</a>
e) {
-<a class="jxr_linenumber" name="L552" href="#L552">552</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
MavenReportException(<span class="jxr_string">"Failed during checkstyle
execution"</span>, e);
-<a class="jxr_linenumber" name="L553" href="#L553">553</a> } <strong
class="jxr_keyword">finally</strong> {
-<a class="jxr_linenumber" name="L554" href="#L554">554</a> <em
class="jxr_comment">// be sure to restore original context classloader</em>
-<a class="jxr_linenumber" name="L555" href="#L555">555</a>
Thread.currentThread().setContextClassLoader(currentClassLoader);
-<a class="jxr_linenumber" name="L556" href="#L556">556</a> }
-<a class="jxr_linenumber" name="L557" href="#L557">557</a> }
-<a class="jxr_linenumber" name="L558" href="#L558">558</a>
-<a class="jxr_linenumber" name="L559" href="#L559">559</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong>
checkDeprecatedParameterUsage(Object parameter, String name, String replacement)
-<a class="jxr_linenumber" name="L560" href="#L560">560</a> <strong
class="jxr_keyword">throws</strong> MavenReportException {
-<a class="jxr_linenumber" name="L561" href="#L561">561</a> <strong
class="jxr_keyword">if</strong> (parameter != <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L562" href="#L562">562</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
MavenReportException(<span class="jxr_string">"You are using '"</span> + name +
<span class="jxr_string">"' which has been removed"</span>
-<a class="jxr_linenumber" name="L563" href="#L563">563</a>
+ <span class="jxr_string">" from the maven-checkstyle-plugin. "</span> + <span
class="jxr_string">"Please use '"</span> + replacement
-<a class="jxr_linenumber" name="L564" href="#L564">564</a>
+ <span class="jxr_string">"' and refer to the >>Major Version Upgrade to
version 3.0.0<< "</span> + <span class="jxr_string">"on the plugin
site."</span>);
-<a class="jxr_linenumber" name="L565" href="#L565">565</a> }
-<a class="jxr_linenumber" name="L566" href="#L566">566</a> }
-<a class="jxr_linenumber" name="L567" href="#L567">567</a>
-<a class="jxr_linenumber" name="L568" href="#L568">568</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L569" href="#L569">569</a> <em
class="jxr_javadoccomment"> * Create the Checkstyle executor request.</em>
-<a class="jxr_linenumber" name="L570" href="#L570">570</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L571" href="#L571">571</a> <em
class="jxr_javadoccomment"> * @return The executor request.</em>
-<a class="jxr_linenumber" name="L572" href="#L572">572</a> <em
class="jxr_javadoccomment"> * @throws MavenReportException If something
goes wrong during creation.</em>
-<a class="jxr_linenumber" name="L573" href="#L573">573</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L574" href="#L574">574</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">abstract</strong> <a name="CheckstyleExecutorRequest"
href="../../../../../org/apache/maven/plugins/checkstyle/exec/CheckstyleExecutorRequest.html#CheckstyleExecutorRequest">CheckstyleExecutorRequest</a>
createRequest() <strong class="jxr_keyword">throws</strong>
MavenReportException;
-<a class="jxr_linenumber" name="L575" href="#L575">575</a>
-<a class="jxr_linenumber" name="L576" href="#L576">576</a> <strong
class="jxr_keyword">private</strong> List<Artifact>
collectArtifacts(String hint) {
-<a class="jxr_linenumber" name="L577" href="#L577">577</a>
List<Artifact> artifacts = <strong class="jxr_keyword">new</strong>
ArrayList<>();
-<a class="jxr_linenumber" name="L578" href="#L578">578</a>
-<a class="jxr_linenumber" name="L579" href="#L579">579</a>
PluginManagement pluginManagement = project.getBuild().getPluginManagement();
-<a class="jxr_linenumber" name="L580" href="#L580">580</a> <strong
class="jxr_keyword">if</strong> (pluginManagement != <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L581" href="#L581">581</a>
artifacts.addAll(getCheckstylePluginDependenciesAsArtifacts(pluginManagement.getPluginsAsMap(),
hint));
-<a class="jxr_linenumber" name="L582" href="#L582">582</a> }
-<a class="jxr_linenumber" name="L583" href="#L583">583</a>
-<a class="jxr_linenumber" name="L584" href="#L584">584</a>
artifacts.addAll(
-<a class="jxr_linenumber" name="L585" href="#L585">585</a>
getCheckstylePluginDependenciesAsArtifacts(project.getBuild().getPluginsAsMap(),
hint));
-<a class="jxr_linenumber" name="L586" href="#L586">586</a>
-<a class="jxr_linenumber" name="L587" href="#L587">587</a> <strong
class="jxr_keyword">return</strong> artifacts;
-<a class="jxr_linenumber" name="L588" href="#L588">588</a> }
-<a class="jxr_linenumber" name="L589" href="#L589">589</a>
-<a class="jxr_linenumber" name="L590" href="#L590">590</a> <strong
class="jxr_keyword">private</strong> List<Artifact>
getCheckstylePluginDependenciesAsArtifacts(Map<String, Plugin> plugins,
String hint) {
-<a class="jxr_linenumber" name="L591" href="#L591">591</a>
List<Artifact> artifacts = <strong class="jxr_keyword">new</strong>
ArrayList<>();
-<a class="jxr_linenumber" name="L592" href="#L592">592</a>
-<a class="jxr_linenumber" name="L593" href="#L593">593</a> Plugin
checkstylePlugin = plugins.get(plugin.getGroupId() + <span
class="jxr_string">":"</span> + plugin.getArtifactId());
-<a class="jxr_linenumber" name="L594" href="#L594">594</a> <strong
class="jxr_keyword">if</strong> (checkstylePlugin != <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L595" href="#L595">595</a> <strong
class="jxr_keyword">for</strong> (Dependency dep :
checkstylePlugin.getDependencies()) {
-<a class="jxr_linenumber" name="L596" href="#L596">596</a> <em
class="jxr_comment">// @todo if we can filter on hints, it should be done
here...</em>
-<a class="jxr_linenumber" name="L597" href="#L597">597</a>
String depKey = dep.getGroupId() + <span class="jxr_string">":"</span> +
dep.getArtifactId();
-<a class="jxr_linenumber" name="L598" href="#L598">598</a>
artifacts.add(plugin.getArtifactMap().get(depKey));
-<a class="jxr_linenumber" name="L599" href="#L599">599</a> }
-<a class="jxr_linenumber" name="L600" href="#L600">600</a> }
-<a class="jxr_linenumber" name="L601" href="#L601">601</a> <strong
class="jxr_keyword">return</strong> artifacts;
-<a class="jxr_linenumber" name="L602" href="#L602">602</a> }
-<a class="jxr_linenumber" name="L603" href="#L603">603</a>
-<a class="jxr_linenumber" name="L604" href="#L604">604</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L605" href="#L605">605</a> <em
class="jxr_javadoccomment"> * Creates and returns the report generation
listener.</em>
-<a class="jxr_linenumber" name="L606" href="#L606">606</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L607" href="#L607">607</a> <em
class="jxr_javadoccomment"> * @return The audit listener.</em>
-<a class="jxr_linenumber" name="L608" href="#L608">608</a> <em
class="jxr_javadoccomment"> * @throws MavenReportException If something
goes wrong.</em>
-<a class="jxr_linenumber" name="L609" href="#L609">609</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L610" href="#L610">610</a> <strong
class="jxr_keyword">protected</strong> AuditListener getListener() <strong
class="jxr_keyword">throws</strong> MavenReportException {
-<a class="jxr_linenumber" name="L611" href="#L611">611</a>
AuditListener listener = <strong class="jxr_keyword">null</strong>;
-<a class="jxr_linenumber" name="L612" href="#L612">612</a>
-<a class="jxr_linenumber" name="L613" href="#L613">613</a> <strong
class="jxr_keyword">if</strong> (outputFileFormat != <strong
class="jxr_keyword">null</strong> && !outputFileFormat.isEmpty()) {
-<a class="jxr_linenumber" name="L614" href="#L614">614</a> File
resultFile = outputFile;
-<a class="jxr_linenumber" name="L615" href="#L615">615</a>
-<a class="jxr_linenumber" name="L616" href="#L616">616</a>
OutputStream out = getOutputStream(resultFile);
-<a class="jxr_linenumber" name="L617" href="#L617">617</a>
-<a class="jxr_linenumber" name="L618" href="#L618">618</a> <strong
class="jxr_keyword">if</strong> (<span
class="jxr_string">"xml"</span>.equals(outputFileFormat)) {
-<a class="jxr_linenumber" name="L619" href="#L619">619</a>
listener = <strong class="jxr_keyword">new</strong> XMLLogger(out,
OutputStreamOptions.CLOSE);
-<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">"plain"</span>.equals(outputFileFormat)) {
-<a class="jxr_linenumber" name="L621" href="#L621">621</a>
listener = <strong class="jxr_keyword">new</strong> DefaultLogger(out,
OutputStreamOptions.CLOSE);
-<a class="jxr_linenumber" name="L622" href="#L622">622</a> }
<strong class="jxr_keyword">else</strong> {
-<a class="jxr_linenumber" name="L623" href="#L623">623</a> <em
class="jxr_comment">// TODO: failure if not a report</em>
-<a class="jxr_linenumber" name="L624" href="#L624">624</a>
<strong class="jxr_keyword">throw</strong> <strong
class="jxr_keyword">new</strong> MavenReportException(
-<a class="jxr_linenumber" name="L625" href="#L625">625</a>
<span class="jxr_string">"Invalid output file format: ("</span> +
outputFileFormat + <span class="jxr_string">"). Must be 'plain' or
'xml'."</span>);
-<a class="jxr_linenumber" name="L626" href="#L626">626</a> }
-<a class="jxr_linenumber" name="L627" href="#L627">627</a> }
-<a class="jxr_linenumber" name="L628" href="#L628">628</a>
-<a class="jxr_linenumber" name="L629" href="#L629">629</a> <strong
class="jxr_keyword">return</strong> listener;
-<a class="jxr_linenumber" name="L630" href="#L630">630</a> }
-<a class="jxr_linenumber" name="L631" href="#L631">631</a>
-<a class="jxr_linenumber" name="L632" href="#L632">632</a> <strong
class="jxr_keyword">private</strong> OutputStream getOutputStream(File file)
<strong class="jxr_keyword">throws</strong> MavenReportException {
-<a class="jxr_linenumber" name="L633" href="#L633">633</a> File
parentFile = file.getAbsoluteFile().getParentFile();
-<a class="jxr_linenumber" name="L634" href="#L634">634</a>
-<a class="jxr_linenumber" name="L635" href="#L635">635</a> <strong
class="jxr_keyword">if</strong> (!parentFile.exists()) {
-<a class="jxr_linenumber" name="L636" href="#L636">636</a>
parentFile.mkdirs();
-<a class="jxr_linenumber" name="L637" href="#L637">637</a> }
+<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong
class="jxr_keyword">public</strong> <strong
class="jxr_keyword">abstract</strong> <strong
class="jxr_keyword">class</strong> <a name="AbstractCheckstyleReport"
href="../../../../../org/apache/maven/plugins/checkstyle/AbstractCheckstyleReport.html#AbstractCheckstyleReport">AbstractCheckstyleReport</a>
<strong class="jxr_keyword">extends</strong> AbstractMavenReport {
+<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong
class="jxr_keyword">protected</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="L69" href="#L69">69</a>
+<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong>
String DEFAULT_CONFIG_LOCATION = <span
class="jxr_string">"sun_checks.xml"</span>;
+<a class="jxr_linenumber" name="L71" href="#L71">71</a>
+<a class="jxr_linenumber" name="L72" href="#L72">72</a>
@Parameter(defaultValue = <span class="jxr_string">"${session}"</span>,
readonly = <strong class="jxr_keyword">true</strong>, required = <strong
class="jxr_keyword">true</strong>)
+<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong
class="jxr_keyword">private</strong> MavenSession session;
+<a class="jxr_linenumber" name="L74" href="#L74">74</a>
+<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> <em
class="jxr_javadoccomment"> * Specifies the cache file used to speed up
Checkstyle on successive runs.</em>
+<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L78" href="#L78">78</a>
@Parameter(defaultValue = <span
class="jxr_string">"${project.build.directory}/checkstyle-cachefile"</span>)
+<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong
class="jxr_keyword">protected</strong> String cacheFile;
+<a class="jxr_linenumber" name="L80" href="#L80">80</a>
+<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em
class="jxr_javadoccomment"> * Specifies the location of the XML
configuration to use.</em>
+<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em
class="jxr_javadoccomment"> * Potential values are a filesystem path, a
URL, or a classpath resource.</em>
+<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em
class="jxr_javadoccomment"> * This parameter expects that the contents of
the location conform to the</em>
+<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em
class="jxr_javadoccomment"> * xml format (Checkstyle <a</em>
+<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em
class="jxr_javadoccomment"> * href="<a
href="https://checkstyle.org/config.html";
target="alexandria_uri">https://checkstyle.org/config.html</a>#Modules">Checker</em>
+<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em
class="jxr_javadoccomment"> * module</a>) configuration of
rulesets.</em>
+<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em
class="jxr_javadoccomment"> * This parameter is resolved as resource, URL,
then file. If successfully</em>
+<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em
class="jxr_javadoccomment"> * resolved, the contents of the configuration
is copied into the</em>
+<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em
class="jxr_javadoccomment"> *
<code>${project.build.directory}/checkstyle-configuration.xml</code></em>
+<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em
class="jxr_javadoccomment"> * file before being passed to Checkstyle as a
configuration.</em>
[... 774 lines stripped ...]
