Modified: maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/PmdReport.html ============================================================================== --- maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/PmdReport.html (original) +++ maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugins/pmd/PmdReport.html Sat Jan 25 10:56:40 2020 @@ -101,771 +101,814 @@ <a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html">AbstractPmdReport</a> <a class="jxr_linenumber" name="L94" href="#L94">94</a> { <a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * The target JDK to analyze based on. Should match the source used in the compiler plugin. Valid values are</em> -<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * currently <code>1.3</code>, <code>1.4</code>, <code>1.5</code>, <code>1.6</code>, <code>1.7</code>,</em> -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * <code>1.8</code>, <code>9</code>, <code>10</code>, <code>11</code>, and <code>12</code>.</em> -<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * <b>Note:</b> this parameter is only used if the language parameter is set to <code>java</code>.</em> -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * </p></em> -<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L103" href="#L103">103</a> @Parameter( property = <span class="jxr_string">"targetJdk"</span>, defaultValue = <span class="jxr_string">"${maven.compiler.source}"</span> ) -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">private</strong> String targetJdk; -<a class="jxr_linenumber" name="L105" href="#L105">105</a> -<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> <em class="jxr_javadoccomment"> * The programming language to be analyzed by PMD. Valid values are currently <code>java</code>,</em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * <code>javascript</code> and <code>jsp</code>.</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * @since 3.0</em> -<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L112" href="#L112">112</a> @Parameter( defaultValue = <span class="jxr_string">"java"</span> ) -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">private</strong> String language; -<a class="jxr_linenumber" name="L114" href="#L114">114</a> -<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * The rule priority threshold; rules with lower priority than this will not be evaluated.</em> -<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * @since 2.1</em> -<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> @Parameter( property = <span class="jxr_string">"minimumPriority"</span>, defaultValue = <span class="jxr_string">"5"</span> ) -<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> minimumPriority = 5; -<a class="jxr_linenumber" name="L122" href="#L122">122</a> -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> * Skip the PMD report generation. Most useful on the command line via "-Dpmd.skip=true".</em> -<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * @since 2.1</em> -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L128" href="#L128">128</a> @Parameter( property = <span class="jxr_string">"pmd.skip"</span>, defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip; -<a class="jxr_linenumber" name="L130" href="#L130">130</a> -<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * The PMD rulesets to use. See the</em> -<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * <a href="https://pmd.github.io/latest/pmd_rules_java.html">Stock Java Rulesets</a> for a</em> -<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * list of available rules.</em> -<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * Defaults to a custom ruleset provided by this maven plugin</em> -<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * (<code>/rulesets/java/maven-pmd-plugin-default.xml</code>).</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 -<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">private</strong> String[] rulesets = <strong class="jxr_keyword">new</strong> String[] { <span class="jxr_string">"/rulesets/java/maven-pmd-plugin-default.xml"</span> }; -<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"> * Controls whether the project's compile/test classpath should be passed to PMD to enable its type resolution</em> -<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * feature.</em> -<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * @since 3.0</em> -<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L147" href="#L147">147</a> @Parameter( property = <span class="jxr_string">"pmd.typeResolution"</span>, defaultValue = <span class="jxr_string">"true"</span> ) -<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> typeResolution; -<a class="jxr_linenumber" name="L149" href="#L149">149</a> -<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> * Controls whether PMD will track benchmark information.</em> -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * @since 3.1</em> -<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L155" href="#L155">155</a> @Parameter( property = <span class="jxr_string">"pmd.benchmark"</span>, defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> benchmark; -<a class="jxr_linenumber" name="L157" href="#L157">157</a> -<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"> * Benchmark output filename.</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> <em class="jxr_javadoccomment"> * @since 3.1</em> -<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L163" href="#L163">163</a> @Parameter( property = <span class="jxr_string">"pmd.benchmarkOutputFilename"</span>, -<a class="jxr_linenumber" name="L164" href="#L164">164</a> defaultValue = <span class="jxr_string">"${project.build.directory}/pmd-benchmark.txt"</span> ) -<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">private</strong> String benchmarkOutputFilename; -<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"> * Source level marker used to indicate whether a RuleViolation should be suppressed. If it is not set, PMD's</em> -<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * default will be used, which is <code>NOPMD</code>. See also <a</em> -<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * href="https://pmd.github.io/latest/pmd_userdocs_suppressing_warnings.html">PMD &#x2013; Suppressing warnings</a>.</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> <em class="jxr_javadoccomment"> * @since 3.4</em> -<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L174" href="#L174">174</a> @Parameter( property = <span class="jxr_string">"pmd.suppressMarker"</span> ) -<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">private</strong> String suppressMarker; -<a class="jxr_linenumber" name="L176" href="#L176">176</a> -<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * The target JDK to analyze based on. Should match the source used in the compiler plugin. Valid values</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * with the default PMD version are</em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * currently <code>1.3</code>, <code>1.4</code>, <code>1.5</code>, <code>1.6</code>, <code>1.7</code>,</em> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * <code>1.8</code>, <code>9</code>, <code>10</code>, <code>11</code>, <code>12</code>, and <code>13</code>.</em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * <p> You can override the default PMD version by specifying PMD as a dependency,</em> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * see <a href="examples/upgrading-PMD-at-runtime.html">Upgrading PMD at Runtime</a>.</p></em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * <b>Note:</b> this parameter is only used if the language parameter is set to <code>java</code>.</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"> */</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> @Parameter( property = <span class="jxr_string">"targetJdk"</span>, defaultValue = <span class="jxr_string">"${maven.compiler.source}"</span> ) +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">private</strong> String targetJdk; +<a class="jxr_linenumber" name="L110" href="#L110">110</a> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * The programming language to be analyzed by PMD. Valid values are currently <code>java</code>,</em> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * <code>javascript</code> and <code>jsp</code>.</em> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * @since 3.0</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> @Parameter( defaultValue = <span class="jxr_string">"java"</span> ) +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">private</strong> String language; +<a class="jxr_linenumber" name="L119" href="#L119">119</a> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * The rule priority threshold; rules with lower priority than this will not be evaluated.</em> +<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"> * @since 2.1</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> @Parameter( property = <span class="jxr_string">"minimumPriority"</span>, defaultValue = <span class="jxr_string">"5"</span> ) +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> minimumPriority = 5; +<a class="jxr_linenumber" name="L127" href="#L127">127</a> +<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> <em class="jxr_javadoccomment"> * Skip the PMD report generation. Most useful on the command line via "-Dpmd.skip=true".</em> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * @since 2.1</em> +<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> @Parameter( property = <span class="jxr_string">"pmd.skip"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip; +<a class="jxr_linenumber" name="L135" href="#L135">135</a> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * The PMD rulesets to use. See the</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * <a href="https://pmd.github.io/latest/pmd_rules_java.html">Stock Java Rulesets</a> for a</em> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * list of available rules.</em> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * Defaults to a custom ruleset provided by this maven plugin</em> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * (<code>/rulesets/java/maven-pmd-plugin-default.xml</code>).</em> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> @Parameter +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">private</strong> String[] rulesets = <strong class="jxr_keyword">new</strong> String[] { <span class="jxr_string">"/rulesets/java/maven-pmd-plugin-default.xml"</span> }; +<a class="jxr_linenumber" name="L145" href="#L145">145</a> +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * Controls whether the project's compile/test classpath should be passed to PMD to enable its type resolution</em> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * feature.</em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * @since 3.0</em> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> @Parameter( property = <span class="jxr_string">"pmd.typeResolution"</span>, defaultValue = <span class="jxr_string">"true"</span> ) +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> typeResolution; +<a class="jxr_linenumber" name="L154" href="#L154">154</a> +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * Controls whether PMD will track benchmark information.</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * @since 3.1</em> +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> @Parameter( property = <span class="jxr_string">"pmd.benchmark"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> benchmark; +<a class="jxr_linenumber" name="L162" href="#L162">162</a> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * Benchmark output filename.</em> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * @since 3.1</em> +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> @Parameter( property = <span class="jxr_string">"pmd.benchmarkOutputFilename"</span>, +<a class="jxr_linenumber" name="L169" href="#L169">169</a> defaultValue = <span class="jxr_string">"${project.build.directory}/pmd-benchmark.txt"</span> ) +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">private</strong> String benchmarkOutputFilename; +<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"> * Source level marker used to indicate whether a RuleViolation should be suppressed. If it is not set, PMD's</em> +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * default will be used, which is <code>NOPMD</code>. See also <a</em> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * href="https://pmd.github.io/latest/pmd_userdocs_suppressing_warnings.html">PMD &#x2013; Suppressing warnings</a>.</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> <em class="jxr_javadoccomment"> * @since 3.4</em> <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> @Component -<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">private</strong> ResourceManager locator; +<a class="jxr_linenumber" name="L179" href="#L179">179</a> @Parameter( property = <span class="jxr_string">"pmd.suppressMarker"</span> ) +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">private</strong> String suppressMarker; <a class="jxr_linenumber" name="L181" href="#L181">181</a> -<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment">/** The PMD renderer for collecting violations. */</em> -<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/maven/plugins/pmd/PmdCollectingRenderer.html">PmdCollectingRenderer</a> renderer; -<a class="jxr_linenumber" name="L184" href="#L184">184</a> -<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment">/** Helper to exclude violations given as a properties file. */</em> -<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/maven/plugins/pmd/ExcludeViolationsFromFile.html">ExcludeViolationsFromFile</a> excludeFromFile = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugins/pmd/ExcludeViolationsFromFile.html">ExcludeViolationsFromFile</a>(); -<a class="jxr_linenumber" name="L187" href="#L187">187</a> -<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"> * per default pmd executions error are ignored to not break the whole</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> <em class="jxr_javadoccomment"> * @since 3.1</em> -<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L193" href="#L193">193</a> @Parameter( property = <span class="jxr_string">"pmd.skipPmdError"</span>, defaultValue = <span class="jxr_string">"true"</span> ) -<a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skipPmdError; -<a class="jxr_linenumber" name="L195" href="#L195">195</a> -<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> <em class="jxr_javadoccomment"> * Enables the analysis cache, which speeds up PMD. This</em> -<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * requires a cache file, that contains the results of the last</em> -<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * PMD run. Thus the cache is only effective, if this file is</em> -<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * not cleaned between runs.</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 3.8</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">"pmd.analysisCache"</span>, defaultValue = <span class="jxr_string">"false"</span> ) -<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> analysisCache; -<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"> * The location of the analysis cache, if it is enabled.</em> -<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> * This file contains the results of the last PMD run and must not be cleaned</em> -<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> * between consecutive PMD runs. Otherwise the cache is not in use.</em> -<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * If the file doesn't exist, PMD executes as if there is no cache enabled and</em> -<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> * all files are analyzed. Otherwise only changed files will be analyzed again.</em> -<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"> * @since 3.8</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> @Parameter( property = <span class="jxr_string">"pmd.analysisCacheLocation"</span>, defaultValue = <span class="jxr_string">"${project.build.directory}/pmd/pmd.cache"</span> ) -<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">private</strong> String analysisCacheLocation; -<a class="jxr_linenumber" name="L218" href="#L218">218</a> -<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * Also render processing errors into the HTML report.</em> -<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> * Processing errors are problems, that PMD encountered while executing the rules.</em> -<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> * It can be parsing errors or exceptions during rule execution.</em> -<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> * Processing errors indicate a bug in PMD and the information provided help in</em> -<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> * reporting and fixing bugs in PMD.</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> <em class="jxr_javadoccomment"> * @since 3.9.0</em> -<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L228" href="#L228">228</a> @Parameter( property = <span class="jxr_string">"pmd.renderProcessingErrors"</span>, defaultValue = <span class="jxr_string">"true"</span> ) -<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> renderProcessingErrors = <strong class="jxr_keyword">true</strong>; -<a class="jxr_linenumber" name="L230" href="#L230">230</a> -<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> <em class="jxr_javadoccomment"> * Also render the rule priority into the HTML report.</em> -<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> * @since 3.10.0</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">"pmd.renderRuleViolationPriority"</span>, defaultValue = <span class="jxr_string">"true"</span> ) -<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> renderRuleViolationPriority = <strong class="jxr_keyword">true</strong>; -<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"> * Add a section in the HTML report, that groups the found violations by rule priority</em> -<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> * in addition to grouping by file.</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> <em class="jxr_javadoccomment"> * @since 3.12.0</em> -<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L245" href="#L245">245</a> @Parameter( property = <span class="jxr_string">"pmd.renderViolationsByPriority"</span>, defaultValue = <span class="jxr_string">"true"</span> ) -<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> renderViolationsByPriority = <strong class="jxr_keyword">true</strong>; -<a class="jxr_linenumber" name="L247" href="#L247">247</a> -<a class="jxr_linenumber" name="L248" href="#L248">248</a> @Component -<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">private</strong> DependencyResolver dependencyResolver; -<a class="jxr_linenumber" name="L250" href="#L250">250</a> -<a class="jxr_linenumber" name="L251" href="#L251">251</a> @Parameter( defaultValue = <span class="jxr_string">"${session}"</span>, required = <strong class="jxr_keyword">true</strong>, readonly = <strong class="jxr_keyword">true</strong> ) -<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">private</strong> MavenSession session; -<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"> * {@inheritDoc}</em> -<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L257" href="#L257">257</a> @Override -<a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">public</strong> String getName( Locale locale ) -<a class="jxr_linenumber" name="L259" href="#L259">259</a> { -<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">return</strong> getBundle( locale ).getString( <span class="jxr_string">"report.pmd.name"</span> ); -<a class="jxr_linenumber" name="L261" href="#L261">261</a> } -<a class="jxr_linenumber" name="L262" href="#L262">262</a> -<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em> -<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L266" href="#L266">266</a> @Override -<a class="jxr_linenumber" name="L267" href="#L267">267</a> <strong class="jxr_keyword">public</strong> String getDescription( Locale locale ) -<a class="jxr_linenumber" name="L268" href="#L268">268</a> { -<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">return</strong> getBundle( locale ).getString( <span class="jxr_string">"report.pmd.description"</span> ); -<a class="jxr_linenumber" name="L270" href="#L270">270</a> } -<a class="jxr_linenumber" name="L271" href="#L271">271</a> -<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> <em class="jxr_javadoccomment"> * Configures the PMD rulesets to be used directly.</em> -<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> * Note: Usually the rulesets are configured via the property.</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> <em class="jxr_javadoccomment"> * @param rulesets the PMD rulesets to be used.</em> -<a class="jxr_linenumber" name="L277" href="#L277">277</a> <em class="jxr_javadoccomment"> * @see #rulesets</em> -<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRulesets( String[] rulesets ) -<a class="jxr_linenumber" name="L280" href="#L280">280</a> { -<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">this</strong>.rulesets = Arrays.copyOf( rulesets, rulesets.length ); -<a class="jxr_linenumber" name="L282" href="#L282">282</a> } -<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"> * {@inheritDoc}</em> -<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L287" href="#L287">287</a> @Override -<a class="jxr_linenumber" name="L288" href="#L288">288</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> executeReport( Locale locale ) -<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">throws</strong> MavenReportException -<a class="jxr_linenumber" name="L290" href="#L290">290</a> { -<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L292" href="#L292">292</a> { -<a class="jxr_linenumber" name="L293" href="#L293">293</a> execute( locale ); -<a class="jxr_linenumber" name="L294" href="#L294">294</a> } -<a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">finally</strong> -<a class="jxr_linenumber" name="L296" href="#L296">296</a> { -<a class="jxr_linenumber" name="L297" href="#L297">297</a> <strong class="jxr_keyword">if</strong> ( getSink() != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L298" href="#L298">298</a> { -<a class="jxr_linenumber" name="L299" href="#L299">299</a> getSink().close(); -<a class="jxr_linenumber" name="L300" href="#L300">300</a> } -<a class="jxr_linenumber" name="L301" href="#L301">301</a> } -<a class="jxr_linenumber" name="L302" href="#L302">302</a> } -<a class="jxr_linenumber" name="L303" href="#L303">303</a> -<a class="jxr_linenumber" name="L304" href="#L304">304</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> execute( Locale locale ) -<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">throws</strong> MavenReportException -<a class="jxr_linenumber" name="L306" href="#L306">306</a> { -<a class="jxr_linenumber" name="L307" href="#L307">307</a> <strong class="jxr_keyword">if</strong> ( !skip && canGenerateReport() ) -<a class="jxr_linenumber" name="L308" href="#L308">308</a> { -<a class="jxr_linenumber" name="L309" href="#L309">309</a> ClassLoader origLoader = Thread.currentThread().getContextClassLoader(); -<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L311" href="#L311">311</a> { -<a class="jxr_linenumber" name="L312" href="#L312">312</a> Thread.currentThread().setContextClassLoader( <strong class="jxr_keyword">this</strong>.getClass().getClassLoader() ); -<a class="jxr_linenumber" name="L313" href="#L313">313</a> -<a class="jxr_linenumber" name="L314" href="#L314">314</a> Report report = generateReport( locale ); -<a class="jxr_linenumber" name="L315" href="#L315">315</a> -<a class="jxr_linenumber" name="L316" href="#L316">316</a> <strong class="jxr_keyword">if</strong> ( !isHtml() && !isXml() ) -<a class="jxr_linenumber" name="L317" href="#L317">317</a> { -<a class="jxr_linenumber" name="L318" href="#L318">318</a> writeNonHtml( report ); -<a class="jxr_linenumber" name="L319" href="#L319">319</a> } -<a class="jxr_linenumber" name="L320" href="#L320">320</a> } -<a class="jxr_linenumber" name="L321" href="#L321">321</a> <strong class="jxr_keyword">finally</strong> -<a class="jxr_linenumber" name="L322" href="#L322">322</a> { -<a class="jxr_linenumber" name="L323" href="#L323">323</a> Thread.currentThread().setContextClassLoader( origLoader ); -<a class="jxr_linenumber" name="L324" href="#L324">324</a> } -<a class="jxr_linenumber" name="L325" href="#L325">325</a> } -<a class="jxr_linenumber" name="L326" href="#L326">326</a> } +<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> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L184" href="#L184">184</a> @Component +<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">private</strong> ResourceManager locator; +<a class="jxr_linenumber" name="L186" href="#L186">186</a> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment">/** The PMD renderer for collecting violations. */</em> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/maven/plugins/pmd/PmdCollectingRenderer.html">PmdCollectingRenderer</a> renderer; +<a class="jxr_linenumber" name="L189" href="#L189">189</a> +<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment">/** Helper to exclude violations given as a properties file. */</em> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/maven/plugins/pmd/ExcludeViolationsFromFile.html">ExcludeViolationsFromFile</a> excludeFromFile = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugins/pmd/ExcludeViolationsFromFile.html">ExcludeViolationsFromFile</a>(); +<a class="jxr_linenumber" name="L192" href="#L192">192</a> +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * per default pmd executions error are ignored to not break the whole</em> +<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment"> * @since 3.1</em> +<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L198" href="#L198">198</a> @Parameter( property = <span class="jxr_string">"pmd.skipPmdError"</span>, defaultValue = <span class="jxr_string">"true"</span> ) +<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skipPmdError; +<a class="jxr_linenumber" name="L200" href="#L200">200</a> +<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"> * Enables the analysis cache, which speeds up PMD. This</em> +<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * requires a cache file, that contains the results of the last</em> +<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * PMD run. Thus the cache is only effective, if this file is</em> +<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> * not cleaned between runs.</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> <em class="jxr_javadoccomment"> * @since 3.8</em> +<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L209" href="#L209">209</a> @Parameter( property = <span class="jxr_string">"pmd.analysisCache"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L210" href="#L210">210</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> analysisCache; +<a class="jxr_linenumber" name="L211" href="#L211">211</a> +<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"> * The location of the analysis cache, if it is enabled.</em> +<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * This file contains the results of the last PMD run and must not be cleaned</em> +<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * between consecutive PMD runs. Otherwise the cache is not in use.</em> +<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * If the file doesn't exist, PMD executes as if there is no cache enabled and</em> +<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * all files are analyzed. Otherwise only changed files will be analyzed again.</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> <em class="jxr_javadoccomment"> * @since 3.8</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> @Parameter( property = <span class="jxr_string">"pmd.analysisCacheLocation"</span>, defaultValue = <span class="jxr_string">"${project.build.directory}/pmd/pmd.cache"</span> ) +<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">private</strong> String analysisCacheLocation; +<a class="jxr_linenumber" name="L223" href="#L223">223</a> +<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment"> * Also render processing errors into the HTML report.</em> +<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment"> * Processing errors are problems, that PMD encountered while executing the rules.</em> +<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> * It can be parsing errors or exceptions during rule execution.</em> +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> * Processing errors indicate a bug in PMD and the information provided help in</em> +<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment"> * reporting and fixing bugs in PMD.</em> +<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> * @since 3.9.0</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">"pmd.renderProcessingErrors"</span>, defaultValue = <span class="jxr_string">"true"</span> ) +<a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> renderProcessingErrors = <strong class="jxr_keyword">true</strong>; +<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"> * Also render the rule priority into the HTML report.</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"> * @since 3.10.0</em> +<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L241" href="#L241">241</a> @Parameter( property = <span class="jxr_string">"pmd.renderRuleViolationPriority"</span>, defaultValue = <span class="jxr_string">"true"</span> ) +<a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> renderRuleViolationPriority = <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L243" href="#L243">243</a> +<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> * Add a section in the HTML report, that groups the found violations by rule priority</em> +<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> * in addition to grouping by file.</em> +<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> * @since 3.12.0</em> +<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> @Parameter( property = <span class="jxr_string">"pmd.renderViolationsByPriority"</span>, defaultValue = <span class="jxr_string">"true"</span> ) +<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> renderViolationsByPriority = <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L252" href="#L252">252</a> +<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> <em class="jxr_javadoccomment"> * Before PMD is executed, the configured rulesets are resolved and copied into this directory.</em> +<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * <p>Note: Before 3.13.0, this was by default ${project.build.directory}.</em> +<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * @since 3.13.0</em> +<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L259" href="#L259">259</a> @Parameter( property = <span class="jxr_string">"pmd.rulesetsTargetDirectory"</span>, defaultValue = <span class="jxr_string">"${project.build.directory}/pmd/rulesets"</span> ) +<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">private</strong> File rulesetsTargetDirectory; +<a class="jxr_linenumber" name="L261" href="#L261">261</a> +<a class="jxr_linenumber" name="L262" href="#L262">262</a> @Component +<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">private</strong> DependencyResolver dependencyResolver; +<a class="jxr_linenumber" name="L264" href="#L264">264</a> +<a class="jxr_linenumber" name="L265" href="#L265">265</a> @Parameter( defaultValue = <span class="jxr_string">"${session}"</span>, required = <strong class="jxr_keyword">true</strong>, readonly = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong class="jxr_keyword">private</strong> MavenSession session; +<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"> * {@inheritDoc}</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> @Override +<a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">public</strong> String getName( Locale locale ) +<a class="jxr_linenumber" name="L273" href="#L273">273</a> { +<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">return</strong> getBundle( locale ).getString( <span class="jxr_string">"report.pmd.name"</span> ); +<a class="jxr_linenumber" name="L275" href="#L275">275</a> } +<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"> * {@inheritDoc}</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> @Override +<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">public</strong> String getDescription( Locale locale ) +<a class="jxr_linenumber" name="L282" href="#L282">282</a> { +<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">return</strong> getBundle( locale ).getString( <span class="jxr_string">"report.pmd.description"</span> ); +<a class="jxr_linenumber" name="L284" href="#L284">284</a> } +<a class="jxr_linenumber" name="L285" href="#L285">285</a> +<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * Configures the PMD rulesets to be used directly.</em> +<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> * Note: Usually the rulesets are configured via the property.</em> +<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> * @param rulesets the PMD rulesets to be used.</em> +<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> * @see #rulesets</em> +<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRulesets( String[] rulesets ) +<a class="jxr_linenumber" name="L294" href="#L294">294</a> { +<a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong class="jxr_keyword">this</strong>.rulesets = Arrays.copyOf( rulesets, rulesets.length ); +<a class="jxr_linenumber" name="L296" href="#L296">296</a> } +<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"> * {@inheritDoc}</em> +<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L301" href="#L301">301</a> @Override +<a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> executeReport( Locale locale ) +<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">throws</strong> MavenReportException +<a class="jxr_linenumber" name="L304" href="#L304">304</a> { +<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L306" href="#L306">306</a> { +<a class="jxr_linenumber" name="L307" href="#L307">307</a> execute( locale ); +<a class="jxr_linenumber" name="L308" href="#L308">308</a> } +<a class="jxr_linenumber" name="L309" href="#L309">309</a> <strong class="jxr_keyword">finally</strong> +<a class="jxr_linenumber" name="L310" href="#L310">310</a> { +<a class="jxr_linenumber" name="L311" href="#L311">311</a> <strong class="jxr_keyword">if</strong> ( getSink() != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L312" href="#L312">312</a> { +<a class="jxr_linenumber" name="L313" href="#L313">313</a> getSink().close(); +<a class="jxr_linenumber" name="L314" href="#L314">314</a> } +<a class="jxr_linenumber" name="L315" href="#L315">315</a> } +<a class="jxr_linenumber" name="L316" href="#L316">316</a> } +<a class="jxr_linenumber" name="L317" href="#L317">317</a> +<a class="jxr_linenumber" name="L318" href="#L318">318</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> execute( Locale locale ) +<a class="jxr_linenumber" name="L319" href="#L319">319</a> <strong class="jxr_keyword">throws</strong> MavenReportException +<a class="jxr_linenumber" name="L320" href="#L320">320</a> { +<a class="jxr_linenumber" name="L321" href="#L321">321</a> <strong class="jxr_keyword">if</strong> ( !skip && canGenerateReport() ) +<a class="jxr_linenumber" name="L322" href="#L322">322</a> { +<a class="jxr_linenumber" name="L323" href="#L323">323</a> ClassLoader origLoader = Thread.currentThread().getContextClassLoader(); +<a class="jxr_linenumber" name="L324" href="#L324">324</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L325" href="#L325">325</a> { +<a class="jxr_linenumber" name="L326" href="#L326">326</a> Thread.currentThread().setContextClassLoader( <strong class="jxr_keyword">this</strong>.getClass().getClassLoader() ); <a class="jxr_linenumber" name="L327" href="#L327">327</a> -<a class="jxr_linenumber" name="L328" href="#L328">328</a> @Override -<a class="jxr_linenumber" name="L329" href="#L329">329</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() -<a class="jxr_linenumber" name="L330" href="#L330">330</a> { -<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">if</strong> ( skip ) -<a class="jxr_linenumber" name="L332" href="#L332">332</a> { -<a class="jxr_linenumber" name="L333" href="#L333">333</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L328" href="#L328">328</a> generateMavenSiteReport( locale ); +<a class="jxr_linenumber" name="L329" href="#L329">329</a> } +<a class="jxr_linenumber" name="L330" href="#L330">330</a> <strong class="jxr_keyword">finally</strong> +<a class="jxr_linenumber" name="L331" href="#L331">331</a> { +<a class="jxr_linenumber" name="L332" href="#L332">332</a> Thread.currentThread().setContextClassLoader( origLoader ); +<a class="jxr_linenumber" name="L333" href="#L333">333</a> } <a class="jxr_linenumber" name="L334" href="#L334">334</a> } -<a class="jxr_linenumber" name="L335" href="#L335">335</a> -<a class="jxr_linenumber" name="L336" href="#L336">336</a> <strong class="jxr_keyword">boolean</strong> result = <strong class="jxr_keyword">super</strong>.canGenerateReport(); -<a class="jxr_linenumber" name="L337" href="#L337">337</a> <strong class="jxr_keyword">if</strong> ( result ) -<a class="jxr_linenumber" name="L338" href="#L338">338</a> { -<a class="jxr_linenumber" name="L339" href="#L339">339</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L340" href="#L340">340</a> { -<a class="jxr_linenumber" name="L341" href="#L341">341</a> executePmdWithClassloader(); -<a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">if</strong> ( skipEmptyReport ) -<a class="jxr_linenumber" name="L343" href="#L343">343</a> { -<a class="jxr_linenumber" name="L344" href="#L344">344</a> result = renderer.hasViolations(); -<a class="jxr_linenumber" name="L345" href="#L345">345</a> <strong class="jxr_keyword">if</strong> ( result ) -<a class="jxr_linenumber" name="L346" href="#L346">346</a> { -<a class="jxr_linenumber" name="L347" href="#L347">347</a> getLog().debug( <span class="jxr_string">"Skipping report since skipEmptyReport is true and"</span> -<a class="jxr_linenumber" name="L348" href="#L348">348</a> + <span class="jxr_string">"there are no PMD violations."</span> ); -<a class="jxr_linenumber" name="L349" href="#L349">349</a> } -<a class="jxr_linenumber" name="L350" href="#L350">350</a> } -<a class="jxr_linenumber" name="L351" href="#L351">351</a> } -<a class="jxr_linenumber" name="L352" href="#L352">352</a> <strong class="jxr_keyword">catch</strong> ( MavenReportException e ) -<a class="jxr_linenumber" name="L353" href="#L353">353</a> { -<a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException( e ); -<a class="jxr_linenumber" name="L355" href="#L355">355</a> } -<a class="jxr_linenumber" name="L356" href="#L356">356</a> } -<a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong class="jxr_keyword">return</strong> result; -<a class="jxr_linenumber" name="L358" href="#L358">358</a> } -<a class="jxr_linenumber" name="L359" href="#L359">359</a> -<a class="jxr_linenumber" name="L360" href="#L360">360</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> executePmdWithClassloader() -<a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong class="jxr_keyword">throws</strong> MavenReportException -<a class="jxr_linenumber" name="L362" href="#L362">362</a> { -<a class="jxr_linenumber" name="L363" href="#L363">363</a> ClassLoader origLoader = Thread.currentThread().getContextClassLoader(); -<a class="jxr_linenumber" name="L364" href="#L364">364</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L365" href="#L365">365</a> { -<a class="jxr_linenumber" name="L366" href="#L366">366</a> Thread.currentThread().setContextClassLoader( <strong class="jxr_keyword">this</strong>.getClass().getClassLoader() ); -<a class="jxr_linenumber" name="L367" href="#L367">367</a> executePmd(); -<a class="jxr_linenumber" name="L368" href="#L368">368</a> } -<a class="jxr_linenumber" name="L369" href="#L369">369</a> <strong class="jxr_keyword">finally</strong> -<a class="jxr_linenumber" name="L370" href="#L370">370</a> { -<a class="jxr_linenumber" name="L371" href="#L371">371</a> Thread.currentThread().setContextClassLoader( origLoader ); -<a class="jxr_linenumber" name="L372" href="#L372">372</a> } -<a class="jxr_linenumber" name="L373" href="#L373">373</a> } -<a class="jxr_linenumber" name="L374" href="#L374">374</a> -<a class="jxr_linenumber" name="L375" href="#L375">375</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> executePmd() -<a class="jxr_linenumber" name="L376" href="#L376">376</a> <strong class="jxr_keyword">throws</strong> MavenReportException -<a class="jxr_linenumber" name="L377" href="#L377">377</a> { -<a class="jxr_linenumber" name="L378" href="#L378">378</a> setupPmdLogging(); -<a class="jxr_linenumber" name="L379" href="#L379">379</a> -<a class="jxr_linenumber" name="L380" href="#L380">380</a> <strong class="jxr_keyword">if</strong> ( renderer != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L381" href="#L381">381</a> { -<a class="jxr_linenumber" name="L382" href="#L382">382</a> <em class="jxr_comment">// PMD has already been run</em> -<a class="jxr_linenumber" name="L383" href="#L383">383</a> getLog().debug( <span class="jxr_string">"PMD has already been run - skipping redundant execution."</span> ); -<a class="jxr_linenumber" name="L384" href="#L384">384</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L385" href="#L385">385</a> } -<a class="jxr_linenumber" name="L386" href="#L386">386</a> -<a class="jxr_linenumber" name="L387" href="#L387">387</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L388" href="#L388">388</a> { -<a class="jxr_linenumber" name="L389" href="#L389">389</a> excludeFromFile.loadExcludeFromFailuresData( excludeFromFailureFile ); -<a class="jxr_linenumber" name="L390" href="#L390">390</a> } -<a class="jxr_linenumber" name="L391" href="#L391">391</a> <strong class="jxr_keyword">catch</strong> ( MojoExecutionException e ) -<a class="jxr_linenumber" name="L392" href="#L392">392</a> { -<a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Unable to load exclusions"</span>, e ); +<a class="jxr_linenumber" name="L335" href="#L335">335</a> } +<a class="jxr_linenumber" name="L336" href="#L336">336</a> +<a class="jxr_linenumber" name="L337" href="#L337">337</a> @Override +<a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() +<a class="jxr_linenumber" name="L339" href="#L339">339</a> { +<a class="jxr_linenumber" name="L340" href="#L340">340</a> <strong class="jxr_keyword">if</strong> ( skip ) +<a class="jxr_linenumber" name="L341" href="#L341">341</a> { +<a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L343" href="#L343">343</a> } +<a class="jxr_linenumber" name="L344" href="#L344">344</a> +<a class="jxr_linenumber" name="L345" href="#L345">345</a> <strong class="jxr_keyword">boolean</strong> result = <strong class="jxr_keyword">super</strong>.canGenerateReport(); +<a class="jxr_linenumber" name="L346" href="#L346">346</a> <strong class="jxr_keyword">if</strong> ( result ) +<a class="jxr_linenumber" name="L347" href="#L347">347</a> { +<a class="jxr_linenumber" name="L348" href="#L348">348</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L349" href="#L349">349</a> { +<a class="jxr_linenumber" name="L350" href="#L350">350</a> executePmdWithClassloader(); +<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">if</strong> ( skipEmptyReport ) +<a class="jxr_linenumber" name="L352" href="#L352">352</a> { +<a class="jxr_linenumber" name="L353" href="#L353">353</a> result = renderer.hasViolations(); +<a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">if</strong> ( result ) +<a class="jxr_linenumber" name="L355" href="#L355">355</a> { +<a class="jxr_linenumber" name="L356" href="#L356">356</a> getLog().debug( <span class="jxr_string">"Skipping report since skipEmptyReport is true and"</span> +<a class="jxr_linenumber" name="L357" href="#L357">357</a> + <span class="jxr_string">"there are no PMD violations."</span> ); +<a class="jxr_linenumber" name="L358" href="#L358">358</a> } +<a class="jxr_linenumber" name="L359" href="#L359">359</a> } +<a class="jxr_linenumber" name="L360" href="#L360">360</a> } +<a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong class="jxr_keyword">catch</strong> ( MavenReportException e ) +<a class="jxr_linenumber" name="L362" href="#L362">362</a> { +<a class="jxr_linenumber" name="L363" href="#L363">363</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException( e ); +<a class="jxr_linenumber" name="L364" href="#L364">364</a> } +<a class="jxr_linenumber" name="L365" href="#L365">365</a> } +<a class="jxr_linenumber" name="L366" href="#L366">366</a> <strong class="jxr_keyword">return</strong> result; +<a class="jxr_linenumber" name="L367" href="#L367">367</a> } +<a class="jxr_linenumber" name="L368" href="#L368">368</a> +<a class="jxr_linenumber" name="L369" href="#L369">369</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> executePmdWithClassloader() +<a class="jxr_linenumber" name="L370" href="#L370">370</a> <strong class="jxr_keyword">throws</strong> MavenReportException +<a class="jxr_linenumber" name="L371" href="#L371">371</a> { +<a class="jxr_linenumber" name="L372" href="#L372">372</a> ClassLoader origLoader = Thread.currentThread().getContextClassLoader(); +<a class="jxr_linenumber" name="L373" href="#L373">373</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L374" href="#L374">374</a> { +<a class="jxr_linenumber" name="L375" href="#L375">375</a> Thread.currentThread().setContextClassLoader( <strong class="jxr_keyword">this</strong>.getClass().getClassLoader() ); +<a class="jxr_linenumber" name="L376" href="#L376">376</a> executePmd(); +<a class="jxr_linenumber" name="L377" href="#L377">377</a> } +<a class="jxr_linenumber" name="L378" href="#L378">378</a> <strong class="jxr_keyword">finally</strong> +<a class="jxr_linenumber" name="L379" href="#L379">379</a> { +<a class="jxr_linenumber" name="L380" href="#L380">380</a> Thread.currentThread().setContextClassLoader( origLoader ); +<a class="jxr_linenumber" name="L381" href="#L381">381</a> } +<a class="jxr_linenumber" name="L382" href="#L382">382</a> } +<a class="jxr_linenumber" name="L383" href="#L383">383</a> +<a class="jxr_linenumber" name="L384" href="#L384">384</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> executePmd() +<a class="jxr_linenumber" name="L385" href="#L385">385</a> <strong class="jxr_keyword">throws</strong> MavenReportException +<a class="jxr_linenumber" name="L386" href="#L386">386</a> { +<a class="jxr_linenumber" name="L387" href="#L387">387</a> setupPmdLogging(); +<a class="jxr_linenumber" name="L388" href="#L388">388</a> +<a class="jxr_linenumber" name="L389" href="#L389">389</a> <strong class="jxr_keyword">if</strong> ( renderer != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L390" href="#L390">390</a> { +<a class="jxr_linenumber" name="L391" href="#L391">391</a> <em class="jxr_comment">// PMD has already been run</em> +<a class="jxr_linenumber" name="L392" href="#L392">392</a> getLog().debug( <span class="jxr_string">"PMD has already been run - skipping redundant execution."</span> ); +<a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong class="jxr_keyword">return</strong>; <a class="jxr_linenumber" name="L394" href="#L394">394</a> } <a class="jxr_linenumber" name="L395" href="#L395">395</a> -<a class="jxr_linenumber" name="L396" href="#L396">396</a> <em class="jxr_comment">// configure ResourceManager</em> -<a class="jxr_linenumber" name="L397" href="#L397">397</a> locator.addSearchPath( FileResourceLoader.ID, project.getFile().getParentFile().getAbsolutePath() ); -<a class="jxr_linenumber" name="L398" href="#L398">398</a> locator.addSearchPath( <span class="jxr_string">"url"</span>, <span class="jxr_string">""</span> ); -<a class="jxr_linenumber" name="L399" href="#L399">399</a> locator.setOutputDirectory( targetDirectory ); -<a class="jxr_linenumber" name="L400" href="#L400">400</a> -<a class="jxr_linenumber" name="L401" href="#L401">401</a> renderer = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugins/pmd/PmdCollectingRenderer.html">PmdCollectingRenderer</a>(); -<a class="jxr_linenumber" name="L402" href="#L402">402</a> PMDConfiguration pmdConfiguration = getPMDConfiguration(); -<a class="jxr_linenumber" name="L403" href="#L403">403</a> -<a class="jxr_linenumber" name="L404" href="#L404">404</a> String[] sets = <strong class="jxr_keyword">new</strong> String[rulesets.length]; -<a class="jxr_linenumber" name="L405" href="#L405">405</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L406" href="#L406">406</a> { -<a class="jxr_linenumber" name="L407" href="#L407">407</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> idx = 0; idx < rulesets.length; idx++ ) -<a class="jxr_linenumber" name="L408" href="#L408">408</a> { -<a class="jxr_linenumber" name="L409" href="#L409">409</a> String set = rulesets[idx]; -<a class="jxr_linenumber" name="L410" href="#L410">410</a> getLog().debug( <span class="jxr_string">"Preparing ruleset: "</span> + set ); -<a class="jxr_linenumber" name="L411" href="#L411">411</a> RuleSetReferenceId id = <strong class="jxr_keyword">new</strong> RuleSetReferenceId( set ); -<a class="jxr_linenumber" name="L412" href="#L412">412</a> File ruleset = locator.getResourceAsFile( id.getRuleSetFileName(), getLocationTemp( set ) ); -<a class="jxr_linenumber" name="L413" href="#L413">413</a> <strong class="jxr_keyword">if</strong> ( <strong class="jxr_keyword">null</strong> == ruleset ) -<a class="jxr_linenumber" name="L414" href="#L414">414</a> { -<a class="jxr_linenumber" name="L415" href="#L415">415</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Could not resolve "</span> + set ); -<a class="jxr_linenumber" name="L416" href="#L416">416</a> } -<a class="jxr_linenumber" name="L417" href="#L417">417</a> sets[idx] = ruleset.getAbsolutePath(); -<a class="jxr_linenumber" name="L418" href="#L418">418</a> } -<a class="jxr_linenumber" name="L419" href="#L419">419</a> } -<a class="jxr_linenumber" name="L420" href="#L420">420</a> <strong class="jxr_keyword">catch</strong> ( ResourceNotFoundException e ) -<a class="jxr_linenumber" name="L421" href="#L421">421</a> { -<a class="jxr_linenumber" name="L422" href="#L422">422</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e ); -<a class="jxr_linenumber" name="L423" href="#L423">423</a> } -<a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong class="jxr_keyword">catch</strong> ( FileResourceCreationException e ) -<a class="jxr_linenumber" name="L425" href="#L425">425</a> { -<a class="jxr_linenumber" name="L426" href="#L426">426</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e ); -<a class="jxr_linenumber" name="L427" href="#L427">427</a> } -<a class="jxr_linenumber" name="L428" href="#L428">428</a> pmdConfiguration.setRuleSets( StringUtils.join( sets, <span class="jxr_string">","</span> ) ); -<a class="jxr_linenumber" name="L429" href="#L429">429</a> -<a class="jxr_linenumber" name="L430" href="#L430">430</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="L431" href="#L431">431</a> { -<a class="jxr_linenumber" name="L432" href="#L432">432</a> <strong class="jxr_keyword">if</strong> ( filesToProcess == <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L433" href="#L433">433</a> { -<a class="jxr_linenumber" name="L434" href="#L434">434</a> filesToProcess = getFilesToProcess(); -<a class="jxr_linenumber" name="L435" href="#L435">435</a> } -<a class="jxr_linenumber" name="L436" href="#L436">436</a> -<a class="jxr_linenumber" name="L437" href="#L437">437</a> <strong class="jxr_keyword">if</strong> ( filesToProcess.isEmpty() && !<span class="jxr_string">"java"</span>.equals( language ) ) -<a class="jxr_linenumber" name="L438" href="#L438">438</a> { -<a class="jxr_linenumber" name="L439" href="#L439">439</a> getLog().warn( <span class="jxr_string">"No files found to process. Did you add your additional source folders like javascript?"</span> -<a class="jxr_linenumber" name="L440" href="#L440">440</a> + <span class="jxr_string">" (see also build-helper-maven-plugin)"</span> ); -<a class="jxr_linenumber" name="L441" href="#L441">441</a> } -<a class="jxr_linenumber" name="L442" href="#L442">442</a> } -<a class="jxr_linenumber" name="L443" href="#L443">443</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) -<a class="jxr_linenumber" name="L444" href="#L444">444</a> { -<a class="jxr_linenumber" name="L445" href="#L445">445</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Can't get file list"</span>, e ); -<a class="jxr_linenumber" name="L446" href="#L446">446</a> } -<a class="jxr_linenumber" name="L447" href="#L447">447</a> -<a class="jxr_linenumber" name="L448" href="#L448">448</a> String encoding = getSourceEncoding(); -<a class="jxr_linenumber" name="L449" href="#L449">449</a> <strong class="jxr_keyword">if</strong> ( StringUtils.isEmpty( encoding ) ) -<a class="jxr_linenumber" name="L450" href="#L450">450</a> { -<a class="jxr_linenumber" name="L451" href="#L451">451</a> encoding = ReaderFactory.FILE_ENCODING; -<a class="jxr_linenumber" name="L452" href="#L452">452</a> <strong class="jxr_keyword">if</strong> ( !filesToProcess.isEmpty() ) -<a class="jxr_linenumber" name="L453" href="#L453">453</a> { -<a class="jxr_linenumber" name="L454" href="#L454">454</a> getLog().warn( <span class="jxr_string">"File encoding has not been set, using platform encoding "</span> + ReaderFactory.FILE_ENCODING -<a class="jxr_linenumber" name="L455" href="#L455">455</a> + <span class="jxr_string">", i.e. build is platform dependent!"</span> ); -<a class="jxr_linenumber" name="L456" href="#L456">456</a> } -<a class="jxr_linenumber" name="L457" href="#L457">457</a> } -<a class="jxr_linenumber" name="L458" href="#L458">458</a> pmdConfiguration.setSourceEncoding( encoding ); -<a class="jxr_linenumber" name="L459" href="#L459">459</a> -<a class="jxr_linenumber" name="L460" href="#L460">460</a> List<DataSource> dataSources = <strong class="jxr_keyword">new</strong> ArrayList<>( filesToProcess.size() ); -<a class="jxr_linenumber" name="L461" href="#L461">461</a> <strong class="jxr_keyword">for</strong> ( File f : filesToProcess.keySet() ) -<a class="jxr_linenumber" name="L462" href="#L462">462</a> { -<a class="jxr_linenumber" name="L463" href="#L463">463</a> dataSources.add( <strong class="jxr_keyword">new</strong> FileDataSource( f ) ); -<a class="jxr_linenumber" name="L464" href="#L464">464</a> } -<a class="jxr_linenumber" name="L465" href="#L465">465</a> -<a class="jxr_linenumber" name="L466" href="#L466">466</a> <strong class="jxr_keyword">if</strong> ( sets.length > 0 ) -<a class="jxr_linenumber" name="L467" href="#L467">467</a> { -<a class="jxr_linenumber" name="L468" href="#L468">468</a> processFilesWithPMD( pmdConfiguration, dataSources ); -<a class="jxr_linenumber" name="L469" href="#L469">469</a> } -<a class="jxr_linenumber" name="L470" href="#L470">470</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="L396" href="#L396">396</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L397" href="#L397">397</a> { +<a class="jxr_linenumber" name="L398" href="#L398">398</a> excludeFromFile.loadExcludeFromFailuresData( excludeFromFailureFile ); +<a class="jxr_linenumber" name="L399" href="#L399">399</a> } +<a class="jxr_linenumber" name="L400" href="#L400">400</a> <strong class="jxr_keyword">catch</strong> ( MojoExecutionException e ) +<a class="jxr_linenumber" name="L401" href="#L401">401</a> { +<a class="jxr_linenumber" name="L402" href="#L402">402</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Unable to load exclusions"</span>, e ); +<a class="jxr_linenumber" name="L403" href="#L403">403</a> } +<a class="jxr_linenumber" name="L404" href="#L404">404</a> +<a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_comment">// configure ResourceManager</em> +<a class="jxr_linenumber" name="L406" href="#L406">406</a> locator.addSearchPath( FileResourceLoader.ID, project.getFile().getParentFile().getAbsolutePath() ); +<a class="jxr_linenumber" name="L407" href="#L407">407</a> locator.addSearchPath( <span class="jxr_string">"url"</span>, <span class="jxr_string">""</span> ); +<a class="jxr_linenumber" name="L408" href="#L408">408</a> locator.setOutputDirectory( rulesetsTargetDirectory ); +<a class="jxr_linenumber" name="L409" href="#L409">409</a> +<a class="jxr_linenumber" name="L410" href="#L410">410</a> renderer = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugins/pmd/PmdCollectingRenderer.html">PmdCollectingRenderer</a>(); +<a class="jxr_linenumber" name="L411" href="#L411">411</a> PMDConfiguration pmdConfiguration = getPMDConfiguration(); +<a class="jxr_linenumber" name="L412" href="#L412">412</a> +<a class="jxr_linenumber" name="L413" href="#L413">413</a> String[] sets = <strong class="jxr_keyword">new</strong> String[rulesets.length]; +<a class="jxr_linenumber" name="L414" href="#L414">414</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L415" href="#L415">415</a> { +<a class="jxr_linenumber" name="L416" href="#L416">416</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> idx = 0; idx < rulesets.length; idx++ ) +<a class="jxr_linenumber" name="L417" href="#L417">417</a> { +<a class="jxr_linenumber" name="L418" href="#L418">418</a> String set = rulesets[idx]; +<a class="jxr_linenumber" name="L419" href="#L419">419</a> getLog().debug( <span class="jxr_string">"Preparing ruleset: "</span> + set ); +<a class="jxr_linenumber" name="L420" href="#L420">420</a> RuleSetReferenceId id = <strong class="jxr_keyword">new</strong> RuleSetReferenceId( set ); +<a class="jxr_linenumber" name="L421" href="#L421">421</a> File ruleset = locator.getResourceAsFile( id.getRuleSetFileName(), getLocationTemp( set ) ); +<a class="jxr_linenumber" name="L422" href="#L422">422</a> <strong class="jxr_keyword">if</strong> ( <strong class="jxr_keyword">null</strong> == ruleset ) +<a class="jxr_linenumber" name="L423" href="#L423">423</a> { +<a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Could not resolve "</span> + set ); +<a class="jxr_linenumber" name="L425" href="#L425">425</a> } +<a class="jxr_linenumber" name="L426" href="#L426">426</a> sets[idx] = ruleset.getAbsolutePath(); +<a class="jxr_linenumber" name="L427" href="#L427">427</a> } +<a class="jxr_linenumber" name="L428" href="#L428">428</a> } +<a class="jxr_linenumber" name="L429" href="#L429">429</a> <strong class="jxr_keyword">catch</strong> ( ResourceNotFoundException e ) +<a class="jxr_linenumber" name="L430" href="#L430">430</a> { +<a class="jxr_linenumber" name="L431" href="#L431">431</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e ); +<a class="jxr_linenumber" name="L432" href="#L432">432</a> } +<a class="jxr_linenumber" name="L433" href="#L433">433</a> <strong class="jxr_keyword">catch</strong> ( FileResourceCreationException e ) +<a class="jxr_linenumber" name="L434" href="#L434">434</a> { +<a class="jxr_linenumber" name="L435" href="#L435">435</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( e.getMessage(), e ); +<a class="jxr_linenumber" name="L436" href="#L436">436</a> } +<a class="jxr_linenumber" name="L437" href="#L437">437</a> pmdConfiguration.setRuleSets( StringUtils.join( sets, <span class="jxr_string">","</span> ) ); +<a class="jxr_linenumber" name="L438" href="#L438">438</a> +<a class="jxr_linenumber" name="L439" href="#L439">439</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L440" href="#L440">440</a> { +<a class="jxr_linenumber" name="L441" href="#L441">441</a> <strong class="jxr_keyword">if</strong> ( filesToProcess == <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L442" href="#L442">442</a> { +<a class="jxr_linenumber" name="L443" href="#L443">443</a> filesToProcess = getFilesToProcess(); +<a class="jxr_linenumber" name="L444" href="#L444">444</a> } +<a class="jxr_linenumber" name="L445" href="#L445">445</a> +<a class="jxr_linenumber" name="L446" href="#L446">446</a> <strong class="jxr_keyword">if</strong> ( filesToProcess.isEmpty() && !<span class="jxr_string">"java"</span>.equals( language ) ) +<a class="jxr_linenumber" name="L447" href="#L447">447</a> { +<a class="jxr_linenumber" name="L448" href="#L448">448</a> getLog().warn( <span class="jxr_string">"No files found to process. Did you add your additional source folders like javascript?"</span> +<a class="jxr_linenumber" name="L449" href="#L449">449</a> + <span class="jxr_string">" (see also build-helper-maven-plugin)"</span> ); +<a class="jxr_linenumber" name="L450" href="#L450">450</a> } +<a class="jxr_linenumber" name="L451" href="#L451">451</a> } +<a class="jxr_linenumber" name="L452" href="#L452">452</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) +<a class="jxr_linenumber" name="L453" href="#L453">453</a> { +<a class="jxr_linenumber" name="L454" href="#L454">454</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException( <span class="jxr_string">"Can't get file list"</span>, e ); +<a class="jxr_linenumber" name="L455" href="#L455">455</a> } +<a class="jxr_linenumber" name="L456" href="#L456">456</a> +<a class="jxr_linenumber" name="L457" href="#L457">457</a> String encoding = getSourceEncoding();
[... 827 lines stripped ...]