Modified: maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html (original) +++ maven/website/components/plugins-archives/maven-site-plugin-LATEST/xref/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.html Mon Mar 20 08:01:01 2023 @@ -1,5 +1,5 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="" lang=""> <head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> <title>AbstractSiteRenderingMojo xref</title> <link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> @@ -115,398 +115,385 @@ <a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">protected</strong> List<MavenReport> reports; <a class="jxr_linenumber" name="L108" href="#L108">108</a> <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"> * Alternative directory for xdoc source, useful for m1 to m2 migration</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> <em class="jxr_javadoccomment"> * @deprecated use the standard m2 directory layout</em> -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L114" href="#L114">114</a> @Parameter(defaultValue = <span class="jxr_string">"${basedir}/xdocs"</span>) -<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">private</strong> File xdocDirectory; -<a class="jxr_linenumber" name="L116" href="#L116">116</a> -<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"> * Directory containing generated documentation in source format (Doxia supported markup).</em> -<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * This is used to pick up other source docs that might have been generated at build time (by reports or any other</em> -<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * build time mean).</em> -<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * This directory is expected to have the same structure as <code>siteDirectory</code></em> -<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * (ie. one directory per Doxia-source-supported markup types).</em> -<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"> * todo should we deprecate in favour of reports directly using Doxia Sink API, without this Doxia source</em> -<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * intermediate step?</em> -<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L127" href="#L127">127</a> @Parameter(alias = <span class="jxr_string">"workingDirectory"</span>, defaultValue = <span class="jxr_string">"${project.build.directory}/generated-site"</span>) -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">protected</strong> File generatedSiteDirectory; -<a class="jxr_linenumber" name="L129" href="#L129">129</a> -<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * The current Maven session.</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(defaultValue = <span class="jxr_string">"${session}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">protected</strong> MavenSession mavenSession; -<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"> * replaces previous reportPlugins parameter, that was injected by Maven core from</em> -<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * reporting section: but this new configuration format has been abandoned.</em> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * Directory containing generated documentation in source format (Doxia supported markup).</em> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * This is used to pick up other source docs that might have been generated at build time (by reports or any other</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * build time mean).</em> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * This directory is expected to have the same structure as <code>siteDirectory</code></em> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * (ie. one directory per Doxia-source-supported markup types).</em> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * todo should we deprecate in favour of reports directly using Doxia Sink API, without this Doxia source</em> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * intermediate step?</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(alias = <span class="jxr_string">"workingDirectory"</span>, defaultValue = <span class="jxr_string">"${project.build.directory}/generated-site"</span>) +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">protected</strong> File generatedSiteDirectory; +<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 current Maven session.</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(defaultValue = <span class="jxr_string">"${session}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">protected</strong> MavenSession mavenSession; +<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"> * replaces previous reportPlugins parameter, that was injected by Maven core from</em> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * reporting section: but this new configuration format has been abandoned.</em> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * @since 3.7.1</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> @Parameter(defaultValue = <span class="jxr_string">"${project.reporting}"</span>, readonly = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">private</strong> Reporting reporting; +<a class="jxr_linenumber" name="L136" href="#L136">136</a> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * Whether to generate the summary page for project reports: project-info.html.</em> <a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * @since 3.7.1</em> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * @since 2.3</em> <a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L142" href="#L142">142</a> @Parameter(defaultValue = <span class="jxr_string">"${project.reporting}"</span>, readonly = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">private</strong> Reporting reporting; +<a class="jxr_linenumber" name="L142" href="#L142">142</a> @Parameter(property = <span class="jxr_string">"generateProjectInfo"</span>, defaultValue = <span class="jxr_string">"true"</span>) +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> generateProjectInfo; <a class="jxr_linenumber" name="L144" href="#L144">144</a> <a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * Whether to generate the summary page for project reports: project-info.html.</em> +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * Specifies the input encoding.</em> <a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> *</em> <a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * @since 2.3</em> <a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L150" href="#L150">150</a> @Parameter(property = <span class="jxr_string">"generateProjectInfo"</span>, defaultValue = <span class="jxr_string">"true"</span>) -<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> generateProjectInfo; +<a class="jxr_linenumber" name="L150" href="#L150">150</a> @Parameter(property = <span class="jxr_string">"encoding"</span>, defaultValue = <span class="jxr_string">"${project.build.sourceEncoding}"</span>) +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">private</strong> String inputEncoding; <a class="jxr_linenumber" name="L152" href="#L152">152</a> <a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * Specifies the input encoding.</em> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * Specifies the output encoding.</em> <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"> * @since 2.3</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> @Parameter(property = <span class="jxr_string">"encoding"</span>, defaultValue = <span class="jxr_string">"${project.build.sourceEncoding}"</span>) -<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">private</strong> String inputEncoding; +<a class="jxr_linenumber" name="L158" href="#L158">158</a> @Parameter(property = <span class="jxr_string">"outputEncoding"</span>, defaultValue = <span class="jxr_string">"${project.reporting.outputEncoding}"</span>) +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">private</strong> String outputEncoding; <a class="jxr_linenumber" name="L160" href="#L160">160</a> -<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"> * Specifies the output encoding.</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> <em class="jxr_javadoccomment"> * @since 2.3</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> @Parameter(property = <span class="jxr_string">"outputEncoding"</span>, defaultValue = <span class="jxr_string">"${project.reporting.outputEncoding}"</span>) -<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">private</strong> String outputEncoding; -<a class="jxr_linenumber" name="L168" href="#L168">168</a> -<a class="jxr_linenumber" name="L169" href="#L169">169</a> @Component -<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">protected</strong> MavenReportExecutor mavenReportExecutor; -<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"> * Gets the input files encoding.</em> -<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * @return The input files encoding, never <code>null</code>.</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> <strong class="jxr_keyword">protected</strong> String getInputEncoding() { -<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">return</strong> (StringUtils.isEmpty(inputEncoding)) ? ReaderFactory.FILE_ENCODING : inputEncoding; -<a class="jxr_linenumber" name="L179" href="#L179">179</a> } -<a class="jxr_linenumber" name="L180" href="#L180">180</a> -<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * Gets the effective reporting output files encoding.</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> <em class="jxr_javadoccomment"> * @return The effective reporting output file encoding, never <code>null</code>.</em> -<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">protected</strong> String getOutputEncoding() { -<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">return</strong> (outputEncoding == <strong class="jxr_keyword">null</strong>) ? ReaderFactory.UTF_8 : outputEncoding; -<a class="jxr_linenumber" name="L188" href="#L188">188</a> } -<a class="jxr_linenumber" name="L189" href="#L189">189</a> -<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"> * Whether to save Velocity processed Doxia content (<code>*.&lt;ext&gt;.vm</code>)</em> -<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * to <code>${generatedSiteDirectory}/processed</code>.</em> -<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"> * @since 3.5</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> @Parameter -<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> saveProcessedContent; -<a class="jxr_linenumber" name="L198" href="#L198">198</a> -<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> checkInputEncoding() { -<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">if</strong> (StringUtils.isEmpty(inputEncoding)) { -<a class="jxr_linenumber" name="L201" href="#L201">201</a> getLog().warn(<span class="jxr_string">"Input file encoding has not been set, using platform encoding "</span> + ReaderFactory.FILE_ENCODING -<a class="jxr_linenumber" name="L202" href="#L202">202</a> + <span class="jxr_string">", i.e. build is platform dependent!"</span>); -<a class="jxr_linenumber" name="L203" href="#L203">203</a> } -<a class="jxr_linenumber" name="L204" href="#L204">204</a> } +<a class="jxr_linenumber" name="L161" href="#L161">161</a> @Component +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">protected</strong> MavenReportExecutor mavenReportExecutor; +<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"> * Gets the input files encoding.</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"> * @return The input files encoding, never <code>null</code>.</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> <strong class="jxr_keyword">protected</strong> String getInputEncoding() { +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">return</strong> (StringUtils.isEmpty(inputEncoding)) ? ReaderFactory.FILE_ENCODING : inputEncoding; +<a class="jxr_linenumber" name="L171" href="#L171">171</a> } +<a class="jxr_linenumber" name="L172" href="#L172">172</a> +<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> <em class="jxr_javadoccomment"> * Gets the effective reporting output files encoding.</em> +<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"> * @return The effective reporting output file encoding, never <code>null</code>.</em> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">protected</strong> String getOutputEncoding() { +<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">return</strong> (outputEncoding == <strong class="jxr_keyword">null</strong>) ? ReaderFactory.UTF_8 : outputEncoding; +<a class="jxr_linenumber" name="L180" href="#L180">180</a> } +<a class="jxr_linenumber" name="L181" href="#L181">181</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"> * Whether to save Velocity processed Doxia content (<code>*.&lt;ext&gt;.vm</code>)</em> +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * to <code>${generatedSiteDirectory}/processed</code>.</em> +<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * @since 3.5</em> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> @Parameter +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> saveProcessedContent; +<a class="jxr_linenumber" name="L190" href="#L190">190</a> +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> checkInputEncoding() { +<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">if</strong> (StringUtils.isEmpty(inputEncoding)) { +<a class="jxr_linenumber" name="L193" href="#L193">193</a> getLog().warn(<span class="jxr_string">"Input file encoding has not been set, using platform encoding "</span> + ReaderFactory.FILE_ENCODING +<a class="jxr_linenumber" name="L194" href="#L194">194</a> + <span class="jxr_string">", i.e. build is platform dependent!"</span>); +<a class="jxr_linenumber" name="L195" href="#L195">195</a> } +<a class="jxr_linenumber" name="L196" href="#L196">196</a> } +<a class="jxr_linenumber" name="L197" href="#L197">197</a> +<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">protected</strong> List<MavenReportExecution> getReports() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L199" href="#L199">199</a> MavenReportExecutorRequest mavenReportExecutorRequest = <strong class="jxr_keyword">new</strong> MavenReportExecutorRequest(); +<a class="jxr_linenumber" name="L200" href="#L200">200</a> mavenReportExecutorRequest.setMavenSession(mavenSession); +<a class="jxr_linenumber" name="L201" href="#L201">201</a> mavenReportExecutorRequest.setProject(project); +<a class="jxr_linenumber" name="L202" href="#L202">202</a> mavenReportExecutorRequest.setReportPlugins(getReportingPlugins()); +<a class="jxr_linenumber" name="L203" href="#L203">203</a> +<a class="jxr_linenumber" name="L204" href="#L204">204</a> List<MavenReportExecution> allReports = mavenReportExecutor.buildMavenReports(mavenReportExecutorRequest); <a class="jxr_linenumber" name="L205" href="#L205">205</a> -<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">protected</strong> List<MavenReportExecution> getReports() <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L207" href="#L207">207</a> MavenReportExecutorRequest mavenReportExecutorRequest = <strong class="jxr_keyword">new</strong> MavenReportExecutorRequest(); -<a class="jxr_linenumber" name="L208" href="#L208">208</a> mavenReportExecutorRequest.setLocalRepository(localRepository); -<a class="jxr_linenumber" name="L209" href="#L209">209</a> mavenReportExecutorRequest.setMavenSession(mavenSession); -<a class="jxr_linenumber" name="L210" href="#L210">210</a> mavenReportExecutorRequest.setProject(project); -<a class="jxr_linenumber" name="L211" href="#L211">211</a> mavenReportExecutorRequest.setReportPlugins(getReportingPlugins()); -<a class="jxr_linenumber" name="L212" href="#L212">212</a> -<a class="jxr_linenumber" name="L213" href="#L213">213</a> List<MavenReportExecution> allReports = mavenReportExecutor.buildMavenReports(mavenReportExecutorRequest); -<a class="jxr_linenumber" name="L214" href="#L214">214</a> -<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_comment">// filter out reports that can't be generated</em> -<a class="jxr_linenumber" name="L216" href="#L216">216</a> List<MavenReportExecution> reportExecutions = <strong class="jxr_keyword">new</strong> ArrayList<>(allReports.size()); -<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">for</strong> (MavenReportExecution exec : allReports) { -<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">if</strong> (exec.canGenerateReport()) { -<a class="jxr_linenumber" name="L219" href="#L219">219</a> reportExecutions.add(exec); -<a class="jxr_linenumber" name="L220" href="#L220">220</a> } -<a class="jxr_linenumber" name="L221" href="#L221">221</a> } -<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">return</strong> reportExecutions; -<a class="jxr_linenumber" name="L223" href="#L223">223</a> } -<a class="jxr_linenumber" name="L224" href="#L224">224</a> -<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"> * Get the report plugins from reporting section, adding if necessary (i.e. not excluded)</em> -<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> * default reports (i.e. maven-project-info-reports)</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> <em class="jxr_javadoccomment"> * @return the effective list of reports</em> -<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> * @since 3.7.1</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> <strong class="jxr_keyword">private</strong> ReportPlugin[] getReportingPlugins() { -<a class="jxr_linenumber" name="L233" href="#L233">233</a> List<ReportPlugin> reportingPlugins = reporting.getPlugins(); -<a class="jxr_linenumber" name="L234" href="#L234">234</a> -<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_comment">// MSITE-806: add default report plugin like done in maven-model-builder DefaultReportingConverter</em> -<a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">boolean</strong> hasMavenProjectInfoReportsPlugin = false; -<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">for</strong> (ReportPlugin plugin : reportingPlugins) { -<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"org.apache.maven.plugins"</span>.equals(plugin.getGroupId()) -<a class="jxr_linenumber" name="L239" href="#L239">239</a> && <span class="jxr_string">"maven-project-info-reports-plugin"</span>.equals(plugin.getArtifactId())) { -<a class="jxr_linenumber" name="L240" href="#L240">240</a> hasMavenProjectInfoReportsPlugin = <strong class="jxr_keyword">true</strong>; -<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">break</strong>; -<a class="jxr_linenumber" name="L242" href="#L242">242</a> } -<a class="jxr_linenumber" name="L243" href="#L243">243</a> } -<a class="jxr_linenumber" name="L244" href="#L244">244</a> -<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">if</strong> (!reporting.isExcludeDefaults() && !hasMavenProjectInfoReportsPlugin) { -<a class="jxr_linenumber" name="L246" href="#L246">246</a> ReportPlugin mpir = <strong class="jxr_keyword">new</strong> ReportPlugin(); -<a class="jxr_linenumber" name="L247" href="#L247">247</a> mpir.setArtifactId(<span class="jxr_string">"maven-project-info-reports-plugin"</span>); -<a class="jxr_linenumber" name="L248" href="#L248">248</a> reportingPlugins.add(mpir); +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_comment">// filter out reports that can't be generated</em> +<a class="jxr_linenumber" name="L207" href="#L207">207</a> List<MavenReportExecution> reportExecutions = <strong class="jxr_keyword">new</strong> ArrayList<>(allReports.size()); +<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">for</strong> (MavenReportExecution exec : allReports) { +<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">if</strong> (exec.canGenerateReport()) { +<a class="jxr_linenumber" name="L210" href="#L210">210</a> reportExecutions.add(exec); +<a class="jxr_linenumber" name="L211" href="#L211">211</a> } +<a class="jxr_linenumber" name="L212" href="#L212">212</a> } +<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">return</strong> reportExecutions; +<a class="jxr_linenumber" name="L214" href="#L214">214</a> } +<a class="jxr_linenumber" name="L215" href="#L215">215</a> +<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * Get the report plugins from reporting section, adding if necessary (i.e. not excluded)</em> +<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> * default reports (i.e. maven-project-info-reports)</em> +<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"> * @return the effective list of reports</em> +<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> * @since 3.7.1</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> <strong class="jxr_keyword">private</strong> ReportPlugin[] getReportingPlugins() { +<a class="jxr_linenumber" name="L224" href="#L224">224</a> List<ReportPlugin> reportingPlugins = reporting.getPlugins(); +<a class="jxr_linenumber" name="L225" href="#L225">225</a> +<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_comment">// MSITE-806: add default report plugin like done in maven-model-builder DefaultReportingConverter</em> +<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">boolean</strong> hasMavenProjectInfoReportsPlugin = false; +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">for</strong> (ReportPlugin plugin : reportingPlugins) { +<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"org.apache.maven.plugins"</span>.equals(plugin.getGroupId()) +<a class="jxr_linenumber" name="L230" href="#L230">230</a> && <span class="jxr_string">"maven-project-info-reports-plugin"</span>.equals(plugin.getArtifactId())) { +<a class="jxr_linenumber" name="L231" href="#L231">231</a> hasMavenProjectInfoReportsPlugin = <strong class="jxr_keyword">true</strong>; +<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">break</strong>; +<a class="jxr_linenumber" name="L233" href="#L233">233</a> } +<a class="jxr_linenumber" name="L234" href="#L234">234</a> } +<a class="jxr_linenumber" name="L235" href="#L235">235</a> +<a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">if</strong> (!reporting.isExcludeDefaults() && !hasMavenProjectInfoReportsPlugin) { +<a class="jxr_linenumber" name="L237" href="#L237">237</a> ReportPlugin mpir = <strong class="jxr_keyword">new</strong> ReportPlugin(); +<a class="jxr_linenumber" name="L238" href="#L238">238</a> mpir.setArtifactId(<span class="jxr_string">"maven-project-info-reports-plugin"</span>); +<a class="jxr_linenumber" name="L239" href="#L239">239</a> reportingPlugins.add(mpir); +<a class="jxr_linenumber" name="L240" href="#L240">240</a> } +<a class="jxr_linenumber" name="L241" href="#L241">241</a> <strong class="jxr_keyword">return</strong> reportingPlugins.toArray(<strong class="jxr_keyword">new</strong> ReportPlugin[reportingPlugins.size()]); +<a class="jxr_linenumber" name="L242" href="#L242">242</a> } +<a class="jxr_linenumber" name="L243" href="#L243">243</a> +<a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">protected</strong> SiteRenderingContext createSiteRenderingContext(Locale locale) +<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException, IOException, MojoFailureException { +<a class="jxr_linenumber" name="L246" href="#L246">246</a> DecorationModel decorationModel = prepareDecorationModel(locale); +<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">if</strong> (attributes == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L248" href="#L248">248</a> attributes = <strong class="jxr_keyword">new</strong> HashMap<>(); <a class="jxr_linenumber" name="L249" href="#L249">249</a> } -<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">return</strong> reportingPlugins.toArray(<strong class="jxr_keyword">new</strong> ReportPlugin[reportingPlugins.size()]); -<a class="jxr_linenumber" name="L251" href="#L251">251</a> } -<a class="jxr_linenumber" name="L252" href="#L252">252</a> -<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">protected</strong> SiteRenderingContext createSiteRenderingContext(Locale locale) -<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException, IOException, MojoFailureException { -<a class="jxr_linenumber" name="L255" href="#L255">255</a> DecorationModel decorationModel = prepareDecorationModel(locale); -<a class="jxr_linenumber" name="L256" href="#L256">256</a> <strong class="jxr_keyword">if</strong> (attributes == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L257" href="#L257">257</a> attributes = <strong class="jxr_keyword">new</strong> HashMap<>(); -<a class="jxr_linenumber" name="L258" href="#L258">258</a> } -<a class="jxr_linenumber" name="L259" href="#L259">259</a> -<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">if</strong> (attributes.get(<span class="jxr_string">"project"</span>) == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L261" href="#L261">261</a> attributes.put(<span class="jxr_string">"project"</span>, project); -<a class="jxr_linenumber" name="L262" href="#L262">262</a> } -<a class="jxr_linenumber" name="L263" href="#L263">263</a> -<a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong class="jxr_keyword">if</strong> (attributes.get(<span class="jxr_string">"inputEncoding"</span>) == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L265" href="#L265">265</a> attributes.put(<span class="jxr_string">"inputEncoding"</span>, getInputEncoding()); +<a class="jxr_linenumber" name="L250" href="#L250">250</a> +<a class="jxr_linenumber" name="L251" href="#L251">251</a> <strong class="jxr_keyword">if</strong> (attributes.get(<span class="jxr_string">"project"</span>) == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L252" href="#L252">252</a> attributes.put(<span class="jxr_string">"project"</span>, project); +<a class="jxr_linenumber" name="L253" href="#L253">253</a> } +<a class="jxr_linenumber" name="L254" href="#L254">254</a> +<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">if</strong> (attributes.get(<span class="jxr_string">"inputEncoding"</span>) == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L256" href="#L256">256</a> attributes.put(<span class="jxr_string">"inputEncoding"</span>, getInputEncoding()); +<a class="jxr_linenumber" name="L257" href="#L257">257</a> } +<a class="jxr_linenumber" name="L258" href="#L258">258</a> +<a class="jxr_linenumber" name="L259" href="#L259">259</a> <strong class="jxr_keyword">if</strong> (attributes.get(<span class="jxr_string">"outputEncoding"</span>) == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L260" href="#L260">260</a> attributes.put(<span class="jxr_string">"outputEncoding"</span>, getOutputEncoding()); +<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_comment">// Put any of the properties in directly into the Velocity context</em> +<a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong class="jxr_keyword">for</strong> (Map.Entry<Object, Object> entry : project.getProperties().entrySet()) { +<a class="jxr_linenumber" name="L265" href="#L265">265</a> attributes.put((String) entry.getKey(), entry.getValue()); <a class="jxr_linenumber" name="L266" href="#L266">266</a> } <a class="jxr_linenumber" name="L267" href="#L267">267</a> -<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">if</strong> (attributes.get(<span class="jxr_string">"outputEncoding"</span>) == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L269" href="#L269">269</a> attributes.put(<span class="jxr_string">"outputEncoding"</span>, getOutputEncoding()); -<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_comment">// Put any of the properties in directly into the Velocity context</em> -<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">for</strong> (Map.Entry<Object, Object> entry : project.getProperties().entrySet()) { -<a class="jxr_linenumber" name="L274" href="#L274">274</a> attributes.put((String) entry.getKey(), entry.getValue()); -<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> SiteRenderingContext context; -<a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L279" href="#L279">279</a> Artifact skinArtifact = -<a class="jxr_linenumber" name="L280" href="#L280">280</a> siteTool.getSkinArtifactFromRepository(localRepository, repositories, decorationModel); -<a class="jxr_linenumber" name="L281" href="#L281">281</a> -<a class="jxr_linenumber" name="L282" href="#L282">282</a> getLog().info(buffer().a(<span class="jxr_string">"Rendering content with "</span>) -<a class="jxr_linenumber" name="L283" href="#L283">283</a> .strong(skinArtifact.getId() + <span class="jxr_string">" skin"</span>) -<a class="jxr_linenumber" name="L284" href="#L284">284</a> .a('.') -<a class="jxr_linenumber" name="L285" href="#L285">285</a> .toString()); +<a class="jxr_linenumber" name="L268" href="#L268">268</a> SiteRenderingContext context; +<a class="jxr_linenumber" name="L269" href="#L269">269</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L270" href="#L270">270</a> Artifact skinArtifact = siteTool.getSkinArtifactFromRepository( +<a class="jxr_linenumber" name="L271" href="#L271">271</a> repoSession, remoteProjectRepositories, decorationModel.getSkin()); +<a class="jxr_linenumber" name="L272" href="#L272">272</a> +<a class="jxr_linenumber" name="L273" href="#L273">273</a> getLog().info(buffer().a(<span class="jxr_string">"Rendering content with "</span>) +<a class="jxr_linenumber" name="L274" href="#L274">274</a> .strong(skinArtifact.getId() + <span class="jxr_string">" skin"</span>) +<a class="jxr_linenumber" name="L275" href="#L275">275</a> .a('.') +<a class="jxr_linenumber" name="L276" href="#L276">276</a> .toString()); +<a class="jxr_linenumber" name="L277" href="#L277">277</a> +<a class="jxr_linenumber" name="L278" href="#L278">278</a> context = siteRenderer.createContextForSkin( +<a class="jxr_linenumber" name="L279" href="#L279">279</a> skinArtifact, attributes, decorationModel, project.getName(), locale); +<a class="jxr_linenumber" name="L280" href="#L280">280</a> } <strong class="jxr_keyword">catch</strong> (SiteToolException e) { +<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"SiteToolException while preparing skin: "</span> + e.getMessage(), e); +<a class="jxr_linenumber" name="L282" href="#L282">282</a> } <strong class="jxr_keyword">catch</strong> (RendererException e) { +<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( +<a class="jxr_linenumber" name="L284" href="#L284">284</a> <span class="jxr_string">"RendererException while preparing context for skin: "</span> + e.getMessage(), e); +<a class="jxr_linenumber" name="L285" href="#L285">285</a> } <a class="jxr_linenumber" name="L286" href="#L286">286</a> -<a class="jxr_linenumber" name="L287" href="#L287">287</a> context = siteRenderer.createContextForSkin( -<a class="jxr_linenumber" name="L288" href="#L288">288</a> skinArtifact, attributes, decorationModel, project.getName(), locale); -<a class="jxr_linenumber" name="L289" href="#L289">289</a> } <strong class="jxr_keyword">catch</strong> (SiteToolException e) { -<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"SiteToolException while preparing skin: "</span> + e.getMessage(), e); -<a class="jxr_linenumber" name="L291" href="#L291">291</a> } <strong class="jxr_keyword">catch</strong> (RendererException e) { -<a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( -<a class="jxr_linenumber" name="L293" href="#L293">293</a> <span class="jxr_string">"RendererException while preparing context for skin: "</span> + e.getMessage(), e); -<a class="jxr_linenumber" name="L294" href="#L294">294</a> } -<a class="jxr_linenumber" name="L295" href="#L295">295</a> -<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_comment">// Add publish date</em> -<a class="jxr_linenumber" name="L297" href="#L297">297</a> MavenProject p = attributes.get(<span class="jxr_string">"project"</span>) != <strong class="jxr_keyword">null</strong> ? (MavenProject) attributes.get(<span class="jxr_string">"project"</span>) : project; -<a class="jxr_linenumber" name="L298" href="#L298">298</a> String outputTimestamp = p.getProperties().getProperty(<span class="jxr_string">"project.build.outputTimestamp"</span>); -<a class="jxr_linenumber" name="L299" href="#L299">299</a> MavenArchiver.parseBuildOutputTimestamp(outputTimestamp).ifPresent(v -> { -<a class="jxr_linenumber" name="L300" href="#L300">300</a> context.setPublishDate(Date.from(v)); -<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> <em class="jxr_comment">// Generate static site</em> -<a class="jxr_linenumber" name="L304" href="#L304">304</a> context.setRootDirectory(project.getBasedir()); -<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">if</strong> (!locale.equals(SiteTool.DEFAULT_LOCALE)) { -<a class="jxr_linenumber" name="L306" href="#L306">306</a> context.addSiteDirectory(<strong class="jxr_keyword">new</strong> File(siteDirectory, locale.toString())); -<a class="jxr_linenumber" name="L307" href="#L307">307</a> context.addModuleDirectory(<strong class="jxr_keyword">new</strong> File(xdocDirectory, locale.toString()), <span class="jxr_string">"xdoc"</span>); -<a class="jxr_linenumber" name="L308" href="#L308">308</a> context.addModuleDirectory(<strong class="jxr_keyword">new</strong> File(xdocDirectory, locale.toString()), <span class="jxr_string">"fml"</span>); -<a class="jxr_linenumber" name="L309" href="#L309">309</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L310" href="#L310">310</a> context.addSiteDirectory(siteDirectory); -<a class="jxr_linenumber" name="L311" href="#L311">311</a> context.addModuleDirectory(xdocDirectory, <span class="jxr_string">"xdoc"</span>); -<a class="jxr_linenumber" name="L312" href="#L312">312</a> context.addModuleDirectory(xdocDirectory, <span class="jxr_string">"fml"</span>); -<a class="jxr_linenumber" name="L313" href="#L313">313</a> } -<a class="jxr_linenumber" name="L314" href="#L314">314</a> -<a class="jxr_linenumber" name="L315" href="#L315">315</a> <strong class="jxr_keyword">if</strong> (moduleExcludes != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L316" href="#L316">316</a> context.setModuleExcludes(moduleExcludes); -<a class="jxr_linenumber" name="L317" href="#L317">317</a> } -<a class="jxr_linenumber" name="L318" href="#L318">318</a> -<a class="jxr_linenumber" name="L319" href="#L319">319</a> <strong class="jxr_keyword">if</strong> (saveProcessedContent) { -<a class="jxr_linenumber" name="L320" href="#L320">320</a> context.setProcessedContentOutput(<strong class="jxr_keyword">new</strong> File(generatedSiteDirectory, <span class="jxr_string">"processed"</span>)); -<a class="jxr_linenumber" name="L321" href="#L321">321</a> } -<a class="jxr_linenumber" name="L322" href="#L322">322</a> -<a class="jxr_linenumber" name="L323" href="#L323">323</a> <strong class="jxr_keyword">return</strong> context; -<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> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> * Go through the list of reports and process each one like this:</em> -<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> * <ul></em> -<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> * <li>Add the report to a map of reports keyed by filename having the report itself as value</em> -<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * <li>If the report is not yet in the map of documents, add it together with a suitable renderer</em> -<a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> * </ul></em> -<a class="jxr_linenumber" name="L332" href="#L332">332</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L333" href="#L333">333</a> <em class="jxr_javadoccomment"> * @param reports A List of MavenReports</em> -<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment"> * @param documents A Map of documents, keyed by filename</em> -<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> * @param locale the Locale the reports are processed for.</em> -<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> * @return A map with all reports keyed by filename having the report itself as value.</em> -<a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> * The map will be used to populate a menu.</em> -<a class="jxr_linenumber" name="L338" href="#L338">338</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L339" href="#L339">339</a> <strong class="jxr_keyword">protected</strong> Map<String, MavenReport> locateReports( -<a class="jxr_linenumber" name="L340" href="#L340">340</a> List<MavenReportExecution> reports, Map<String, DocumentRenderer> documents, Locale locale) { -<a class="jxr_linenumber" name="L341" href="#L341">341</a> Map<String, MavenReport> reportsByOutputName = <strong class="jxr_keyword">new</strong> LinkedHashMap<>(); -<a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong class="jxr_keyword">for</strong> (MavenReportExecution mavenReportExecution : reports) { -<a class="jxr_linenumber" name="L343" href="#L343">343</a> MavenReport report = mavenReportExecution.getMavenReport(); +<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_comment">// Add publish date</em> +<a class="jxr_linenumber" name="L288" href="#L288">288</a> MavenProject p = attributes.get(<span class="jxr_string">"project"</span>) != <strong class="jxr_keyword">null</strong> ? (MavenProject) attributes.get(<span class="jxr_string">"project"</span>) : project; +<a class="jxr_linenumber" name="L289" href="#L289">289</a> String outputTimestamp = p.getProperties().getProperty(<span class="jxr_string">"project.build.outputTimestamp"</span>); +<a class="jxr_linenumber" name="L290" href="#L290">290</a> MavenArchiver.parseBuildOutputTimestamp(outputTimestamp).ifPresent(v -> { +<a class="jxr_linenumber" name="L291" href="#L291">291</a> context.setPublishDate(Date.from(v)); +<a class="jxr_linenumber" name="L292" href="#L292">292</a> }); +<a class="jxr_linenumber" name="L293" href="#L293">293</a> +<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_comment">// Generate static site</em> +<a class="jxr_linenumber" name="L295" href="#L295">295</a> context.setRootDirectory(project.getBasedir()); +<a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong class="jxr_keyword">if</strong> (!locale.equals(SiteTool.DEFAULT_LOCALE)) { +<a class="jxr_linenumber" name="L297" href="#L297">297</a> context.addSiteDirectory(<strong class="jxr_keyword">new</strong> File(siteDirectory, locale.toString())); +<a class="jxr_linenumber" name="L298" href="#L298">298</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L299" href="#L299">299</a> context.addSiteDirectory(siteDirectory); +<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> <strong class="jxr_keyword">if</strong> (moduleExcludes != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L303" href="#L303">303</a> context.setModuleExcludes(moduleExcludes); +<a class="jxr_linenumber" name="L304" href="#L304">304</a> } +<a class="jxr_linenumber" name="L305" href="#L305">305</a> +<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong class="jxr_keyword">if</strong> (saveProcessedContent) { +<a class="jxr_linenumber" name="L307" href="#L307">307</a> context.setProcessedContentOutput(<strong class="jxr_keyword">new</strong> File(generatedSiteDirectory, <span class="jxr_string">"processed"</span>)); +<a class="jxr_linenumber" name="L308" href="#L308">308</a> } +<a class="jxr_linenumber" name="L309" href="#L309">309</a> +<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">return</strong> context; +<a class="jxr_linenumber" name="L311" href="#L311">311</a> } +<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"> * Go through the list of reports and process each one like this:</em> +<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> * <li>Add the report to a map of reports keyed by filename having the report itself as value</em> +<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> * <li>If the report is not yet in the map of documents, add it together with a suitable renderer</em> +<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> * @param reports A List of MavenReports</em> +<a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> * @param documents A Map of documents, keyed by filename</em> +<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> * @param locale the Locale the reports are processed for.</em> +<a class="jxr_linenumber" name="L323" href="#L323">323</a> <em class="jxr_javadoccomment"> * @return A map with all reports keyed by filename having the report itself as value.</em> +<a class="jxr_linenumber" name="L324" href="#L324">324</a> <em class="jxr_javadoccomment"> * The map will be used to populate a menu.</em> +<a class="jxr_linenumber" name="L325" href="#L325">325</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L326" href="#L326">326</a> <strong class="jxr_keyword">protected</strong> Map<String, MavenReport> locateReports( +<a class="jxr_linenumber" name="L327" href="#L327">327</a> List<MavenReportExecution> reports, Map<String, DocumentRenderer> documents, Locale locale) { +<a class="jxr_linenumber" name="L328" href="#L328">328</a> Map<String, MavenReport> reportsByOutputName = <strong class="jxr_keyword">new</strong> LinkedHashMap<>(); +<a class="jxr_linenumber" name="L329" href="#L329">329</a> <strong class="jxr_keyword">for</strong> (MavenReportExecution mavenReportExecution : reports) { +<a class="jxr_linenumber" name="L330" href="#L330">330</a> MavenReport report = mavenReportExecution.getMavenReport(); +<a class="jxr_linenumber" name="L331" href="#L331">331</a> +<a class="jxr_linenumber" name="L332" href="#L332">332</a> String outputName = report.getOutputName() + <span class="jxr_string">".html"</span>; +<a class="jxr_linenumber" name="L333" href="#L333">333</a> +<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_comment">// Always add the report to the menu, see MSITE-150</em> +<a class="jxr_linenumber" name="L335" href="#L335">335</a> reportsByOutputName.put(report.getOutputName(), report); +<a class="jxr_linenumber" name="L336" href="#L336">336</a> +<a class="jxr_linenumber" name="L337" href="#L337">337</a> <strong class="jxr_keyword">if</strong> (documents.containsKey(outputName)) { +<a class="jxr_linenumber" name="L338" href="#L338">338</a> String reportMojoInfo = (mavenReportExecution.getGoal() == <strong class="jxr_keyword">null</strong>) +<a class="jxr_linenumber" name="L339" href="#L339">339</a> ? <span class="jxr_string">""</span> +<a class="jxr_linenumber" name="L340" href="#L340">340</a> : (<span class="jxr_string">" ("</span> +<a class="jxr_linenumber" name="L341" href="#L341">341</a> + mavenReportExecution.getPlugin().getArtifactId() + ':' +<a class="jxr_linenumber" name="L342" href="#L342">342</a> + mavenReportExecution.getPlugin().getVersion() + ':' + mavenReportExecution.getGoal() +<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> String outputName = report.getOutputName() + <span class="jxr_string">".html"</span>; -<a class="jxr_linenumber" name="L346" href="#L346">346</a> -<a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_comment">// Always add the report to the menu, see MSITE-150</em> -<a class="jxr_linenumber" name="L348" href="#L348">348</a> reportsByOutputName.put(report.getOutputName(), report); -<a class="jxr_linenumber" name="L349" href="#L349">349</a> -<a class="jxr_linenumber" name="L350" href="#L350">350</a> <strong class="jxr_keyword">if</strong> (documents.containsKey(outputName)) { -<a class="jxr_linenumber" name="L351" href="#L351">351</a> String reportMojoInfo = (mavenReportExecution.getGoal() == <strong class="jxr_keyword">null</strong>) -<a class="jxr_linenumber" name="L352" href="#L352">352</a> ? <span class="jxr_string">""</span> -<a class="jxr_linenumber" name="L353" href="#L353">353</a> : (<span class="jxr_string">" ("</span> -<a class="jxr_linenumber" name="L354" href="#L354">354</a> + mavenReportExecution.getPlugin().getArtifactId() + ':' -<a class="jxr_linenumber" name="L355" href="#L355">355</a> + mavenReportExecution.getPlugin().getVersion() + ':' + mavenReportExecution.getGoal() -<a class="jxr_linenumber" name="L356" href="#L356">356</a> + ')'); -<a class="jxr_linenumber" name="L357" href="#L357">357</a> -<a class="jxr_linenumber" name="L358" href="#L358">358</a> getLog().info(<span class="jxr_string">"Skipped \""</span> + report.getName(locale) + <span class="jxr_string">"\" report"</span> + reportMojoInfo + <span class="jxr_string">", file \""</span> -<a class="jxr_linenumber" name="L359" href="#L359">359</a> + outputName + <span class="jxr_string">"\" already exists."</span>); -<a class="jxr_linenumber" name="L360" href="#L360">360</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L361" href="#L361">361</a> String reportMojoInfo = mavenReportExecution.getPlugin().getGroupId() -<a class="jxr_linenumber" name="L362" href="#L362">362</a> + ':' -<a class="jxr_linenumber" name="L363" href="#L363">363</a> + mavenReportExecution.getPlugin().getArtifactId() -<a class="jxr_linenumber" name="L364" href="#L364">364</a> + ':' -<a class="jxr_linenumber" name="L365" href="#L365">365</a> + mavenReportExecution.getPlugin().getVersion() -<a class="jxr_linenumber" name="L366" href="#L366">366</a> + ':' -<a class="jxr_linenumber" name="L367" href="#L367">367</a> + mavenReportExecution.getGoal(); -<a class="jxr_linenumber" name="L368" href="#L368">368</a> RenderingContext renderingContext = <strong class="jxr_keyword">new</strong> RenderingContext(siteDirectory, outputName, reportMojoInfo); -<a class="jxr_linenumber" name="L369" href="#L369">369</a> DocumentRenderer renderer = -<a class="jxr_linenumber" name="L370" href="#L370">370</a> <strong class="jxr_keyword">new</strong> <a name="ReportDocumentRenderer" href="../../../../../../org/apache/maven/plugins/site/render/ReportDocumentRenderer.html#ReportDocumentRenderer">ReportDocumentRenderer</a>(mavenReportExecution, renderingContext, getLog()); -<a class="jxr_linenumber" name="L371" href="#L371">371</a> documents.put(outputName, renderer); -<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> <strong class="jxr_keyword">return</strong> reportsByOutputName; -<a class="jxr_linenumber" name="L375" href="#L375">375</a> } -<a class="jxr_linenumber" name="L376" href="#L376">376</a> -<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> <em class="jxr_javadoccomment"> * Go through the collection of reports and put each report into a list for the appropriate category. The list is</em> -<a class="jxr_linenumber" name="L379" href="#L379">379</a> <em class="jxr_javadoccomment"> * put into a map keyed by the name of the category.</em> -<a class="jxr_linenumber" name="L380" href="#L380">380</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L381" href="#L381">381</a> <em class="jxr_javadoccomment"> * @param reports A Collection of MavenReports</em> -<a class="jxr_linenumber" name="L382" href="#L382">382</a> <em class="jxr_javadoccomment"> * @return A map keyed category having the report itself as value</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> <strong class="jxr_keyword">protected</strong> Map<String, List<MavenReport>> categoriseReports(Collection<MavenReport> reports) { -<a class="jxr_linenumber" name="L385" href="#L385">385</a> Map<String, List<MavenReport>> categories = <strong class="jxr_keyword">new</strong> LinkedHashMap<>(); -<a class="jxr_linenumber" name="L386" href="#L386">386</a> <strong class="jxr_keyword">for</strong> (MavenReport report : reports) { -<a class="jxr_linenumber" name="L387" href="#L387">387</a> List<MavenReport> categoryReports = categories.get(report.getCategoryName()); -<a class="jxr_linenumber" name="L388" href="#L388">388</a> <strong class="jxr_keyword">if</strong> (categoryReports == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L389" href="#L389">389</a> categoryReports = <strong class="jxr_keyword">new</strong> ArrayList<>(); -<a class="jxr_linenumber" name="L390" href="#L390">390</a> categories.put(report.getCategoryName(), categoryReports); -<a class="jxr_linenumber" name="L391" href="#L391">391</a> } -<a class="jxr_linenumber" name="L392" href="#L392">392</a> categoryReports.add(report); -<a class="jxr_linenumber" name="L393" href="#L393">393</a> } -<a class="jxr_linenumber" name="L394" href="#L394">394</a> <strong class="jxr_keyword">return</strong> categories; -<a class="jxr_linenumber" name="L395" href="#L395">395</a> } -<a class="jxr_linenumber" name="L396" href="#L396">396</a> -<a class="jxr_linenumber" name="L397" href="#L397">397</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L398" href="#L398">398</a> <em class="jxr_javadoccomment"> * Locate every document to be rendered for given locale:<ul></em> -<a class="jxr_linenumber" name="L399" href="#L399">399</a> <em class="jxr_javadoccomment"> * <li>handwritten content, ie Doxia files,</li></em> -<a class="jxr_linenumber" name="L400" href="#L400">400</a> <em class="jxr_javadoccomment"> * <li>reports,</li></em> -<a class="jxr_linenumber" name="L401" href="#L401">401</a> <em class="jxr_javadoccomment"> * <li>"Project Information" and "Project Reports" category summaries.</li></em> -<a class="jxr_linenumber" name="L402" href="#L402">402</a> <em class="jxr_javadoccomment"> * </ul></em> -<a class="jxr_linenumber" name="L403" href="#L403">403</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L404" href="#L404">404</a> <em class="jxr_javadoccomment"> * @param context the site context</em> -<a class="jxr_linenumber" name="L405" href="#L405">405</a> <em class="jxr_javadoccomment"> * @param reports the documents</em> -<a class="jxr_linenumber" name="L406" href="#L406">406</a> <em class="jxr_javadoccomment"> * @param locale the locale</em> -<a class="jxr_linenumber" name="L407" href="#L407">407</a> <em class="jxr_javadoccomment"> * @return the documents and their renderers</em> -<a class="jxr_linenumber" name="L408" href="#L408">408</a> <em class="jxr_javadoccomment"> * @throws IOException in case of file reading issue</em> -<a class="jxr_linenumber" name="L409" href="#L409">409</a> <em class="jxr_javadoccomment"> * @throws RendererException in case of Doxia rendering issue</em> -<a class="jxr_linenumber" name="L410" href="#L410">410</a> <em class="jxr_javadoccomment"> * @see CategorySummaryDocumentRenderer</em> -<a class="jxr_linenumber" name="L411" href="#L411">411</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L412" href="#L412">412</a> <strong class="jxr_keyword">protected</strong> Map<String, DocumentRenderer> locateDocuments( -<a class="jxr_linenumber" name="L413" href="#L413">413</a> SiteRenderingContext context, List<MavenReportExecution> reports, Locale locale) -<a class="jxr_linenumber" name="L414" href="#L414">414</a> <strong class="jxr_keyword">throws</strong> IOException, RendererException { -<a class="jxr_linenumber" name="L415" href="#L415">415</a> Map<String, DocumentRenderer> documents = siteRenderer.locateDocumentFiles(context, <strong class="jxr_keyword">true</strong>); -<a class="jxr_linenumber" name="L416" href="#L416">416</a> -<a class="jxr_linenumber" name="L417" href="#L417">417</a> Map<String, MavenReport> reportsByOutputName = locateReports(reports, documents, locale); -<a class="jxr_linenumber" name="L418" href="#L418">418</a> -<a class="jxr_linenumber" name="L419" href="#L419">419</a> <em class="jxr_comment">// TODO: I want to get rid of categories eventually. There's no way to add your own in a fully i18n manner</em> -<a class="jxr_linenumber" name="L420" href="#L420">420</a> Map<String, List<MavenReport>> categories = categoriseReports(reportsByOutputName.values()); -<a class="jxr_linenumber" name="L421" href="#L421">421</a> -<a class="jxr_linenumber" name="L422" href="#L422">422</a> siteTool.populateReportsMenu(context.getDecoration(), locale, categories); -<a class="jxr_linenumber" name="L423" href="#L423">423</a> populateReportItems(context.getDecoration(), locale, reportsByOutputName); -<a class="jxr_linenumber" name="L424" href="#L424">424</a> -<a class="jxr_linenumber" name="L425" href="#L425">425</a> <strong class="jxr_keyword">if</strong> (categories.containsKey(MavenReport.CATEGORY_PROJECT_INFORMATION) && generateProjectInfo) { -<a class="jxr_linenumber" name="L426" href="#L426">426</a> <em class="jxr_comment">// add "Project Information" category summary document</em> -<a class="jxr_linenumber" name="L427" href="#L427">427</a> List<MavenReport> categoryReports = categories.get(MavenReport.CATEGORY_PROJECT_INFORMATION); -<a class="jxr_linenumber" name="L428" href="#L428">428</a> -<a class="jxr_linenumber" name="L429" href="#L429">429</a> RenderingContext renderingContext = <strong class="jxr_keyword">new</strong> RenderingContext( -<a class="jxr_linenumber" name="L430" href="#L430">430</a> siteDirectory, <span class="jxr_string">"project-info.html"</span>, getSitePluginInfo() + <span class="jxr_string">":CategorySummaryDocumentRenderer"</span>); -<a class="jxr_linenumber" name="L431" href="#L431">431</a> String title = i18n.getString(<span class="jxr_string">"site-plugin"</span>, locale, <span class="jxr_string">"report.information.title"</span>); -<a class="jxr_linenumber" name="L432" href="#L432">432</a> String desc1 = i18n.getString(<span class="jxr_string">"site-plugin"</span>, locale, <span class="jxr_string">"report.information.description1"</span>); -<a class="jxr_linenumber" name="L433" href="#L433">433</a> String desc2 = i18n.getString(<span class="jxr_string">"site-plugin"</span>, locale, <span class="jxr_string">"report.information.description2"</span>); -<a class="jxr_linenumber" name="L434" href="#L434">434</a> DocumentRenderer renderer = <strong class="jxr_keyword">new</strong> <a name="CategorySummaryDocumentRenderer" href="../../../../../../org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html#CategorySummaryDocumentRenderer">CategorySummaryDocumentRenderer</a>( -<a class="jxr_linenumber" name="L435" href="#L435">435</a> renderingContext, title, desc1, desc2, i18n, categoryReports, getLog()); -<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> (!documents.containsKey(renderer.getOutputName())) { -<a class="jxr_linenumber" name="L438" href="#L438">438</a> documents.put(renderer.getOutputName(), renderer); -<a class="jxr_linenumber" name="L439" href="#L439">439</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L440" href="#L440">440</a> getLog().info(<span class="jxr_string">"Category summary '"</span> + renderer.getOutputName() + <span class="jxr_string">"' skipped; already exists"</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> -<a class="jxr_linenumber" name="L444" href="#L444">444</a> <strong class="jxr_keyword">if</strong> (categories.containsKey(MavenReport.CATEGORY_PROJECT_REPORTS)) { -<a class="jxr_linenumber" name="L445" href="#L445">445</a> <em class="jxr_comment">// add "Project Reports" category summary document</em> -<a class="jxr_linenumber" name="L446" href="#L446">446</a> List<MavenReport> categoryReports = categories.get(MavenReport.CATEGORY_PROJECT_REPORTS); -<a class="jxr_linenumber" name="L447" href="#L447">447</a> RenderingContext renderingContext = <strong class="jxr_keyword">new</strong> RenderingContext( -<a class="jxr_linenumber" name="L448" href="#L448">448</a> siteDirectory, <span class="jxr_string">"project-reports.html"</span>, getSitePluginInfo() + <span class="jxr_string">":CategorySummaryDocumentRenderer"</span>); -<a class="jxr_linenumber" name="L449" href="#L449">449</a> String title = i18n.getString(<span class="jxr_string">"site-plugin"</span>, locale, <span class="jxr_string">"report.project.title"</span>); -<a class="jxr_linenumber" name="L450" href="#L450">450</a> String desc1 = i18n.getString(<span class="jxr_string">"site-plugin"</span>, locale, <span class="jxr_string">"report.project.description1"</span>); -<a class="jxr_linenumber" name="L451" href="#L451">451</a> String desc2 = i18n.getString(<span class="jxr_string">"site-plugin"</span>, locale, <span class="jxr_string">"report.project.description2"</span>); -<a class="jxr_linenumber" name="L452" href="#L452">452</a> DocumentRenderer renderer = <strong class="jxr_keyword">new</strong> <a name="CategorySummaryDocumentRenderer" href="../../../../../../org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html#CategorySummaryDocumentRenderer">CategorySummaryDocumentRenderer</a>( -<a class="jxr_linenumber" name="L453" href="#L453">453</a> renderingContext, title, desc1, desc2, i18n, categoryReports, getLog()); -<a class="jxr_linenumber" name="L454" href="#L454">454</a> -<a class="jxr_linenumber" name="L455" href="#L455">455</a> <strong class="jxr_keyword">if</strong> (!documents.containsKey(renderer.getOutputName())) { -<a class="jxr_linenumber" name="L456" href="#L456">456</a> documents.put(renderer.getOutputName(), renderer); -<a class="jxr_linenumber" name="L457" href="#L457">457</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L458" href="#L458">458</a> getLog().info(<span class="jxr_string">"Category summary '"</span> + renderer.getOutputName() + <span class="jxr_string">"' skipped; already exists"</span>); -<a class="jxr_linenumber" name="L459" href="#L459">459</a> } -<a class="jxr_linenumber" name="L460" href="#L460">460</a> } -<a class="jxr_linenumber" name="L461" href="#L461">461</a> <strong class="jxr_keyword">return</strong> documents; +<a class="jxr_linenumber" name="L345" href="#L345">345</a> getLog().info(<span class="jxr_string">"Skipped \""</span> + report.getName(locale) + <span class="jxr_string">"\" report"</span> + reportMojoInfo + <span class="jxr_string">", file \""</span> +<a class="jxr_linenumber" name="L346" href="#L346">346</a> + outputName + <span class="jxr_string">"\" already exists."</span>); +<a class="jxr_linenumber" name="L347" href="#L347">347</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L348" href="#L348">348</a> String reportMojoInfo = mavenReportExecution.getPlugin().getGroupId() +<a class="jxr_linenumber" name="L349" href="#L349">349</a> + ':' +<a class="jxr_linenumber" name="L350" href="#L350">350</a> + mavenReportExecution.getPlugin().getArtifactId() +<a class="jxr_linenumber" name="L351" href="#L351">351</a> + ':' +<a class="jxr_linenumber" name="L352" href="#L352">352</a> + mavenReportExecution.getPlugin().getVersion() +<a class="jxr_linenumber" name="L353" href="#L353">353</a> + ':' +<a class="jxr_linenumber" name="L354" href="#L354">354</a> + mavenReportExecution.getGoal(); +<a class="jxr_linenumber" name="L355" href="#L355">355</a> RenderingContext docRenderingContext = <strong class="jxr_keyword">new</strong> RenderingContext(siteDirectory, outputName, reportMojoInfo); +<a class="jxr_linenumber" name="L356" href="#L356">356</a> DocumentRenderer docRenderer = +<a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong class="jxr_keyword">new</strong> <a name="ReportDocumentRenderer" href="../../../../../../org/apache/maven/plugins/site/render/ReportDocumentRenderer.html#ReportDocumentRenderer">ReportDocumentRenderer</a>(mavenReportExecution, docRenderingContext, getLog()); +<a class="jxr_linenumber" name="L358" href="#L358">358</a> documents.put(outputName, docRenderer); +<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">return</strong> reportsByOutputName; +<a class="jxr_linenumber" name="L362" href="#L362">362</a> } +<a class="jxr_linenumber" name="L363" href="#L363">363</a> +<a class="jxr_linenumber" name="L364" href="#L364">364</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L365" href="#L365">365</a> <em class="jxr_javadoccomment"> * Go through the collection of reports and put each report into a list for the appropriate category. The list is</em> +<a class="jxr_linenumber" name="L366" href="#L366">366</a> <em class="jxr_javadoccomment"> * put into a map keyed by the name of the category.</em> +<a class="jxr_linenumber" name="L367" href="#L367">367</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L368" href="#L368">368</a> <em class="jxr_javadoccomment"> * @param reports A Collection of MavenReports</em> +<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment"> * @return A map keyed category having the report itself as value</em> +<a class="jxr_linenumber" name="L370" href="#L370">370</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L371" href="#L371">371</a> <strong class="jxr_keyword">protected</strong> Map<String, List<MavenReport>> categoriseReports(Collection<MavenReport> reports) { +<a class="jxr_linenumber" name="L372" href="#L372">372</a> Map<String, List<MavenReport>> categories = <strong class="jxr_keyword">new</strong> LinkedHashMap<>(); +<a class="jxr_linenumber" name="L373" href="#L373">373</a> <strong class="jxr_keyword">for</strong> (MavenReport report : reports) { +<a class="jxr_linenumber" name="L374" href="#L374">374</a> List<MavenReport> categoryReports = categories.get(report.getCategoryName()); +<a class="jxr_linenumber" name="L375" href="#L375">375</a> <strong class="jxr_keyword">if</strong> (categoryReports == <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L376" href="#L376">376</a> categoryReports = <strong class="jxr_keyword">new</strong> ArrayList<>(); +<a class="jxr_linenumber" name="L377" href="#L377">377</a> categories.put(report.getCategoryName(), categoryReports); +<a class="jxr_linenumber" name="L378" href="#L378">378</a> } +<a class="jxr_linenumber" name="L379" href="#L379">379</a> categoryReports.add(report); +<a class="jxr_linenumber" name="L380" href="#L380">380</a> } +<a class="jxr_linenumber" name="L381" href="#L381">381</a> <strong class="jxr_keyword">return</strong> categories; +<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> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L385" href="#L385">385</a> <em class="jxr_javadoccomment"> * Locate every document to be rendered for given locale:<ul></em> +<a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_javadoccomment"> * <li>handwritten content, ie Doxia files,</li></em> +<a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_javadoccomment"> * <li>reports,</li></em> +<a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_javadoccomment"> * <li>"Project Information" and "Project Reports" category summaries.</li></em> +<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L390" href="#L390">390</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L391" href="#L391">391</a> <em class="jxr_javadoccomment"> * @param context the site context</em> +<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em class="jxr_javadoccomment"> * @param reports the documents</em> +<a class="jxr_linenumber" name="L393" href="#L393">393</a> <em class="jxr_javadoccomment"> * @param locale the locale</em> +<a class="jxr_linenumber" name="L394" href="#L394">394</a> <em class="jxr_javadoccomment"> * @return the documents and their renderers</em> +<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em class="jxr_javadoccomment"> * @throws IOException in case of file reading issue</em> +<a class="jxr_linenumber" name="L396" href="#L396">396</a> <em class="jxr_javadoccomment"> * @throws RendererException in case of Doxia rendering issue</em> +<a class="jxr_linenumber" name="L397" href="#L397">397</a> <em class="jxr_javadoccomment"> * @see CategorySummaryDocumentRenderer</em> +<a class="jxr_linenumber" name="L398" href="#L398">398</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L399" href="#L399">399</a> <strong class="jxr_keyword">protected</strong> Map<String, DocumentRenderer> locateDocuments( +<a class="jxr_linenumber" name="L400" href="#L400">400</a> SiteRenderingContext context, List<MavenReportExecution> reports, Locale locale) +<a class="jxr_linenumber" name="L401" href="#L401">401</a> <strong class="jxr_keyword">throws</strong> IOException, RendererException { +<a class="jxr_linenumber" name="L402" href="#L402">402</a> Map<String, DocumentRenderer> documents = siteRenderer.locateDocumentFiles(context, <strong class="jxr_keyword">true</strong>); +<a class="jxr_linenumber" name="L403" href="#L403">403</a> +<a class="jxr_linenumber" name="L404" href="#L404">404</a> Map<String, MavenReport> reportsByOutputName = locateReports(reports, documents, locale); +<a class="jxr_linenumber" name="L405" href="#L405">405</a> +<a class="jxr_linenumber" name="L406" href="#L406">406</a> <em class="jxr_comment">// TODO: I want to get rid of categories eventually. There's no way to add your own in a fully i18n manner</em> +<a class="jxr_linenumber" name="L407" href="#L407">407</a> Map<String, List<MavenReport>> categories = categoriseReports(reportsByOutputName.values()); +<a class="jxr_linenumber" name="L408" href="#L408">408</a> +<a class="jxr_linenumber" name="L409" href="#L409">409</a> siteTool.populateReportsMenu(context.getDecoration(), locale, categories); +<a class="jxr_linenumber" name="L410" href="#L410">410</a> populateReportItems(context.getDecoration(), locale, reportsByOutputName); +<a class="jxr_linenumber" name="L411" href="#L411">411</a> +<a class="jxr_linenumber" name="L412" href="#L412">412</a> <strong class="jxr_keyword">if</strong> (categories.containsKey(MavenReport.CATEGORY_PROJECT_INFORMATION) && generateProjectInfo) { +<a class="jxr_linenumber" name="L413" href="#L413">413</a> <em class="jxr_comment">// add "Project Information" category summary document</em> +<a class="jxr_linenumber" name="L414" href="#L414">414</a> List<MavenReport> categoryReports = categories.get(MavenReport.CATEGORY_PROJECT_INFORMATION); +<a class="jxr_linenumber" name="L415" href="#L415">415</a> +<a class="jxr_linenumber" name="L416" href="#L416">416</a> RenderingContext docRenderingContext = <strong class="jxr_keyword">new</strong> RenderingContext( +<a class="jxr_linenumber" name="L417" href="#L417">417</a> siteDirectory, <span class="jxr_string">"project-info.html"</span>, getSitePluginInfo() + <span class="jxr_string">":CategorySummaryDocumentRenderer"</span>); +<a class="jxr_linenumber" name="L418" href="#L418">418</a> String title = i18n.getString(<span class="jxr_string">"site-plugin"</span>, locale, <span class="jxr_string">"report.information.title"</span>); +<a class="jxr_linenumber" name="L419" href="#L419">419</a> String desc1 = i18n.getString(<span class="jxr_string">"site-plugin"</span>, locale, <span class="jxr_string">"report.information.description1"</span>); +<a class="jxr_linenumber" name="L420" href="#L420">420</a> String desc2 = i18n.getString(<span class="jxr_string">"site-plugin"</span>, locale, <span class="jxr_string">"report.information.description2"</span>); +<a class="jxr_linenumber" name="L421" href="#L421">421</a> DocumentRenderer docRenderer = <strong class="jxr_keyword">new</strong> <a name="CategorySummaryDocumentRenderer" href="../../../../../../org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.html#CategorySummaryDocumentRenderer">CategorySummaryDocumentRenderer</a>( +<a class="jxr_linenumber" name="L422" href="#L422">422</a> docRenderingContext, title, desc1, desc2, i18n, categoryReports, getLog()); +<a class="jxr_linenumber" name="L423" href="#L423">423</a> +<a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong class="jxr_keyword">if</strong> (!documents.containsKey(docRenderer.getOutputName())) { +<a class="jxr_linenumber" name="L425" href="#L425">425</a> documents.put(docRenderer.getOutputName(), docRenderer); +<a class="jxr_linenumber" name="L426" href="#L426">426</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L427" href="#L427">427</a> getLog().info(<span class="jxr_string">"Category summary '"</span> + docRenderer.getOutputName() + <span class="jxr_string">"' skipped; already exists"</span>); +<a class="jxr_linenumber" name="L428" href="#L428">428</a> } +<a class="jxr_linenumber" name="L429" href="#L429">429</a> } +<a class="jxr_linenumber" name="L430" href="#L430">430</a> +<a class="jxr_linenumber" name="L431" href="#L431">431</a> <strong class="jxr_keyword">if</strong> (categories.containsKey(MavenReport.CATEGORY_PROJECT_REPORTS)) {
[... 99 lines stripped ...]
