Modified:
maven/website/components/shared-archives/maven-reporting-impl-LATEST/xref/org/apache/maven/reporting/AbstractMavenReport.html
==============================================================================
---
maven/website/components/shared-archives/maven-reporting-impl-LATEST/xref/org/apache/maven/reporting/AbstractMavenReport.html
(original)
+++
maven/website/components/shared-archives/maven-reporting-impl-LATEST/xref/org/apache/maven/reporting/AbstractMavenReport.html
Sun Apr 2 13:52:53 2023
@@ -41,10 +41,10 @@
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.artifact.Artifact;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.Sink;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.SinkFactory;
-<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.site.decoration.DecorationModel;
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.Renderer;
-<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.RendererException;
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.RenderingContext;
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.doxia.site.SiteModel;
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.DocumentRenderingContext;
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.Renderer;
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.RendererException;
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.SiteRenderingContext;
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.doxia.tools.SiteTool;
@@ -232,223 +232,224 @@
<a class="jxr_linenumber" name="L224" href="#L224">224</a>
getSiteRenderer().copyResources(siteContext, outputDirectory);
<a class="jxr_linenumber" name="L225" href="#L225">225</a>
<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em
class="jxr_comment">// TODO Replace null with real value</em>
-<a class="jxr_linenumber" name="L227" href="#L227">227</a>
RenderingContext docRenderingContext = <strong class="jxr_keyword">new</strong>
RenderingContext(outputDirectory, filename, <strong
class="jxr_keyword">null</strong>);
-<a class="jxr_linenumber" name="L228" href="#L228">228</a>
-<a class="jxr_linenumber" name="L229" href="#L229">229</a>
SiteRendererSink sink = <strong class="jxr_keyword">new</strong>
SiteRendererSink(docRenderingContext);
-<a class="jxr_linenumber" name="L230" href="#L230">230</a>
-<a class="jxr_linenumber" name="L231" href="#L231">231</a>
generate(sink, <strong class="jxr_keyword">null</strong>, locale);
-<a class="jxr_linenumber" name="L232" href="#L232">232</a>
-<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong
class="jxr_keyword">if</strong> (!isExternalReport()) <em
class="jxr_comment">// MSHARED-204: only render Doxia sink if not an external
report</em>
-<a class="jxr_linenumber" name="L234" href="#L234">234</a> {
-<a class="jxr_linenumber" name="L235" href="#L235">235</a>
outputDirectory.mkdirs();
-<a class="jxr_linenumber" name="L236" href="#L236">236</a>
-<a class="jxr_linenumber" name="L237" href="#L237">237</a>
<strong class="jxr_keyword">try</strong> (Writer writer = <strong
class="jxr_keyword">new</strong> OutputStreamWriter(
-<a class="jxr_linenumber" name="L238" href="#L238">238</a>
<strong class="jxr_keyword">new</strong> FileOutputStream(<strong
class="jxr_keyword">new</strong> File(outputDirectory, filename)),
getOutputEncoding())) {
-<a class="jxr_linenumber" name="L239" href="#L239">239</a>
<em class="jxr_comment">// render report</em>
-<a class="jxr_linenumber" name="L240" href="#L240">240</a>
getSiteRenderer().mergeDocumentIntoSite(writer, sink, siteContext);
-<a class="jxr_linenumber" name="L241" href="#L241">241</a> }
-<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> <em
class="jxr_comment">// copy generated resources also</em>
-<a class="jxr_linenumber" name="L245" href="#L245">245</a>
getSiteRenderer().copyResources(siteContext, outputDirectory);
-<a class="jxr_linenumber" name="L246" href="#L246">246</a> } <strong
class="jxr_keyword">catch</strong> (RendererException | IOException |
MavenReportException | SiteToolException e) {
-<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
MojoExecutionException(
-<a class="jxr_linenumber" name="L248" href="#L248">248</a>
<span class="jxr_string">"An error has occurred in "</span> +
getName(Locale.ENGLISH) + <span class="jxr_string">" report
generation."</span>, e);
-<a class="jxr_linenumber" name="L249" href="#L249">249</a> }
-<a class="jxr_linenumber" name="L250" href="#L250">250</a> }
-<a class="jxr_linenumber" name="L251" href="#L251">251</a>
-<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong
class="jxr_keyword">private</strong> SiteRenderingContext
createSiteRenderingContext(Locale locale)
-<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong
class="jxr_keyword">throws</strong> MavenReportException, IOException,
SiteToolException {
-<a class="jxr_linenumber" name="L254" href="#L254">254</a>
DecorationModel decorationModel = siteTool.getDecorationModel(
-<a class="jxr_linenumber" name="L255" href="#L255">255</a>
siteDirectory, locale, project, reactorProjects, repoSession,
remoteProjectRepositories);
-<a class="jxr_linenumber" name="L256" href="#L256">256</a>
-<a class="jxr_linenumber" name="L257" href="#L257">257</a>
Map<String, Object> templateProperties = <strong
class="jxr_keyword">new</strong> HashMap<>();
-<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em
class="jxr_comment">// We tell the skin that we are rendering in standalone
mode</em>
-<a class="jxr_linenumber" name="L259" href="#L259">259</a>
templateProperties.put(<span class="jxr_string">"standalone"</span>,
Boolean.TRUE);
-<a class="jxr_linenumber" name="L260" href="#L260">260</a>
templateProperties.put(<span class="jxr_string">"project"</span>, getProject());
-<a class="jxr_linenumber" name="L261" href="#L261">261</a>
templateProperties.put(<span class="jxr_string">"inputEncoding"</span>,
getInputEncoding());
-<a class="jxr_linenumber" name="L262" href="#L262">262</a>
templateProperties.put(<span class="jxr_string">"outputEncoding"</span>,
getOutputEncoding());
-<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 :
getProject().getProperties().entrySet()) {
-<a class="jxr_linenumber" name="L265" href="#L265">265</a>
templateProperties.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>
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, templateProperties, 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>
MavenReportException(<span class="jxr_string">"Failed to retrieve skin
artifact"</span>, 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>
MavenReportException(<span class="jxr_string">"Failed to create context for
skin"</span>, e);
-<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_comment">// Add publish date</em>
-<a class="jxr_linenumber" name="L287" href="#L287">287</a> String
outputTimestamp = getProject().getProperties().getProperty(<span
class="jxr_string">"project.build.outputTimestamp"</span>);
-<a class="jxr_linenumber" name="L288" href="#L288">288</a>
MavenArchiver.parseBuildOutputTimestamp(outputTimestamp).ifPresent(v -> {
-<a class="jxr_linenumber" name="L289" href="#L289">289</a>
context.setPublishDate(Date.from(v));
-<a class="jxr_linenumber" name="L290" href="#L290">290</a> });
-<a class="jxr_linenumber" name="L291" href="#L291">291</a>
-<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em
class="jxr_comment">// Generate static site</em>
-<a class="jxr_linenumber" name="L293" href="#L293">293</a>
context.setRootDirectory(project.getBasedir());
-<a class="jxr_linenumber" name="L294" href="#L294">294</a>
-<a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong
class="jxr_keyword">return</strong> context;
-<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"> * Generate a report.</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> <em
class="jxr_javadoccomment"> * @param sink the sink to use for the
generation.</em>
-<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em
class="jxr_javadoccomment"> * @param locale the wanted locale to generate
the report, could be null.</em>
-<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em
class="jxr_javadoccomment"> * @throws MavenReportException if any</em>
-<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em
class="jxr_javadoccomment"> * @deprecated use {@link #generate(Sink,
SinkFactory, Locale)} instead.</em>
-<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L306" href="#L306">306</a> @Deprecated
-<a class="jxr_linenumber" name="L307" href="#L307">307</a> @Override
-<a class="jxr_linenumber" name="L308" href="#L308">308</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
generate(Sink sink, Locale locale) <strong class="jxr_keyword">throws</strong>
MavenReportException {
-<a class="jxr_linenumber" name="L309" href="#L309">309</a>
generate(sink, <strong class="jxr_keyword">null</strong>, locale);
-<a class="jxr_linenumber" name="L310" href="#L310">310</a> }
-<a class="jxr_linenumber" name="L311" href="#L311">311</a>
-<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L313" href="#L313">313</a> <em
class="jxr_javadoccomment"> * This method is called when the report
generation is invoked by maven-site-plugin.</em>
-<a class="jxr_linenumber" name="L314" href="#L314">314</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em
class="jxr_javadoccomment"> * @param sink</em>
-<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em
class="jxr_javadoccomment"> * @param sinkFactory</em>
-<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em
class="jxr_javadoccomment"> * @param locale</em>
-<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em
class="jxr_javadoccomment"> * @throws MavenReportException</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> @Override
-<a class="jxr_linenumber" name="L321" href="#L321">321</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
generate(Sink sink, SinkFactory sinkFactory, Locale locale) <strong
class="jxr_keyword">throws</strong> MavenReportException {
-<a class="jxr_linenumber" name="L322" href="#L322">322</a> <strong
class="jxr_keyword">if</strong> (!canGenerateReport()) {
-<a class="jxr_linenumber" name="L323" href="#L323">323</a>
getLog().info(<span class="jxr_string">"This report cannot be generated as part
of the current build. "</span>
-<a class="jxr_linenumber" name="L324" href="#L324">324</a>
+ <span class="jxr_string">"The report name should be referenced in this line
of output."</span>);
-<a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong
class="jxr_keyword">return</strong>;
-<a class="jxr_linenumber" name="L326" href="#L326">326</a> }
-<a class="jxr_linenumber" name="L327" href="#L327">327</a>
-<a class="jxr_linenumber" name="L328" href="#L328">328</a> <strong
class="jxr_keyword">this</strong>.sink = sink;
-<a class="jxr_linenumber" name="L329" href="#L329">329</a>
-<a class="jxr_linenumber" name="L330" href="#L330">330</a> <strong
class="jxr_keyword">this</strong>.sinkFactory = sinkFactory;
-<a class="jxr_linenumber" name="L331" href="#L331">331</a>
-<a class="jxr_linenumber" name="L332" href="#L332">332</a>
executeReport(locale);
-<a class="jxr_linenumber" name="L333" href="#L333">333</a>
-<a class="jxr_linenumber" name="L334" href="#L334">334</a>
closeReport();
-<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> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L338" href="#L338">338</a> <em
class="jxr_javadoccomment"> * @return CATEGORY_PROJECT_REPORTS</em>
-<a class="jxr_linenumber" name="L339" href="#L339">339</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L340" href="#L340">340</a> @Override
-<a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong
class="jxr_keyword">public</strong> String getCategoryName() {
-<a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong
class="jxr_keyword">return</strong> CATEGORY_PROJECT_REPORTS;
-<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> @Override
-<a class="jxr_linenumber" name="L346" href="#L346">346</a> <strong
class="jxr_keyword">public</strong> File getReportOutputDirectory() {
-<a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong
class="jxr_keyword">if</strong> (reportOutputDirectory == <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L348" href="#L348">348</a>
reportOutputDirectory = <strong class="jxr_keyword">new</strong>
File(getOutputDirectory());
-<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> <strong
class="jxr_keyword">return</strong> reportOutputDirectory;
-<a class="jxr_linenumber" name="L352" href="#L352">352</a> }
-<a class="jxr_linenumber" name="L353" href="#L353">353</a>
-<a class="jxr_linenumber" name="L354" href="#L354">354</a> @Override
-<a class="jxr_linenumber" name="L355" href="#L355">355</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
setReportOutputDirectory(File reportOutputDirectory) {
-<a class="jxr_linenumber" name="L356" href="#L356">356</a> <strong
class="jxr_keyword">this</strong>.reportOutputDirectory = reportOutputDirectory;
-<a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong
class="jxr_keyword">this</strong>.outputDirectory = reportOutputDirectory;
-<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">protected</strong> String getOutputDirectory() {
-<a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong
class="jxr_keyword">return</strong> outputDirectory.getAbsolutePath();
-<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> <strong
class="jxr_keyword">protected</strong> MavenProject getProject() {
-<a class="jxr_linenumber" name="L365" href="#L365">365</a> <strong
class="jxr_keyword">return</strong> project;
-<a class="jxr_linenumber" name="L366" href="#L366">366</a> }
-<a class="jxr_linenumber" name="L367" href="#L367">367</a>
-<a class="jxr_linenumber" name="L368" href="#L368">368</a> <strong
class="jxr_keyword">protected</strong> Renderer getSiteRenderer() {
-<a class="jxr_linenumber" name="L369" href="#L369">369</a> <strong
class="jxr_keyword">return</strong> siteRenderer;
-<a class="jxr_linenumber" name="L370" href="#L370">370</a> }
-<a class="jxr_linenumber" name="L371" href="#L371">371</a>
-<a class="jxr_linenumber" name="L372" href="#L372">372</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L373" href="#L373">373</a> <em
class="jxr_javadoccomment"> * Gets the input files encoding.</em>
-<a class="jxr_linenumber" name="L374" href="#L374">374</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L375" href="#L375">375</a> <em
class="jxr_javadoccomment"> * @return The input files encoding, never
<code>null</code>.</em>
-<a class="jxr_linenumber" name="L376" href="#L376">376</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L377" href="#L377">377</a> <strong
class="jxr_keyword">protected</strong> String getInputEncoding() {
-<a class="jxr_linenumber" name="L378" href="#L378">378</a> <strong
class="jxr_keyword">return</strong> (inputEncoding == <strong
class="jxr_keyword">null</strong>) ? ReaderFactory.FILE_ENCODING :
inputEncoding;
-<a class="jxr_linenumber" name="L379" href="#L379">379</a> }
-<a class="jxr_linenumber" name="L380" href="#L380">380</a>
-<a class="jxr_linenumber" name="L381" href="#L381">381</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L382" href="#L382">382</a> <em
class="jxr_javadoccomment"> * Gets the effective reporting output files
encoding.</em>
-<a class="jxr_linenumber" name="L383" href="#L383">383</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L384" href="#L384">384</a> <em
class="jxr_javadoccomment"> * @return The effective reporting output file
encoding, never <code>null</code>.</em>
-<a class="jxr_linenumber" name="L385" href="#L385">385</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L386" href="#L386">386</a> <strong
class="jxr_keyword">protected</strong> String getOutputEncoding() {
-<a class="jxr_linenumber" name="L387" href="#L387">387</a> <strong
class="jxr_keyword">return</strong> (outputEncoding == <strong
class="jxr_keyword">null</strong>) ? WriterFactory.UTF_8 : outputEncoding;
-<a class="jxr_linenumber" name="L388" href="#L388">388</a> }
-<a class="jxr_linenumber" name="L389" href="#L389">389</a>
-<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"> * Gets the locale</em>
-<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L393" href="#L393">393</a> <em
class="jxr_javadoccomment"> * @return the locale for this standalone
report</em>
-<a class="jxr_linenumber" name="L394" href="#L394">394</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L395" href="#L395">395</a> <strong
class="jxr_keyword">protected</strong> Locale getLocale() {
-<a class="jxr_linenumber" name="L396" href="#L396">396</a> <strong
class="jxr_keyword">return</strong> siteTool.getSiteLocales(locale).get(0);
-<a class="jxr_linenumber" name="L397" href="#L397">397</a> }
-<a class="jxr_linenumber" name="L398" href="#L398">398</a>
-<a class="jxr_linenumber" name="L399" href="#L399">399</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L400" href="#L400">400</a> <em
class="jxr_javadoccomment"> * Actions when closing the report.</em>
-<a class="jxr_linenumber" name="L401" href="#L401">401</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L402" href="#L402">402</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">void</strong> closeReport() {
-<a class="jxr_linenumber" name="L403" href="#L403">403</a> <strong
class="jxr_keyword">if</strong> (getSink() != <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L404" href="#L404">404</a>
getSink().close();
-<a class="jxr_linenumber" name="L405" href="#L405">405</a> }
-<a class="jxr_linenumber" name="L406" href="#L406">406</a> }
-<a class="jxr_linenumber" name="L407" href="#L407">407</a>
-<a class="jxr_linenumber" name="L408" href="#L408">408</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L409" href="#L409">409</a> <em
class="jxr_javadoccomment"> * @return the sink used</em>
-<a class="jxr_linenumber" name="L410" href="#L410">410</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L411" href="#L411">411</a> <strong
class="jxr_keyword">public</strong> Sink getSink() {
-<a class="jxr_linenumber" name="L412" href="#L412">412</a> <strong
class="jxr_keyword">return</strong> sink;
-<a class="jxr_linenumber" name="L413" href="#L413">413</a> }
-<a class="jxr_linenumber" name="L414" href="#L414">414</a>
-<a class="jxr_linenumber" name="L415" href="#L415">415</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L416" href="#L416">416</a> <em
class="jxr_javadoccomment"> * @return the sink factory used</em>
-<a class="jxr_linenumber" name="L417" href="#L417">417</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L418" href="#L418">418</a> <strong
class="jxr_keyword">public</strong> SinkFactory getSinkFactory() {
-<a class="jxr_linenumber" name="L419" href="#L419">419</a> <strong
class="jxr_keyword">return</strong> sinkFactory;
-<a class="jxr_linenumber" name="L420" href="#L420">420</a> }
-<a class="jxr_linenumber" name="L421" href="#L421">421</a>
-<a class="jxr_linenumber" name="L422" href="#L422">422</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L423" href="#L423">423</a> <em
class="jxr_javadoccomment"> * @see
org.apache.maven.reporting.MavenReport#isExternalReport()</em>
-<a class="jxr_linenumber" name="L424" href="#L424">424</a> <em
class="jxr_javadoccomment"> * @return {@code false} by default.</em>
-<a class="jxr_linenumber" name="L425" href="#L425">425</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L426" href="#L426">426</a> @Override
-<a class="jxr_linenumber" name="L427" href="#L427">427</a> <strong
class="jxr_keyword">public</strong> <strong
class="jxr_keyword">boolean</strong> isExternalReport() {
-<a class="jxr_linenumber" name="L428" href="#L428">428</a> <strong
class="jxr_keyword">return</strong> false;
-<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> @Override
-<a class="jxr_linenumber" name="L432" href="#L432">432</a> <strong
class="jxr_keyword">public</strong> <strong
class="jxr_keyword">boolean</strong> canGenerateReport() {
-<a class="jxr_linenumber" name="L433" href="#L433">433</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
-<a class="jxr_linenumber" name="L434" href="#L434">434</a> }
-<a class="jxr_linenumber" name="L435" href="#L435">435</a>
-<a class="jxr_linenumber" name="L436" href="#L436">436</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L437" href="#L437">437</a> <em
class="jxr_javadoccomment"> * Execute the generation of the report.</em>
-<a class="jxr_linenumber" name="L438" href="#L438">438</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L439" href="#L439">439</a> <em
class="jxr_javadoccomment"> * @param locale the wanted locale to return the
report's description, could be <code>null</code>.</em>
-<a class="jxr_linenumber" name="L440" href="#L440">440</a> <em
class="jxr_javadoccomment"> * @throws MavenReportException if any</em>
-<a class="jxr_linenumber" name="L441" href="#L441">441</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L442" href="#L442">442</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong>
executeReport(Locale locale) <strong class="jxr_keyword">throws</strong>
MavenReportException;
-<a class="jxr_linenumber" name="L443" href="#L443">443</a> }
+<a class="jxr_linenumber" name="L227" href="#L227">227</a>
DocumentRenderingContext docRenderingContext =
+<a class="jxr_linenumber" name="L228" href="#L228">228</a>
<strong class="jxr_keyword">new</strong>
DocumentRenderingContext(outputDirectory, filename, <strong
class="jxr_keyword">null</strong>);
+<a class="jxr_linenumber" name="L229" href="#L229">229</a>
+<a class="jxr_linenumber" name="L230" href="#L230">230</a>
SiteRendererSink sink = <strong class="jxr_keyword">new</strong>
SiteRendererSink(docRenderingContext);
+<a class="jxr_linenumber" name="L231" href="#L231">231</a>
+<a class="jxr_linenumber" name="L232" href="#L232">232</a>
generate(sink, <strong class="jxr_keyword">null</strong>, locale);
+<a class="jxr_linenumber" name="L233" href="#L233">233</a>
+<a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong
class="jxr_keyword">if</strong> (!isExternalReport()) <em
class="jxr_comment">// MSHARED-204: only render Doxia sink if not an external
report</em>
+<a class="jxr_linenumber" name="L235" href="#L235">235</a> {
+<a class="jxr_linenumber" name="L236" href="#L236">236</a>
outputDirectory.mkdirs();
+<a class="jxr_linenumber" name="L237" href="#L237">237</a>
+<a class="jxr_linenumber" name="L238" href="#L238">238</a>
<strong class="jxr_keyword">try</strong> (Writer writer = <strong
class="jxr_keyword">new</strong> OutputStreamWriter(
+<a class="jxr_linenumber" name="L239" href="#L239">239</a>
<strong class="jxr_keyword">new</strong> FileOutputStream(<strong
class="jxr_keyword">new</strong> File(outputDirectory, filename)),
getOutputEncoding())) {
+<a class="jxr_linenumber" name="L240" href="#L240">240</a>
<em class="jxr_comment">// render report</em>
+<a class="jxr_linenumber" name="L241" href="#L241">241</a>
getSiteRenderer().mergeDocumentIntoSite(writer, sink, siteContext);
+<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> <em
class="jxr_comment">// copy generated resources also</em>
+<a class="jxr_linenumber" name="L246" href="#L246">246</a>
getSiteRenderer().copyResources(siteContext, outputDirectory);
+<a class="jxr_linenumber" name="L247" href="#L247">247</a> } <strong
class="jxr_keyword">catch</strong> (RendererException | IOException |
MavenReportException | SiteToolException e) {
+<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
MojoExecutionException(
+<a class="jxr_linenumber" name="L249" href="#L249">249</a>
<span class="jxr_string">"An error has occurred in "</span> +
getName(Locale.ENGLISH) + <span class="jxr_string">" report
generation."</span>, e);
+<a class="jxr_linenumber" name="L250" href="#L250">250</a> }
+<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">private</strong> SiteRenderingContext
createSiteRenderingContext(Locale locale)
+<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong
class="jxr_keyword">throws</strong> MavenReportException, IOException,
SiteToolException {
+<a class="jxr_linenumber" name="L255" href="#L255">255</a> SiteModel
siteModel = siteTool.getSiteModel(
+<a class="jxr_linenumber" name="L256" href="#L256">256</a>
siteDirectory, locale, project, reactorProjects, repoSession,
remoteProjectRepositories);
+<a class="jxr_linenumber" name="L257" href="#L257">257</a>
+<a class="jxr_linenumber" name="L258" href="#L258">258</a>
Map<String, Object> templateProperties = <strong
class="jxr_keyword">new</strong> HashMap<>();
+<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em
class="jxr_comment">// We tell the skin that we are rendering in standalone
mode</em>
+<a class="jxr_linenumber" name="L260" href="#L260">260</a>
templateProperties.put(<span class="jxr_string">"standalone"</span>,
Boolean.TRUE);
+<a class="jxr_linenumber" name="L261" href="#L261">261</a>
templateProperties.put(<span class="jxr_string">"project"</span>, getProject());
+<a class="jxr_linenumber" name="L262" href="#L262">262</a>
templateProperties.put(<span class="jxr_string">"inputEncoding"</span>,
getInputEncoding());
+<a class="jxr_linenumber" name="L263" href="#L263">263</a>
templateProperties.put(<span class="jxr_string">"outputEncoding"</span>,
getOutputEncoding());
+<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em
class="jxr_comment">// Put any of the properties in directly into the Velocity
context</em>
+<a class="jxr_linenumber" name="L265" href="#L265">265</a> <strong
class="jxr_keyword">for</strong> (Map.Entry<Object, Object> entry :
getProject().getProperties().entrySet()) {
+<a class="jxr_linenumber" name="L266" href="#L266">266</a>
templateProperties.put((String) entry.getKey(), entry.getValue());
+<a class="jxr_linenumber" name="L267" href="#L267">267</a> }
+<a class="jxr_linenumber" name="L268" href="#L268">268</a>
+<a class="jxr_linenumber" name="L269" href="#L269">269</a>
SiteRenderingContext context;
+<a class="jxr_linenumber" name="L270" href="#L270">270</a> <strong
class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="L271" href="#L271">271</a>
Artifact skinArtifact =
+<a class="jxr_linenumber" name="L272" href="#L272">272</a>
siteTool.getSkinArtifactFromRepository(repoSession, remoteProjectRepositories,
siteModel.getSkin());
+<a class="jxr_linenumber" name="L273" href="#L273">273</a>
+<a class="jxr_linenumber" name="L274" href="#L274">274</a>
getLog().info(buffer().a(<span class="jxr_string">"Rendering content with
"</span>)
+<a class="jxr_linenumber" name="L275" href="#L275">275</a>
.strong(skinArtifact.getId() + <span class="jxr_string">" skin"</span>)
+<a class="jxr_linenumber" name="L276" href="#L276">276</a>
.a('.')
+<a class="jxr_linenumber" name="L277" href="#L277">277</a>
.toString());
+<a class="jxr_linenumber" name="L278" href="#L278">278</a>
+<a class="jxr_linenumber" name="L279" href="#L279">279</a> context
= siteRenderer.createContextForSkin(
+<a class="jxr_linenumber" name="L280" href="#L280">280</a>
skinArtifact, templateProperties, siteModel, project.getName(), locale);
+<a class="jxr_linenumber" name="L281" href="#L281">281</a> } <strong
class="jxr_keyword">catch</strong> (SiteToolException e) {
+<a class="jxr_linenumber" name="L282" href="#L282">282</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
MavenReportException(<span class="jxr_string">"Failed to retrieve skin
artifact"</span>, e);
+<a class="jxr_linenumber" name="L283" href="#L283">283</a> } <strong
class="jxr_keyword">catch</strong> (RendererException e) {
+<a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
MavenReportException(<span class="jxr_string">"Failed to create context for
skin"</span>, 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> <em
class="jxr_comment">// Add publish date</em>
+<a class="jxr_linenumber" name="L288" href="#L288">288</a> String
outputTimestamp = getProject().getProperties().getProperty(<span
class="jxr_string">"project.build.outputTimestamp"</span>);
+<a class="jxr_linenumber" name="L289" href="#L289">289</a>
MavenArchiver.parseBuildOutputTimestamp(outputTimestamp).ifPresent(v -> {
+<a class="jxr_linenumber" name="L290" href="#L290">290</a>
context.setPublishDate(Date.from(v));
+<a class="jxr_linenumber" name="L291" href="#L291">291</a> });
+<a class="jxr_linenumber" name="L292" href="#L292">292</a>
+<a class="jxr_linenumber" name="L293" href="#L293">293</a> <em
class="jxr_comment">// Generate static site</em>
+<a class="jxr_linenumber" name="L294" href="#L294">294</a>
context.setRootDirectory(project.getBasedir());
+<a class="jxr_linenumber" name="L295" href="#L295">295</a>
+<a class="jxr_linenumber" name="L296" href="#L296">296</a> <strong
class="jxr_keyword">return</strong> context;
+<a class="jxr_linenumber" name="L297" href="#L297">297</a> }
+<a class="jxr_linenumber" name="L298" href="#L298">298</a>
+<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em
class="jxr_javadoccomment"> * Generate a report.</em>
+<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em
class="jxr_javadoccomment"> * @param sink the sink to use for the
generation.</em>
+<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em
class="jxr_javadoccomment"> * @param locale the wanted locale to generate
the report, could be null.</em>
+<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em
class="jxr_javadoccomment"> * @throws MavenReportException if any</em>
+<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em
class="jxr_javadoccomment"> * @deprecated use {@link #generate(Sink,
SinkFactory, Locale)} instead.</em>
+<a class="jxr_linenumber" name="L306" href="#L306">306</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L307" href="#L307">307</a> @Deprecated
+<a class="jxr_linenumber" name="L308" href="#L308">308</a> @Override
+<a class="jxr_linenumber" name="L309" href="#L309">309</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
generate(Sink sink, Locale locale) <strong class="jxr_keyword">throws</strong>
MavenReportException {
+<a class="jxr_linenumber" name="L310" href="#L310">310</a>
generate(sink, <strong class="jxr_keyword">null</strong>, locale);
+<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"> * This method is called when the report
generation is invoked by maven-site-plugin.</em>
+<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em
class="jxr_javadoccomment"> * @param sink</em>
+<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em
class="jxr_javadoccomment"> * @param sinkFactory</em>
+<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em
class="jxr_javadoccomment"> * @param locale</em>
+<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em
class="jxr_javadoccomment"> * @throws MavenReportException</em>
+<a class="jxr_linenumber" name="L320" href="#L320">320</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L321" href="#L321">321</a> @Override
+<a class="jxr_linenumber" name="L322" href="#L322">322</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
generate(Sink sink, SinkFactory sinkFactory, Locale locale) <strong
class="jxr_keyword">throws</strong> MavenReportException {
+<a class="jxr_linenumber" name="L323" href="#L323">323</a> <strong
class="jxr_keyword">if</strong> (!canGenerateReport()) {
+<a class="jxr_linenumber" name="L324" href="#L324">324</a>
getLog().info(<span class="jxr_string">"This report cannot be generated as part
of the current build. "</span>
+<a class="jxr_linenumber" name="L325" href="#L325">325</a>
+ <span class="jxr_string">"The report name should be referenced in this line
of output."</span>);
+<a class="jxr_linenumber" name="L326" href="#L326">326</a> <strong
class="jxr_keyword">return</strong>;
+<a class="jxr_linenumber" name="L327" href="#L327">327</a> }
+<a class="jxr_linenumber" name="L328" href="#L328">328</a>
+<a class="jxr_linenumber" name="L329" href="#L329">329</a> <strong
class="jxr_keyword">this</strong>.sink = sink;
+<a class="jxr_linenumber" name="L330" href="#L330">330</a>
+<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong
class="jxr_keyword">this</strong>.sinkFactory = sinkFactory;
+<a class="jxr_linenumber" name="L332" href="#L332">332</a>
+<a class="jxr_linenumber" name="L333" href="#L333">333</a>
executeReport(locale);
+<a class="jxr_linenumber" name="L334" href="#L334">334</a>
+<a class="jxr_linenumber" name="L335" href="#L335">335</a>
closeReport();
+<a class="jxr_linenumber" name="L336" href="#L336">336</a> }
+<a class="jxr_linenumber" name="L337" href="#L337">337</a>
+<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> <em
class="jxr_javadoccomment"> * @return CATEGORY_PROJECT_REPORTS</em>
+<a class="jxr_linenumber" name="L340" href="#L340">340</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L341" href="#L341">341</a> @Override
+<a class="jxr_linenumber" name="L342" href="#L342">342</a> <strong
class="jxr_keyword">public</strong> String getCategoryName() {
+<a class="jxr_linenumber" name="L343" href="#L343">343</a> <strong
class="jxr_keyword">return</strong> CATEGORY_PROJECT_REPORTS;
+<a class="jxr_linenumber" name="L344" href="#L344">344</a> }
+<a class="jxr_linenumber" name="L345" href="#L345">345</a>
+<a class="jxr_linenumber" name="L346" href="#L346">346</a> @Override
+<a class="jxr_linenumber" name="L347" href="#L347">347</a> <strong
class="jxr_keyword">public</strong> File getReportOutputDirectory() {
+<a class="jxr_linenumber" name="L348" href="#L348">348</a> <strong
class="jxr_keyword">if</strong> (reportOutputDirectory == <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L349" href="#L349">349</a>
reportOutputDirectory = <strong class="jxr_keyword">new</strong>
File(getOutputDirectory());
+<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">return</strong> reportOutputDirectory;
+<a class="jxr_linenumber" name="L353" href="#L353">353</a> }
+<a class="jxr_linenumber" name="L354" href="#L354">354</a>
+<a class="jxr_linenumber" name="L355" href="#L355">355</a> @Override
+<a class="jxr_linenumber" name="L356" href="#L356">356</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
setReportOutputDirectory(File reportOutputDirectory) {
+<a class="jxr_linenumber" name="L357" href="#L357">357</a> <strong
class="jxr_keyword">this</strong>.reportOutputDirectory = reportOutputDirectory;
+<a class="jxr_linenumber" name="L358" href="#L358">358</a> <strong
class="jxr_keyword">this</strong>.outputDirectory = reportOutputDirectory;
+<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">protected</strong> String getOutputDirectory() {
+<a class="jxr_linenumber" name="L362" href="#L362">362</a> <strong
class="jxr_keyword">return</strong> outputDirectory.getAbsolutePath();
+<a class="jxr_linenumber" name="L363" href="#L363">363</a> }
+<a class="jxr_linenumber" name="L364" href="#L364">364</a>
+<a class="jxr_linenumber" name="L365" href="#L365">365</a> <strong
class="jxr_keyword">protected</strong> MavenProject getProject() {
+<a class="jxr_linenumber" name="L366" href="#L366">366</a> <strong
class="jxr_keyword">return</strong> project;
+<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">protected</strong> Renderer getSiteRenderer() {
+<a class="jxr_linenumber" name="L370" href="#L370">370</a> <strong
class="jxr_keyword">return</strong> siteRenderer;
+<a class="jxr_linenumber" name="L371" href="#L371">371</a> }
+<a class="jxr_linenumber" name="L372" href="#L372">372</a>
+<a class="jxr_linenumber" name="L373" href="#L373">373</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L374" href="#L374">374</a> <em
class="jxr_javadoccomment"> * Gets the input files encoding.</em>
+<a class="jxr_linenumber" name="L375" href="#L375">375</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L376" href="#L376">376</a> <em
class="jxr_javadoccomment"> * @return The input files encoding, never
<code>null</code>.</em>
+<a class="jxr_linenumber" name="L377" href="#L377">377</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L378" href="#L378">378</a> <strong
class="jxr_keyword">protected</strong> String getInputEncoding() {
+<a class="jxr_linenumber" name="L379" href="#L379">379</a> <strong
class="jxr_keyword">return</strong> (inputEncoding == <strong
class="jxr_keyword">null</strong>) ? ReaderFactory.FILE_ENCODING :
inputEncoding;
+<a class="jxr_linenumber" name="L380" href="#L380">380</a> }
+<a class="jxr_linenumber" name="L381" href="#L381">381</a>
+<a class="jxr_linenumber" name="L382" href="#L382">382</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L383" href="#L383">383</a> <em
class="jxr_javadoccomment"> * Gets the effective reporting output files
encoding.</em>
+<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"> * @return The effective reporting output file
encoding, never <code>null</code>.</em>
+<a class="jxr_linenumber" name="L386" href="#L386">386</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L387" href="#L387">387</a> <strong
class="jxr_keyword">protected</strong> String getOutputEncoding() {
+<a class="jxr_linenumber" name="L388" href="#L388">388</a> <strong
class="jxr_keyword">return</strong> (outputEncoding == <strong
class="jxr_keyword">null</strong>) ? WriterFactory.UTF_8 : outputEncoding;
+<a class="jxr_linenumber" name="L389" href="#L389">389</a> }
+<a class="jxr_linenumber" name="L390" href="#L390">390</a>
+<a class="jxr_linenumber" name="L391" href="#L391">391</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em
class="jxr_javadoccomment"> * Gets the locale</em>
+<a class="jxr_linenumber" name="L393" href="#L393">393</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L394" href="#L394">394</a> <em
class="jxr_javadoccomment"> * @return the locale for this standalone
report</em>
+<a class="jxr_linenumber" name="L395" href="#L395">395</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L396" href="#L396">396</a> <strong
class="jxr_keyword">protected</strong> Locale getLocale() {
+<a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong
class="jxr_keyword">return</strong> siteTool.getSiteLocales(locale).get(0);
+<a class="jxr_linenumber" name="L398" href="#L398">398</a> }
+<a class="jxr_linenumber" name="L399" href="#L399">399</a>
+<a class="jxr_linenumber" name="L400" href="#L400">400</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L401" href="#L401">401</a> <em
class="jxr_javadoccomment"> * Actions when closing the report.</em>
+<a class="jxr_linenumber" name="L402" href="#L402">402</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L403" href="#L403">403</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">void</strong> closeReport() {
+<a class="jxr_linenumber" name="L404" href="#L404">404</a> <strong
class="jxr_keyword">if</strong> (getSink() != <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L405" href="#L405">405</a>
getSink().close();
+<a class="jxr_linenumber" name="L406" href="#L406">406</a> }
+<a class="jxr_linenumber" name="L407" href="#L407">407</a> }
+<a class="jxr_linenumber" name="L408" href="#L408">408</a>
+<a class="jxr_linenumber" name="L409" href="#L409">409</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L410" href="#L410">410</a> <em
class="jxr_javadoccomment"> * @return the sink used</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">public</strong> Sink getSink() {
+<a class="jxr_linenumber" name="L413" href="#L413">413</a> <strong
class="jxr_keyword">return</strong> sink;
+<a class="jxr_linenumber" name="L414" href="#L414">414</a> }
+<a class="jxr_linenumber" name="L415" href="#L415">415</a>
+<a class="jxr_linenumber" name="L416" href="#L416">416</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L417" href="#L417">417</a> <em
class="jxr_javadoccomment"> * @return the sink factory used</em>
+<a class="jxr_linenumber" name="L418" href="#L418">418</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L419" href="#L419">419</a> <strong
class="jxr_keyword">public</strong> SinkFactory getSinkFactory() {
+<a class="jxr_linenumber" name="L420" href="#L420">420</a> <strong
class="jxr_keyword">return</strong> sinkFactory;
+<a class="jxr_linenumber" name="L421" href="#L421">421</a> }
+<a class="jxr_linenumber" name="L422" href="#L422">422</a>
+<a class="jxr_linenumber" name="L423" href="#L423">423</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L424" href="#L424">424</a> <em
class="jxr_javadoccomment"> * @see
org.apache.maven.reporting.MavenReport#isExternalReport()</em>
+<a class="jxr_linenumber" name="L425" href="#L425">425</a> <em
class="jxr_javadoccomment"> * @return {@code false} by default.</em>
+<a class="jxr_linenumber" name="L426" href="#L426">426</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L427" href="#L427">427</a> @Override
+<a class="jxr_linenumber" name="L428" href="#L428">428</a> <strong
class="jxr_keyword">public</strong> <strong
class="jxr_keyword">boolean</strong> isExternalReport() {
+<a class="jxr_linenumber" name="L429" href="#L429">429</a> <strong
class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="L430" href="#L430">430</a> }
+<a class="jxr_linenumber" name="L431" href="#L431">431</a>
+<a class="jxr_linenumber" name="L432" href="#L432">432</a> @Override
+<a class="jxr_linenumber" name="L433" href="#L433">433</a> <strong
class="jxr_keyword">public</strong> <strong
class="jxr_keyword">boolean</strong> canGenerateReport() {
+<a class="jxr_linenumber" name="L434" href="#L434">434</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<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> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L438" href="#L438">438</a> <em
class="jxr_javadoccomment"> * Execute the generation of the report.</em>
+<a class="jxr_linenumber" name="L439" href="#L439">439</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L440" href="#L440">440</a> <em
class="jxr_javadoccomment"> * @param locale the wanted locale to return the
report's description, could be <code>null</code>.</em>
+<a class="jxr_linenumber" name="L441" href="#L441">441</a> <em
class="jxr_javadoccomment"> * @throws MavenReportException if any</em>
+<a class="jxr_linenumber" name="L442" href="#L442">442</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L443" href="#L443">443</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong>
executeReport(Locale locale) <strong class="jxr_keyword">throws</strong>
MavenReportException;
+<a class="jxr_linenumber" name="L444" href="#L444">444</a> }
</pre>
<hr/>
<div id="footer">Copyright © 2002–2023 <a
href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights
reserved.</div>
Modified:
maven/website/components/shared-archives/maven-reporting-impl-LATEST/xref/org/apache/maven/reporting/package-frame.html
==============================================================================
---
maven/website/components/shared-archives/maven-reporting-impl-LATEST/xref/org/apache/maven/reporting/package-frame.html
(original)
+++
maven/website/components/shared-archives/maven-reporting-impl-LATEST/xref/org/apache/maven/reporting/package-frame.html
Sun Apr 2 13:52:53 2023
@@ -4,7 +4,7 @@
<!-- generated by Apache Maven JXR (jdk8) -->
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
- <title>Apache Maven Reporting Implementation 4.0.0-M5 Reference
Package org.apache.maven.reporting</title>
+ <title>Apache Maven Reporting Implementation 4.0.0-M6 Reference
Package org.apache.maven.reporting</title>
<link rel="stylesheet" type="text/css"
href="../../../../stylesheet.css" title="style" />
</head>
<body>
Modified:
maven/website/components/shared-archives/maven-reporting-impl-LATEST/xref/org/apache/maven/reporting/package-summary.html
==============================================================================
---
maven/website/components/shared-archives/maven-reporting-impl-LATEST/xref/org/apache/maven/reporting/package-summary.html
(original)
+++
maven/website/components/shared-archives/maven-reporting-impl-LATEST/xref/org/apache/maven/reporting/package-summary.html
Sun Apr 2 13:52:53 2023
@@ -4,7 +4,7 @@
<!-- generated by Apache Maven JXR (jdk8) -->
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
- <title>Apache Maven Reporting Implementation 4.0.0-M5 Reference
Package org.apache.maven.reporting</title>
+ <title>Apache Maven Reporting Implementation 4.0.0-M6 Reference
Package org.apache.maven.reporting</title>
<link rel="stylesheet" type="text/css"
href="../../../../stylesheet.css" title="style" />
</head>
@@ -23,7 +23,7 @@
<li>Index</li>
<li>Help</li>
</ul>
- <div class="aboutLanguage"><em><strong>Apache Maven Reporting
Implementation 4.0.0-M5 Reference</strong></em></div>
+ <div class="aboutLanguage"><em><strong>Apache Maven Reporting
Implementation 4.0.0-M6 Reference</strong></em></div>
</div>
<div class="subNav">
<ul class="navList">
@@ -86,7 +86,7 @@
<li>Index</li>
<li>Help</li>
</ul>
- <div class="aboutLanguage"><em><strong>Apache Maven Reporting
Implementation 4.0.0-M5 Reference</strong></em></div>
+ <div class="aboutLanguage"><em><strong>Apache Maven Reporting
Implementation 4.0.0-M6 Reference</strong></em></div>
</div>
<div class="subNav">
<ul class="navList">
Modified:
maven/website/components/shared-archives/maven-reporting-impl-LATEST/xref/overview-frame.html
==============================================================================
---
maven/website/components/shared-archives/maven-reporting-impl-LATEST/xref/overview-frame.html
(original)
+++
maven/website/components/shared-archives/maven-reporting-impl-LATEST/xref/overview-frame.html
Sun Apr 2 13:52:53 2023
@@ -4,11 +4,11 @@
<!-- generated by Apache Maven JXR (jdk8) -->
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
- <title>Apache Maven Reporting Implementation 4.0.0-M5 Reference</title>
+ <title>Apache Maven Reporting Implementation 4.0.0-M6 Reference</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css"
title="style" />
</head>
<body>
- <h1 title="Apache Maven Reporting Implementation 4.0.0-M5 Reference"
class="bar"><strong>Apache Maven Reporting Implementation 4.0.0-M5
Reference</strong></h1>
+ <h1 title="Apache Maven Reporting Implementation 4.0.0-M6 Reference"
class="bar"><strong>Apache Maven Reporting Implementation 4.0.0-M6
Reference</strong></h1>
<div class="indexHeader"><span><a href="allclasses-frame.html"
target="packageFrame">All Classes</a></span></div>
<div class="indexContainer">
<h2 title="Packages">Packages</h2>
Modified:
maven/website/components/shared-archives/maven-reporting-impl-LATEST/xref/overview-summary.html
==============================================================================
---
maven/website/components/shared-archives/maven-reporting-impl-LATEST/xref/overview-summary.html
(original)
+++
maven/website/components/shared-archives/maven-reporting-impl-LATEST/xref/overview-summary.html
Sun Apr 2 13:52:53 2023
@@ -4,7 +4,7 @@
<!-- generated by Apache Maven JXR (jdk7) -->
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
- <title>Apache Maven Reporting Implementation 4.0.0-M5 Reference</title>
+ <title>Apache Maven Reporting Implementation 4.0.0-M6 Reference</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css"
title="style" />
</head>
<body>
@@ -22,7 +22,7 @@
<li>Index</li>
<li>Help</li>
</ul>
- <div class="aboutLanguage"><em><strong>Apache Maven Reporting
Implementation 4.0.0-M5 Reference</strong></em></div>
+ <div class="aboutLanguage"><em><strong>Apache Maven Reporting
Implementation 4.0.0-M6 Reference</strong></em></div>
</div>
<div class="subNav">
<ul class="navList">
@@ -37,7 +37,7 @@
</div>
<div class="header">
- <h1 class="title">Apache Maven Reporting Implementation 4.0.0-M5
Reference</h1>
+ <h1 class="title">Apache Maven Reporting Implementation 4.0.0-M6
Reference</h1>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3"
cellspacing="0" summary="Packages table, listing packages">
@@ -71,7 +71,7 @@
<li>Index</li>
<li>Help</li>
</ul>
- <div class="aboutLanguage"><em><strong>Apache Maven Reporting
Implementation 4.0.0-M5 Reference</strong></em></div>
+ <div class="aboutLanguage"><em><strong>Apache Maven Reporting
Implementation 4.0.0-M6 Reference</strong></em></div>
</div>
<div class="subNav">
<ul class="navList">
