Modified: websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST/xref/org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST/xref/org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.html (original) +++ websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-LATEST/xref/org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.html Tue Jan 27 00:57:50 2015 @@ -74,708 +74,705 @@ <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> <em class="jxr_javadoccomment"> * Base abstract class for Checkstyle reports.</em> <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"> * @version $Id: AbstractCheckstyleReport.java 1624793 2014-09-13 23:38:16Z hboutemy $</em> -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * @since 2.8</em> -<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.html">AbstractCheckstyleReport</a> -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">extends</strong> AbstractMavenReport -<a class="jxr_linenumber" name="L74" href="#L74">74</a> { -<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PLUGIN_RESOURCES = <span class="jxr_string">"org/apache/maven/plugin/checkstyle"</span>; -<a class="jxr_linenumber" name="L76" href="#L76">76</a> -<a class="jxr_linenumber" name="L77" href="#L77">77</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="L78" href="#L78">78</a> -<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * Specifies the cache file used to speed up Checkstyle on successive runs.</em> -<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> @Parameter( defaultValue = <span class="jxr_string">"${project.build.directory}/checkstyle-cachefile"</span> ) -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">protected</strong> String cacheFile; -<a class="jxr_linenumber" name="L84" href="#L84">84</a> -<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * Specifies the location of the XML configuration to use.</em> -<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * </p></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"> * <p></em> -<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * Potential values are a filesystem path, a URL, or a classpath resource.</em> -<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * This parameter expects that the contents of the location conform to the</em> -<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * xml format (Checkstyle <a</em> -<a class="jxr_linenumber" name="L94" href="#L94">94</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="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * module</a>) configuration of rulesets.</em> -<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * <p/></em> -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * This parameter is resolved as resource, URL, then file. If successfully</em> -<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * resolved, the contents of the configuration is copied into the</em> -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * <code>${project.build.directory}/checkstyle-configuration.xml</code></em> -<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * file before being passed to Checkstyle as a configuration.</em> -<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * <p/></em> -<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * There are 4 predefined rulesets.</em> -<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * <p/></em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * <ul></em> -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * <li><code>config/sun_checks.xml</code>: Sun Checks.</li></em> -<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * <li><code>config/turbine_checks.xml</code>: Turbine Checks.</li></em> -<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * <li><code>config/avalon_checks.xml</code>: Avalon Checks.</li></em> -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * <li><code>config/maven_checks.xml</code>: Maven Source Checks.</li></em> -<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * </ul></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> @Parameter( property = <span class="jxr_string">"checkstyle.config.location"</span>, defaultValue = <span class="jxr_string">"config/sun_checks.xml"</span> ) -<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">protected</strong> String configLocation; -<a class="jxr_linenumber" name="L118" href="#L118">118</a> -<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * Output errors to console.</em> -<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> @Parameter( property = <span class="jxr_string">"checkstyle.consoleOutput"</span>, defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> consoleOutput; -<a class="jxr_linenumber" name="L124" href="#L124">124</a> -<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"> * The file encoding to use when reading the source files. If the property <code>project.build.sourceEncoding</code></em> -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * is not set, the platform default encoding is used. <strong>Note:</strong> This parameter always overrides the</em> -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * property <code>charset</code> from Checkstyle's <code>TreeWalker</code> module.</em> -<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * @since 2.2</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> @Parameter( property = <span class="jxr_string">"encoding"</span>, defaultValue = <span class="jxr_string">"${project.build.sourceEncoding}"</span> ) -<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">protected</strong> String encoding; -<a class="jxr_linenumber" name="L134" href="#L134">134</a> -<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> <em class="jxr_javadoccomment"> * Specifies if the build should fail upon a violation.</em> -<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> @Parameter( defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> failsOnError; -<a class="jxr_linenumber" name="L140" href="#L140">140</a> -<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"> * <p></em> -<a class="jxr_linenumber" name="L143" href="#L143">143</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="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * can be used by Checkstyle to verify that source code has the correct</em> -<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * license header.</em> -<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * You need to use ${checkstyle.header.file} in your Checkstyle xml</em> -<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * configuration to reference the name of this header file.</em> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * @version $Id: AbstractCheckstyleReport.java 1653380 2015-01-20 21:51:36Z hboutemy $</em> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugin/checkstyle/AbstractCheckstyleReport.html">AbstractCheckstyleReport</a> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">extends</strong> AbstractMavenReport +<a class="jxr_linenumber" name="L73" href="#L73">73</a> { +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PLUGIN_RESOURCES = <span class="jxr_string">"org/apache/maven/plugin/checkstyle"</span>; +<a class="jxr_linenumber" name="L75" href="#L75">75</a> +<a class="jxr_linenumber" name="L76" href="#L76">76</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="L77" href="#L77">77</a> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * Specifies the cache file used to speed up Checkstyle on successive runs.</em> +<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> @Parameter( defaultValue = <span class="jxr_string">"${project.build.directory}/checkstyle-cachefile"</span> ) +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">protected</strong> String cacheFile; +<a class="jxr_linenumber" name="L83" href="#L83">83</a> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * Specifies the location of the XML configuration to use.</em> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * <p/></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"> * Potential values are a filesystem path, a URL, or a classpath resource.</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * This parameter expects that the contents of the location conform to the</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * xml format (Checkstyle <a</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</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="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * module</a>) configuration of rulesets.</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * <p/></em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * This parameter is resolved as resource, URL, then file. If successfully</em> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * resolved, the contents of the configuration is copied into the</em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * <code>${project.build.directory}/checkstyle-configuration.xml</code></em> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * file before being passed to Checkstyle as a configuration.</em> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * <p/></em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * There are 3 predefined rulesets included in Maven Checkstyle Plugin:</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * <li><code>config/sun_checks.xml</code>: Sun Checks.</li></em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * <li><code>config/turbine_checks.xml</code>: Turbine Checks.</li></em> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * <li><code>config/maven_checks.xml</code>: Maven Source Checks.</li></em> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * </ul></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( property = <span class="jxr_string">"checkstyle.config.location"</span>, defaultValue = <span class="jxr_string">"config/sun_checks.xml"</span> ) +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">protected</strong> String configLocation; +<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"> * Output errors to console.</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.consoleOutput"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> consoleOutput; +<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 file encoding to use when reading the source files. If the property <code>project.build.sourceEncoding</code></em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * is not set, the platform default encoding is used. <strong>Note:</strong> This parameter always overrides the</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * property <code>charset</code> from Checkstyle's <code>TreeWalker</code> module.</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> <em class="jxr_javadoccomment"> * @since 2.2</em> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> @Parameter( property = <span class="jxr_string">"encoding"</span>, defaultValue = <span class="jxr_string">"${project.build.sourceEncoding}"</span> ) +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">protected</strong> String encoding; +<a class="jxr_linenumber" name="L131" href="#L131">131</a> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * Specifies if the build should fail upon a violation.</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> @Parameter( defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> failsOnError; +<a class="jxr_linenumber" name="L137" href="#L137">137</a> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L140" href="#L140">140</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="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * can be used by Checkstyle to verify that source code has the correct</em> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * license header.</em> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * You need to use ${checkstyle.header.file} in your Checkstyle xml</em> +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * configuration to reference the name of this header file.</em> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * For instance:</em> <a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * </p></em> <a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * For instance:</em> -<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * </p></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"> * <code></em> -<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * &lt;module name="RegexpHeader"></em> -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * &lt;property name="headerFile" value="${checkstyle.header.file}"/></em> -<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * &lt;/module></em> -<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * </code></em> -<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * @since 2.0-beta-2</em> -<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> @Parameter( property = <span class="jxr_string">"checkstyle.header.file"</span>, defaultValue = <span class="jxr_string">"LICENSE.txt"</span> ) -<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">protected</strong> String headerLocation; -<a class="jxr_linenumber" name="L166" href="#L166">166</a> -<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> <em class="jxr_javadoccomment"> * Skip entire check.</em> -<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * @since 2.2</em> -<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> @Parameter( property = <span class="jxr_string">"checkstyle.skip"</span>, defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> skip; -<a class="jxr_linenumber" name="L174" href="#L174">174</a> -<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * Specifies the path and filename to save the Checkstyle output. The format</em> -<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * of the output file is determined by the <code>outputFileFormat</code></em> -<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * parameter.</em> -<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L180" href="#L180">180</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="L181" href="#L181">181</a> <strong class="jxr_keyword">private</strong> File outputFile; -<a class="jxr_linenumber" name="L182" href="#L182">182</a> -<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment">/**</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"> * Specifies the location of the properties file.</em> -<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * <p/></em> -<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * This parameter is resolved as URL, File then resource. If successfully</em> -<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * resolved, the contents of the properties location is copied into the</em> -<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> * <code>${project.build.directory}/checkstyle-checker.properties</code></em> -<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * file before being passed to Checkstyle for loading.</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"> * <p></em> -<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * The contents of the <code>propertiesLocation</code> will be made</em> -<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * available to Checkstyle for specifying values for parameters within the</em> -<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * xml configuration (specified in the <code>configLocation</code></em> -<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * parameter).</em> -<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * @since 2.0-beta-2</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.properties.location"</span> ) -<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">protected</strong> String propertiesLocation; -<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"> * Allows for specifying raw property expansion information.</em> -<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L210" href="#L210">210</a> @Parameter -<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">protected</strong> String propertyExpansion; -<a class="jxr_linenumber" name="L212" href="#L212">212</a> -<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * Specifies the location of the resources to be used for Checkstyle.</em> -<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * @since 2.10</em> -<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L218" href="#L218">218</a> @Parameter( defaultValue = <span class="jxr_string">"${project.resources}"</span>, readonly = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">protected</strong> List<Resource> resources; -<a class="jxr_linenumber" name="L220" href="#L220">220</a> -<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> * Specifies the location of the test resources to be used for Checkstyle.</em> -<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> *</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( defaultValue = <span class="jxr_string">"${project.testResources}"</span>, readonly = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">protected</strong> List<Resource> testResources; -<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 the names filter of the source files to be used for Checkstyle.</em> -<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L232" href="#L232">232</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="L233" href="#L233">233</a> <strong class="jxr_keyword">protected</strong> String includes; -<a class="jxr_linenumber" name="L234" href="#L234">234</a> -<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> * Specifies the names filter of the source files to be excluded for</em> -<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment"> * 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> @Parameter( property = <span class="jxr_string">"checkstyle.excludes"</span> ) -<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">protected</strong> String excludes; -<a class="jxr_linenumber" name="L241" href="#L241">241</a> -<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment"> * Specifies the names filter of the resource files to be used for Checkstyle.</em> -<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> * @since 2.11</em> -<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L246" href="#L246">246</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="L247" href="#L247">247</a> <strong class="jxr_keyword">protected</strong> String resourceIncludes; -<a class="jxr_linenumber" name="L248" href="#L248">248</a> -<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> * Specifies the names filter of the resource files to be excluded for</em> -<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> * Checkstyle.</em> -<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> * @since 2.11</em> -<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L254" href="#L254">254</a> @Parameter( property = <span class="jxr_string">"checkstyle.resourceExcludes"</span> ) -<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">protected</strong> String resourceExcludes; -<a class="jxr_linenumber" name="L256" href="#L256">256</a> -<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"> * Specifies whether to include the resource directories in the check.</em> -<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> * @since 2.11</em> -<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L261" href="#L261">261</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="L262" href="#L262">262</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> includeResources; -<a class="jxr_linenumber" name="L263" href="#L263">263</a> -<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> * Specifies whether to include the test resource directories in the check.</em> -<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> * @since 2.11</em> -<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L268" href="#L268">268</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="L269" href="#L269">269</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> includeTestResources; -<a class="jxr_linenumber" name="L270" href="#L270">270</a> -<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> * Specifies the location of the source directory to be used for Checkstyle.</em> -<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment"> * </em> -<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> * @deprecated instead use {@link #sourceDirectories}</em> -<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> @Deprecated -<a class="jxr_linenumber" name="L277" href="#L277">277</a> @Parameter -<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">private</strong> File sourceDirectory; -<a class="jxr_linenumber" name="L279" href="#L279">279</a> -<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_javadoccomment"> * Specifies the location of the source directories to be used for Checkstyle.</em> -<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment"> * @since 2.13</em> -<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> @Parameter( defaultValue = <span class="jxr_string">"${project.compileSourceRoots}"</span> ) -<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">private</strong> List<String> sourceDirectories; -<a class="jxr_linenumber" name="L286" href="#L286">286</a> -<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> <em class="jxr_javadoccomment"> * Specifies the location of the test source directory to be used for</em> -<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> * Checkstyle.</em> -<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> * @since 2.2</em> -<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment"> * @deprecated instead use {@link #testSourceDirectories}</em> -<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L294" href="#L294">294</a> @Parameter -<a class="jxr_linenumber" name="L295" href="#L295">295</a> @Deprecated -<a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong class="jxr_keyword">private</strong> File testSourceDirectory; -<a class="jxr_linenumber" name="L297" href="#L297">297</a> -<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment"> * Specifies the location of the test source directories to be used for Checkstyle.</em> -<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> * @since 2.13</em> -<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L302" href="#L302">302</a> @Parameter( defaultValue = <span class="jxr_string">"${project.testCompileSourceRoots}"</span> ) -<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">private</strong> List<String> testSourceDirectories; -<a class="jxr_linenumber" name="L304" href="#L304">304</a> -<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_javadoccomment"> * Include or not the test source directory/directories to be used for Checkstyle.</em> -<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment"> * @since 2.2</em> -<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L310" href="#L310">310</a> @Parameter( defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L311" href="#L311">311</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> includeTestSourceDirectory; -<a class="jxr_linenumber" name="L312" href="#L312">312</a> -<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment"> * The key to be used in the properties for the suppressions file.</em> -<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"> * @since 2.1</em> -<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L318" href="#L318">318</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="L319" href="#L319">319</a> <strong class="jxr_keyword">protected</strong> String suppressionsFileExpression; -<a class="jxr_linenumber" name="L320" href="#L320">320</a> -<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment"> * Specifies the location of the suppressions XML file to use.</em> -<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment"> * <p/></em> -<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> * This parameter is resolved as resource, URL, then file. If successfully</em> -<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> * resolved, the contents of the suppressions XML is copied into the</em> -<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> * <code>${project.build.directory}/checkstyle-supressions.xml</code> file</em> -<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * before being passed to Checkstyle for loading.</em> -<a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> * <p/></em> -<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> * See <code>suppressionsFileExpression</code> for the property that will</em> -<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> * be made available to your Checkstyle configuration.</em> -<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_javadoccomment"> * @since 2.0-beta-2</em> -<a class="jxr_linenumber" name="L339" href="#L339">339</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L340" href="#L340">340</a> @Parameter( property = <span class="jxr_string">"checkstyle.suppressions.location"</span> ) -<a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong class="jxr_keyword">protected</strong> String suppressionsLocation; -<a class="jxr_linenumber" name="L342" href="#L342">342</a> -<a class="jxr_linenumber" name="L343" href="#L343">343</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_javadoccomment"> * If <code>null</code>, the Checkstyle plugin will display violations on stdout.</em> -<a class="jxr_linenumber" name="L345" href="#L345">345</a> <em class="jxr_javadoccomment"> * Otherwise, a text file will be created with the violations.</em> -<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> @Parameter -<a class="jxr_linenumber" name="L348" href="#L348">348</a> <strong class="jxr_keyword">private</strong> File useFile; -<a class="jxr_linenumber" name="L349" href="#L349">349</a> -<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L351" href="#L351">351</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="L352" href="#L352">352</a> <em class="jxr_javadoccomment"> * file. Valid values are "<code>plain</code>" and "<code>xml</code>".</em> -<a class="jxr_linenumber" name="L353" href="#L353">353</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L354" href="#L354">354</a> @Parameter( property = <span class="jxr_string">"checkstyle.output.format"</span>, defaultValue = <span class="jxr_string">"xml"</span> ) -<a class="jxr_linenumber" name="L355" href="#L355">355</a> <strong class="jxr_keyword">private</strong> String outputFileFormat; -<a class="jxr_linenumber" name="L356" href="#L356">356</a> -<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> <em class="jxr_javadoccomment"> * Specifies if the Rules summary should be enabled or not.</em> -<a class="jxr_linenumber" name="L359" href="#L359">359</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L360" href="#L360">360</a> @Parameter( property = <span class="jxr_string">"checkstyle.enable.rules.summary"</span>, defaultValue = <span class="jxr_string">"true"</span> ) -<a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> enableRulesSummary; -<a class="jxr_linenumber" name="L362" href="#L362">362</a> -<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> <em class="jxr_javadoccomment"> * Specifies if the Severity summary should be enabled or not.</em> -<a class="jxr_linenumber" name="L365" href="#L365">365</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L366" href="#L366">366</a> @Parameter( property = <span class="jxr_string">"checkstyle.enable.severity.summary"</span>, defaultValue = <span class="jxr_string">"true"</span> ) -<a class="jxr_linenumber" name="L367" href="#L367">367</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> enableSeveritySummary; -<a class="jxr_linenumber" name="L368" href="#L368">368</a> -<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment"> * Specifies if the Files summary should be enabled or not.</em> -<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L372" href="#L372">372</a> @Parameter( property = <span class="jxr_string">"checkstyle.enable.files.summary"</span>, defaultValue = <span class="jxr_string">"true"</span> ) -<a class="jxr_linenumber" name="L373" href="#L373">373</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> enableFilesSummary; -<a class="jxr_linenumber" name="L374" href="#L374">374</a> -<a class="jxr_linenumber" name="L375" href="#L375">375</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L376" href="#L376">376</a> <em class="jxr_javadoccomment"> * Specifies if the RSS should be enabled or not.</em> -<a class="jxr_linenumber" name="L377" href="#L377">377</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L378" href="#L378">378</a> @Parameter( property = <span class="jxr_string">"checkstyle.enable.rss"</span>, defaultValue = <span class="jxr_string">"true"</span> ) -<a class="jxr_linenumber" name="L379" href="#L379">379</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> enableRSS; -<a class="jxr_linenumber" name="L380" href="#L380">380</a> -<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> <em class="jxr_javadoccomment"> * SiteTool.</em> -<a class="jxr_linenumber" name="L383" href="#L383">383</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L384" href="#L384">384</a> <em class="jxr_javadoccomment"> * @since 2.2</em> -<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> @Component( role = SiteTool.<strong class="jxr_keyword">class</strong> ) -<a class="jxr_linenumber" name="L387" href="#L387">387</a> <strong class="jxr_keyword">protected</strong> SiteTool siteTool; -<a class="jxr_linenumber" name="L388" href="#L388">388</a> -<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L390" href="#L390">390</a> <em class="jxr_javadoccomment"> * The Plugin Descriptor</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> @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="L393" href="#L393">393</a> <strong class="jxr_keyword">private</strong> PluginDescriptor plugin; -<a class="jxr_linenumber" name="L394" href="#L394">394</a> -<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_comment">// remove when requiring Maven 3.x, just use #plugin </em> -<a class="jxr_linenumber" name="L396" href="#L396">396</a> @Parameter( defaultValue = <span class="jxr_string">"${mojoExecution}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong class="jxr_keyword">private</strong> MojoExecution mojoExecution; -<a class="jxr_linenumber" name="L398" href="#L398">398</a> -<a class="jxr_linenumber" name="L399" href="#L399">399</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L400" href="#L400">400</a> <em class="jxr_javadoccomment"> * Link the violation line numbers to the source xref. Will link</em> -<a class="jxr_linenumber" name="L401" href="#L401">401</a> <em class="jxr_javadoccomment"> * automatically if Maven JXR plugin is being used.</em> -<a class="jxr_linenumber" name="L402" href="#L402">402</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L403" href="#L403">403</a> <em class="jxr_javadoccomment"> * @since 2.1</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> @Parameter( property = <span class="jxr_string">"linkXRef"</span>, defaultValue = <span class="jxr_string">"true"</span> ) -<a class="jxr_linenumber" name="L406" href="#L406">406</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> linkXRef; -<a class="jxr_linenumber" name="L407" href="#L407">407</a> -<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> <em class="jxr_javadoccomment"> * Location of the Xrefs to link to.</em> -<a class="jxr_linenumber" name="L410" href="#L410">410</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L411" href="#L411">411</a> @Parameter( defaultValue = <span class="jxr_string">"${project.reporting.outputDirectory}/xref"</span> ) -<a class="jxr_linenumber" name="L412" href="#L412">412</a> <strong class="jxr_keyword">private</strong> File xrefLocation; -<a class="jxr_linenumber" name="L413" href="#L413">413</a> -<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> <em class="jxr_javadoccomment"> * When using custom treeWalkers, specify their names here so the checks</em> -<a class="jxr_linenumber" name="L416" href="#L416">416</a> <em class="jxr_javadoccomment"> * inside the treeWalker end up the the rule-summary.</em> -<a class="jxr_linenumber" name="L417" href="#L417">417</a> <em class="jxr_javadoccomment"> * </em> -<a class="jxr_linenumber" name="L418" href="#L418">418</a> <em class="jxr_javadoccomment"> * @since 2.11</em> -<a class="jxr_linenumber" name="L419" href="#L419">419</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L420" href="#L420">420</a> @Parameter -<a class="jxr_linenumber" name="L421" href="#L421">421</a> <strong class="jxr_keyword">private</strong> List<String> treeWalkerNames; -<a class="jxr_linenumber" name="L422" href="#L422">422</a> -<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> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L425" href="#L425">425</a> @Component -<a class="jxr_linenumber" name="L426" href="#L426">426</a> <strong class="jxr_keyword">protected</strong> ResourceManager locator; -<a class="jxr_linenumber" name="L427" href="#L427">427</a> -<a class="jxr_linenumber" name="L428" href="#L428">428</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L429" href="#L429">429</a> <em class="jxr_javadoccomment"> * CheckstyleRssGenerator.</em> -<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"> * @since 2.4</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> @Component( role = CheckstyleRssGenerator.<strong class="jxr_keyword">class</strong>, hint = <span class="jxr_string">"default"</span> ) -<a class="jxr_linenumber" name="L434" href="#L434">434</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/maven/plugin/checkstyle/rss/CheckstyleRssGenerator.html">CheckstyleRssGenerator</a> checkstyleRssGenerator; -<a class="jxr_linenumber" name="L435" href="#L435">435</a> -<a class="jxr_linenumber" name="L436" href="#L436">436</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L437" href="#L437">437</a> <em class="jxr_javadoccomment"> * @since 2.5</em> -<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> @Component( role = CheckstyleExecutor.<strong class="jxr_keyword">class</strong>, hint = <span class="jxr_string">"default"</span> ) -<a class="jxr_linenumber" name="L440" href="#L440">440</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/maven/plugin/checkstyle/exec/CheckstyleExecutor.html">CheckstyleExecutor</a> checkstyleExecutor; -<a class="jxr_linenumber" name="L441" href="#L441">441</a> -<a class="jxr_linenumber" name="L442" href="#L442">442</a> <strong class="jxr_keyword">protected</strong> ByteArrayOutputStream stringOutputStream; -<a class="jxr_linenumber" name="L443" href="#L443">443</a> -<a class="jxr_linenumber" name="L444" href="#L444">444</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> -<a class="jxr_linenumber" name="L445" href="#L445">445</a> <strong class="jxr_keyword">public</strong> String getName( Locale locale ) -<a class="jxr_linenumber" name="L446" href="#L446">446</a> { -<a class="jxr_linenumber" name="L447" href="#L447">447</a> <strong class="jxr_keyword">return</strong> getBundle( locale ).getString( <span class="jxr_string">"report.checkstyle.name"</span> ); -<a class="jxr_linenumber" name="L448" href="#L448">448</a> } -<a class="jxr_linenumber" name="L449" href="#L449">449</a> -<a class="jxr_linenumber" name="L450" href="#L450">450</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> -<a class="jxr_linenumber" name="L451" href="#L451">451</a> <strong class="jxr_keyword">public</strong> String getDescription( Locale locale ) -<a class="jxr_linenumber" name="L452" href="#L452">452</a> { -<a class="jxr_linenumber" name="L453" href="#L453">453</a> <strong class="jxr_keyword">return</strong> getBundle( locale ).getString( <span class="jxr_string">"report.checkstyle.description"</span> ); -<a class="jxr_linenumber" name="L454" href="#L454">454</a> } -<a class="jxr_linenumber" name="L455" href="#L455">455</a> -<a class="jxr_linenumber" name="L456" href="#L456">456</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em> -<a class="jxr_linenumber" name="L457" href="#L457">457</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> executeReport( Locale locale ) -<a class="jxr_linenumber" name="L458" href="#L458">458</a> <strong class="jxr_keyword">throws</strong> MavenReportException -<a class="jxr_linenumber" name="L459" href="#L459">459</a> { -<a class="jxr_linenumber" name="L460" href="#L460">460</a> locator.addSearchPath( FileResourceLoader.ID, project.getFile().getParentFile().getAbsolutePath() ); -<a class="jxr_linenumber" name="L461" href="#L461">461</a> locator.addSearchPath( <span class="jxr_string">"url"</span>, <span class="jxr_string">""</span> ); -<a class="jxr_linenumber" name="L462" href="#L462">462</a> -<a class="jxr_linenumber" name="L463" href="#L463">463</a> locator.setOutputDirectory( <strong class="jxr_keyword">new</strong> File( project.getBuild().getDirectory() ) ); +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * <code></em> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * &lt;module name="RegexpHeader"></em> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * &lt;property name="headerFile" value="${checkstyle.header.file}"/></em> +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * &lt;/module></em> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * </code></em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * </p></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.0-beta-2</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.header.file"</span>, defaultValue = <span class="jxr_string">"LICENSE.txt"</span> ) +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">protected</strong> String headerLocation; +<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"> * Skip entire check.</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.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.skip"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> skip; +<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"> * Specifies the path and filename to save the Checkstyle output. The format</em> +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * of the output file is determined by the <code>outputFileFormat</code></em> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * parameter.</em> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L177" href="#L177">177</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="L178" href="#L178">178</a> <strong class="jxr_keyword">private</strong> File outputFile; +<a class="jxr_linenumber" name="L179" href="#L179">179</a> +<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"> * <p></em> +<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * Specifies the location of the properties file.</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 URL, File then resource. If successfully</em> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * resolved, the contents of the properties location is copied into the</em> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * <code>${project.build.directory}/checkstyle-checker.properties</code></em> +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * file before being passed to Checkstyle for loading.</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"> * The contents of the <code>propertiesLocation</code> will be made</em> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * available to Checkstyle for specifying values for parameters within the</em> +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> * xml configuration (specified in the <code>configLocation</code></em> +<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * parameter).</em> +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * @since 2.0-beta-2</em> +<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> @Parameter( property = <span class="jxr_string">"checkstyle.properties.location"</span> ) +<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">protected</strong> String propertiesLocation; +<a class="jxr_linenumber" name="L203" href="#L203">203</a> +<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> * Allows for specifying raw property expansion information.</em> +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L207" href="#L207">207</a> @Parameter +<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">protected</strong> String propertyExpansion; +<a class="jxr_linenumber" name="L209" href="#L209">209</a> +<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> <em class="jxr_javadoccomment"> * Specifies the location of the resources to be used for Checkstyle.</em> +<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * @since 2.10</em> +<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> @Parameter( defaultValue = <span class="jxr_string">"${project.resources}"</span>, readonly = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">protected</strong> List<Resource> resources; +<a class="jxr_linenumber" name="L217" href="#L217">217</a> +<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> <em class="jxr_javadoccomment"> * Specifies the location of the test resources to be used for Checkstyle.</em> +<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> * @since 2.11</em> +<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> @Parameter( defaultValue = <span class="jxr_string">"${project.testResources}"</span>, readonly = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">protected</strong> List<Resource> testResources; +<a class="jxr_linenumber" name="L225" href="#L225">225</a> +<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> * Specifies the names filter of the source files to be used for Checkstyle.</em> +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L229" href="#L229">229</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="L230" href="#L230">230</a> <strong class="jxr_keyword">protected</strong> String includes; +<a class="jxr_linenumber" name="L231" href="#L231">231</a> +<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> <em class="jxr_javadoccomment"> * Specifies the names filter of the source files to be excluded for</em> +<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> * Checkstyle.</em> +<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L236" href="#L236">236</a> @Parameter( property = <span class="jxr_string">"checkstyle.excludes"</span> ) +<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">protected</strong> String excludes; +<a class="jxr_linenumber" name="L238" href="#L238">238</a> +<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> * Specifies the names filter of the resource files to be used for Checkstyle.</em> +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> * @since 2.11</em> +<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L243" href="#L243">243</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="L244" href="#L244">244</a> <strong class="jxr_keyword">protected</strong> String resourceIncludes; +<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 names filter of the resource files to be excluded for</em> +<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> * Checkstyle.</em> +<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> * @since 2.11</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> @Parameter( property = <span class="jxr_string">"checkstyle.resourceExcludes"</span> ) +<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">protected</strong> String resourceExcludes; +<a class="jxr_linenumber" name="L253" href="#L253">253</a> +<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * Specifies whether to include the resource directories in the check.</em> +<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * @since 2.11</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> @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="L259" href="#L259">259</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> includeResources; +<a class="jxr_linenumber" name="L260" href="#L260">260</a> +<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> <em class="jxr_javadoccomment"> * Specifies whether to include the test resource directories in the check.</em> +<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> * @since 2.11</em> +<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L265" href="#L265">265</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="L266" href="#L266">266</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> includeTestResources; +<a class="jxr_linenumber" name="L267" href="#L267">267</a> +<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * Specifies the location of the source directory to be used for Checkstyle.</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_javadoccomment"> * @deprecated instead use {@link #sourceDirectories}</em> +<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L273" href="#L273">273</a> @Deprecated +<a class="jxr_linenumber" name="L274" href="#L274">274</a> @Parameter +<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">private</strong> File sourceDirectory; +<a class="jxr_linenumber" name="L276" href="#L276">276</a> +<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"> * Specifies the location of the source directories to be used for Checkstyle.</em> +<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> * @since 2.13</em> +<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L281" href="#L281">281</a> @Parameter( defaultValue = <span class="jxr_string">"${project.compileSourceRoots}"</span> ) +<a class="jxr_linenumber" name="L282" href="#L282">282</a> <strong class="jxr_keyword">private</strong> List<String> sourceDirectories; +<a class="jxr_linenumber" name="L283" href="#L283">283</a> +<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> * Specifies the location of the test source directory to be used for</em> +<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> * Checkstyle.</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> <em class="jxr_javadoccomment"> * @since 2.2</em> +<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> * @deprecated instead use {@link #testSourceDirectories}</em> +<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L291" href="#L291">291</a> @Parameter +<a class="jxr_linenumber" name="L292" href="#L292">292</a> @Deprecated +<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">private</strong> File testSourceDirectory; +<a class="jxr_linenumber" name="L294" href="#L294">294</a> +<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment"> * Specifies the location of the test source directories to be used for Checkstyle.</em> +<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> * @since 2.13</em> +<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L299" href="#L299">299</a> @Parameter( defaultValue = <span class="jxr_string">"${project.testCompileSourceRoots}"</span> ) +<a class="jxr_linenumber" name="L300" href="#L300">300</a> <strong class="jxr_keyword">private</strong> List<String> testSourceDirectories; +<a class="jxr_linenumber" name="L301" href="#L301">301</a> +<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"> * Include or not the test source directory/directories to be used for Checkstyle.</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> <em class="jxr_javadoccomment"> * @since 2.2</em> +<a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L307" href="#L307">307</a> @Parameter( defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> includeTestSourceDirectory; +<a class="jxr_linenumber" name="L309" href="#L309">309</a> +<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment"> * The key to be used in the properties for the suppressions file.</em> +<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em class="jxr_javadoccomment"> * @since 2.1</em> +<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L315" href="#L315">315</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="L316" href="#L316">316</a> <strong class="jxr_keyword">protected</strong> String suppressionsFileExpression; +<a class="jxr_linenumber" name="L317" href="#L317">317</a> +<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> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> * Specifies the location of the suppressions XML file to use.</em> +<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> * <p/></em> +<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_javadoccomment"> * This parameter is resolved as resource, URL, then file. If successfully</em> +<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment"> * resolved, the contents of the suppressions XML is copied into the</em> +<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment"> * <code>${project.build.directory}/checkstyle-supressions.xml</code> file</em> +<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> * before being passed to Checkstyle for loading.</em> +<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> * </p></em> +<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> * <p/></em> +<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> * See <code>suppressionsFileExpression</code> for the property that will</em> +<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> * be made available to your Checkstyle configuration.</em> +<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> * </p></em> +<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"> * @since 2.0-beta-2</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.suppressions.location"</span> ) +<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong class="jxr_keyword">protected</strong> String suppressionsLocation; +<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"> * If <code>null</code>, the Checkstyle plugin will display violations on stdout.</em> +<a class="jxr_linenumber" name="L342" href="#L342">342</a> <em class="jxr_javadoccomment"> * Otherwise, a text file will be created with the violations.</em> +<a class="jxr_linenumber" name="L343" href="#L343">343</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L344" href="#L344">344</a> @Parameter +<a class="jxr_linenumber" name="L345" href="#L345">345</a> <strong class="jxr_keyword">private</strong> File useFile; +<a class="jxr_linenumber" name="L346" href="#L346">346</a> +<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L348" href="#L348">348</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="L349" href="#L349">349</a> <em class="jxr_javadoccomment"> * file. Valid values are "<code>plain</code>" and "<code>xml</code>".</em> +<a class="jxr_linenumber" name="L350" href="#L350">350</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L351" href="#L351">351</a> @Parameter( property = <span class="jxr_string">"checkstyle.output.format"</span>, defaultValue = <span class="jxr_string">"xml"</span> ) +<a class="jxr_linenumber" name="L352" href="#L352">352</a> <strong class="jxr_keyword">private</strong> String outputFileFormat; +<a class="jxr_linenumber" name="L353" href="#L353">353</a> +<a class="jxr_linenumber" name="L354" href="#L354">354</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L355" href="#L355">355</a> <em class="jxr_javadoccomment"> * Specifies if the Rules summary should be enabled or not.</em> +<a class="jxr_linenumber" name="L356" href="#L356">356</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L357" href="#L357">357</a> @Parameter( property = <span class="jxr_string">"checkstyle.enable.rules.summary"</span>, defaultValue = <span class="jxr_string">"true"</span> ) +<a class="jxr_linenumber" name="L358" href="#L358">358</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> enableRulesSummary; +<a class="jxr_linenumber" name="L359" href="#L359">359</a> +<a class="jxr_linenumber" name="L360" href="#L360">360</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L361" href="#L361">361</a> <em class="jxr_javadoccomment"> * Specifies if the Severity summary should be enabled or not.</em>
[... 712 lines stripped ...]