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 Mar 19 20:38:42 2023 @@ -39,415 +39,416 @@ <a class="jxr_linenumber" name="L31" href="#L31">31</a> <a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.archiver.MavenArchiver; <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.artifact.repository.ArtifactRepository; -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.Sink; -<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.SinkFactory; -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.DecorationModel; -<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.RenderingContext; -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.SiteRenderingContext; -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.sink.SiteRendererSink; -<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.tools.SiteTool; -<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.tools.SiteToolException; -<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo; -<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component; -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.utils.WriterFactory; -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.PlexusContainer; -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.component.repository.exception.ComponentLookupException; -<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory; -<a class="jxr_linenumber" name="L54" href="#L54">54</a> -<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.apache.maven.shared.utils.logging.MessageUtils.buffer; -<a class="jxr_linenumber" name="L56" href="#L56">56</a> -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * The basis for a Maven report which can be generated both as part of a site generation or</em> -<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * as a direct standalone goal invocation.</em> -<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * Both invocations are delegated to <code>abstract executeReport( Locale )</code> from:</em> -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * <ul></em> -<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * <li>Mojo's <code>execute()</code> method, see maven-plugin-api</li></em> -<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * <li>MavenMultiPageReport's <code>generate( Sink, SinkFactory, Locale )</code>, see maven-reporting-api</li></em> -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * </ul></em> -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * @author <a href="eveni...@apache.org">Emmanuel Venisse</a></em> -<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * @since 2.0</em> -<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * @see #execute() <code>Mojo.execute()</code>, from maven-plugin-api</em> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * @see #generate(Sink, SinkFactory, Locale) <code>MavenMultiPageReport.generate( Sink, SinkFactory, Locale )</code>,</em> -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * from maven-reporting-api</em> -<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * @see #executeReport(Locale) <code>abstract executeReport( Locale )</code></em> -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractMavenReport" href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#AbstractMavenReport">AbstractMavenReport</a> <strong class="jxr_keyword">extends</strong> AbstractMojo <strong class="jxr_keyword">implements</strong> MavenMultiPageReport { -<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * The output directory for the report. Note that this parameter is only evaluated if the goal is run directly from</em> -<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * the command line. If the goal is run indirectly as part of a site generation, the output directory configured in</em> -<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * the Maven Site Plugin is used instead.</em> -<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L79" href="#L79">79</a> @Parameter(defaultValue = <span class="jxr_string">"${project.reporting.outputDirectory}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">protected</strong> File outputDirectory; -<a class="jxr_linenumber" name="L81" href="#L81">81</a> -<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * The Maven Project.</em> -<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L85" href="#L85">85</a> @Parameter(defaultValue = <span class="jxr_string">"${project}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">protected</strong> MavenProject project; -<a class="jxr_linenumber" name="L87" href="#L87">87</a> -<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * The reactor projects.</em> -<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L91" href="#L91">91</a> @Parameter(defaultValue = <span class="jxr_string">"${reactorProjects}"</span>, required = <strong class="jxr_keyword">true</strong>, readonly = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">protected</strong> List<MavenProject> reactorProjects; -<a class="jxr_linenumber" name="L93" href="#L93">93</a> -<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * Specifies the input encoding.</em> -<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L97" href="#L97">97</a> @Parameter(property = <span class="jxr_string">"encoding"</span>, defaultValue = <span class="jxr_string">"${project.build.sourceEncoding}"</span>, readonly = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">private</strong> String inputEncoding; -<a class="jxr_linenumber" name="L99" href="#L99">99</a> -<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * Specifies the output encoding.</em> -<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L103" href="#L103">103</a> @Parameter(property = <span class="jxr_string">"outputEncoding"</span>, defaultValue = <span class="jxr_string">"${project.reporting.outputEncoding}"</span>, readonly = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">private</strong> String outputEncoding; -<a class="jxr_linenumber" name="L105" href="#L105">105</a> -<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * The local repository.</em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> @Parameter(defaultValue = <span class="jxr_string">"${localRepository}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">protected</strong> ArtifactRepository localRepository; -<a class="jxr_linenumber" name="L111" href="#L111">111</a> -<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * Remote repositories used for the project.</em> -<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L115" href="#L115">115</a> @Parameter(defaultValue = <span class="jxr_string">"${project.remoteArtifactRepositories}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) -<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">protected</strong> List<ArtifactRepository> remoteRepositories; -<a class="jxr_linenumber" name="L117" href="#L117">117</a> -<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> <em class="jxr_javadoccomment"> * Directory containing the <code>site.xml</code> file.</em> -<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L121" href="#L121">121</a> @Parameter(defaultValue = <span class="jxr_string">"${basedir}/src/site"</span>) -<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">protected</strong> File siteDirectory; -<a class="jxr_linenumber" name="L123" href="#L123">123</a> -<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> <em class="jxr_javadoccomment"> * The locale to use when the report generation is invoked directly as a standalone Mojo.</em> -<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * <p></em> -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * <b>Default value is</b>: {@link SiteTool#DEFAULT_LOCALE}</em> -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * @see SiteTool#getSiteLocales(String)</em> -<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L131" href="#L131">131</a> @Parameter(defaultValue = <span class="jxr_string">"default"</span>) -<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">protected</strong> String locale; -<a class="jxr_linenumber" name="L133" href="#L133">133</a> -<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * SiteTool.</em> -<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> @Component -<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">protected</strong> SiteTool siteTool; -<a class="jxr_linenumber" name="L139" href="#L139">139</a> -<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * Doxia Site Renderer component.</em> -<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L143" href="#L143">143</a> @Component -<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">protected</strong> Renderer siteRenderer; -<a class="jxr_linenumber" name="L145" href="#L145">145</a> -<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment">/** The current sink to use */</em> -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">private</strong> Sink sink; -<a class="jxr_linenumber" name="L148" href="#L148">148</a> -<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment">/** The sink factory to use */</em> -<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">private</strong> SinkFactory sinkFactory; -<a class="jxr_linenumber" name="L151" href="#L151">151</a> -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment">/** The current report output directory to use */</em> -<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">private</strong> File reportOutputDirectory; -<a class="jxr_linenumber" name="L154" href="#L154">154</a> -<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment"> * The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.</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">"output.format"</span>) -<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">protected</strong> String outputFormat; -<a class="jxr_linenumber" name="L160" href="#L160">160</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">private</strong> PlexusContainer container; -<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"> * This method is called when the report generation is invoked directly as a standalone Mojo.</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"> * @throws MojoExecutionException if an error occurs when generating the report</em> -<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * @see org.apache.maven.plugin.Mojo#execute()</em> -<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L170" href="#L170">170</a> @Override -<a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">if</strong> (!canGenerateReport()) { -<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L174" href="#L174">174</a> } -<a class="jxr_linenumber" name="L175" href="#L175">175</a> -<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">if</strong> (outputFormat != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L177" href="#L177">177</a> reportToMarkup(); -<a class="jxr_linenumber" name="L178" href="#L178">178</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L179" href="#L179">179</a> reportToSite(); -<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> -<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> reportToMarkup() <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L184" href="#L184">184</a> getLog().info(<span class="jxr_string">"Rendering to "</span> + outputFormat + <span class="jxr_string">" markup"</span>); -<a class="jxr_linenumber" name="L185" href="#L185">185</a> -<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">if</strong> (!isExternalReport()) { -<a class="jxr_linenumber" name="L187" href="#L187">187</a> String filename = getOutputName() + '.' + outputFormat; -<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L189" href="#L189">189</a> sinkFactory = container.lookup(SinkFactory.<strong class="jxr_keyword">class</strong>, outputFormat); -<a class="jxr_linenumber" name="L190" href="#L190">190</a> sink = sinkFactory.createSink(outputDirectory, filename); -<a class="jxr_linenumber" name="L191" href="#L191">191</a> } <strong class="jxr_keyword">catch</strong> (ComponentLookupException cle) { -<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( -<a class="jxr_linenumber" name="L193" href="#L193">193</a> <span class="jxr_string">"Cannot find SinkFactory for Doxia output format: "</span> + outputFormat, cle); -<a class="jxr_linenumber" name="L194" href="#L194">194</a> } <strong class="jxr_keyword">catch</strong> (IOException ioe) { -<a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Cannot create sink to "</span> + <strong class="jxr_keyword">new</strong> File(outputDirectory, filename), ioe); -<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> -<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L200" href="#L200">200</a> Locale locale = getLocale(); -<a class="jxr_linenumber" name="L201" href="#L201">201</a> generate(sink, sinkFactory, locale); -<a class="jxr_linenumber" name="L202" href="#L202">202</a> } <strong class="jxr_keyword">catch</strong> (MavenReportException e) { -<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( -<a class="jxr_linenumber" name="L204" href="#L204">204</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="L205" href="#L205">205</a> } <strong class="jxr_keyword">finally</strong> { -<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">if</strong> (sink != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L207" href="#L207">207</a> sink.close(); -<a class="jxr_linenumber" name="L208" href="#L208">208</a> } -<a class="jxr_linenumber" name="L209" href="#L209">209</a> } -<a class="jxr_linenumber" name="L210" href="#L210">210</a> } -<a class="jxr_linenumber" name="L211" href="#L211">211</a> -<a class="jxr_linenumber" name="L212" href="#L212">212</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> reportToSite() <strong class="jxr_keyword">throws</strong> MojoExecutionException { -<a class="jxr_linenumber" name="L213" href="#L213">213</a> File outputDirectory = <strong class="jxr_keyword">new</strong> File(getOutputDirectory()); -<a class="jxr_linenumber" name="L214" href="#L214">214</a> -<a class="jxr_linenumber" name="L215" href="#L215">215</a> String filename = getOutputName() + <span class="jxr_string">".html"</span>; -<a class="jxr_linenumber" name="L216" href="#L216">216</a> -<a class="jxr_linenumber" name="L217" href="#L217">217</a> Locale locale = getLocale(); -<a class="jxr_linenumber" name="L218" href="#L218">218</a> -<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L220" href="#L220">220</a> SiteRenderingContext siteContext = createSiteRenderingContext(locale); -<a class="jxr_linenumber" name="L221" href="#L221">221</a> -<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_comment">// copy resources</em> -<a class="jxr_linenumber" name="L223" href="#L223">223</a> getSiteRenderer().copyResources(siteContext, outputDirectory); -<a class="jxr_linenumber" name="L224" href="#L224">224</a> -<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_comment">// TODO Replace null with real value</em> -<a class="jxr_linenumber" name="L226" href="#L226">226</a> RenderingContext docRenderingContext = <strong class="jxr_keyword">new</strong> RenderingContext(outputDirectory, filename, <strong class="jxr_keyword">null</strong>); -<a class="jxr_linenumber" name="L227" href="#L227">227</a> -<a class="jxr_linenumber" name="L228" href="#L228">228</a> SiteRendererSink sink = <strong class="jxr_keyword">new</strong> SiteRendererSink(docRenderingContext); -<a class="jxr_linenumber" name="L229" href="#L229">229</a> -<a class="jxr_linenumber" name="L230" href="#L230">230</a> generate(sink, <strong class="jxr_keyword">null</strong>, locale); -<a class="jxr_linenumber" name="L231" href="#L231">231</a> -<a class="jxr_linenumber" name="L232" href="#L232">232</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="L233" href="#L233">233</a> { -<a class="jxr_linenumber" name="L234" href="#L234">234</a> outputDirectory.mkdirs(); -<a class="jxr_linenumber" name="L235" href="#L235">235</a> -<a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">try</strong> (Writer writer = <strong class="jxr_keyword">new</strong> OutputStreamWriter( -<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">new</strong> FileOutputStream(<strong class="jxr_keyword">new</strong> File(outputDirectory, filename)), getOutputEncoding())) { -<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_comment">// render report</em> -<a class="jxr_linenumber" name="L239" href="#L239">239</a> getSiteRenderer().mergeDocumentIntoSite(writer, sink, siteContext); -<a class="jxr_linenumber" name="L240" href="#L240">240</a> } -<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> <em class="jxr_comment">// copy generated resources also</em> -<a class="jxr_linenumber" name="L244" href="#L244">244</a> getSiteRenderer().copyResources(siteContext, outputDirectory); -<a class="jxr_linenumber" name="L245" href="#L245">245</a> } <strong class="jxr_keyword">catch</strong> (RendererException | IOException | MavenReportException | SiteToolException e) { -<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( -<a class="jxr_linenumber" name="L247" href="#L247">247</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="L248" href="#L248">248</a> } -<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> <strong class="jxr_keyword">private</strong> SiteRenderingContext createSiteRenderingContext(Locale locale) -<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">throws</strong> MavenReportException, IOException, SiteToolException { -<a class="jxr_linenumber" name="L253" href="#L253">253</a> DecorationModel decorationModel = siteTool.getDecorationModel( -<a class="jxr_linenumber" name="L254" href="#L254">254</a> siteDirectory, locale, project, reactorProjects, localRepository, remoteRepositories); -<a class="jxr_linenumber" name="L255" href="#L255">255</a> -<a class="jxr_linenumber" name="L256" href="#L256">256</a> Map<String, Object> templateProperties = <strong class="jxr_keyword">new</strong> HashMap<>(); -<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_comment">// We tell the skin that we are rendering in standalone mode</em> -<a class="jxr_linenumber" name="L258" href="#L258">258</a> templateProperties.put(<span class="jxr_string">"standalone"</span>, Boolean.TRUE); -<a class="jxr_linenumber" name="L259" href="#L259">259</a> templateProperties.put(<span class="jxr_string">"project"</span>, getProject()); -<a class="jxr_linenumber" name="L260" href="#L260">260</a> templateProperties.put(<span class="jxr_string">"inputEncoding"</span>, getInputEncoding()); -<a class="jxr_linenumber" name="L261" href="#L261">261</a> templateProperties.put(<span class="jxr_string">"outputEncoding"</span>, getOutputEncoding()); -<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_comment">// Put any of the properties in directly into the Velocity context</em> -<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">for</strong> (Map.Entry<Object, Object> entry : getProject().getProperties().entrySet()) { -<a class="jxr_linenumber" name="L264" href="#L264">264</a> templateProperties.put((String) entry.getKey(), entry.getValue()); -<a class="jxr_linenumber" name="L265" href="#L265">265</a> } -<a class="jxr_linenumber" name="L266" href="#L266">266</a> -<a class="jxr_linenumber" name="L267" href="#L267">267</a> SiteRenderingContext context; -<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">try</strong> { -<a class="jxr_linenumber" name="L269" href="#L269">269</a> Artifact skinArtifact = -<a class="jxr_linenumber" name="L270" href="#L270">270</a> siteTool.getSkinArtifactFromRepository(localRepository, remoteRepositories, decorationModel); -<a class="jxr_linenumber" name="L271" href="#L271">271</a> -<a class="jxr_linenumber" name="L272" href="#L272">272</a> getLog().info(buffer().a(<span class="jxr_string">"Rendering content with "</span>) -<a class="jxr_linenumber" name="L273" href="#L273">273</a> .strong(skinArtifact.getId() + <span class="jxr_string">" skin"</span>) -<a class="jxr_linenumber" name="L274" href="#L274">274</a> .a('.') -<a class="jxr_linenumber" name="L275" href="#L275">275</a> .toString()); -<a class="jxr_linenumber" name="L276" href="#L276">276</a> -<a class="jxr_linenumber" name="L277" href="#L277">277</a> context = siteRenderer.createContextForSkin( -<a class="jxr_linenumber" name="L278" href="#L278">278</a> skinArtifact, templateProperties, decorationModel, project.getName(), locale); -<a class="jxr_linenumber" name="L279" href="#L279">279</a> } <strong class="jxr_keyword">catch</strong> (SiteToolException e) { -<a class="jxr_linenumber" name="L280" href="#L280">280</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="L281" href="#L281">281</a> } <strong class="jxr_keyword">catch</strong> (RendererException 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 create context for skin"</span>, e); -<a class="jxr_linenumber" name="L283" href="#L283">283</a> } -<a class="jxr_linenumber" name="L284" href="#L284">284</a> -<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_comment">// Add publish date</em> -<a class="jxr_linenumber" name="L286" href="#L286">286</a> String outputTimestamp = getProject().getProperties().getProperty(<span class="jxr_string">"project.build.outputTimestamp"</span>); -<a class="jxr_linenumber" name="L287" href="#L287">287</a> MavenArchiver.parseBuildOutputTimestamp(outputTimestamp).ifPresent(v -> { -<a class="jxr_linenumber" name="L288" href="#L288">288</a> context.setPublishDate(Date.from(v)); -<a class="jxr_linenumber" name="L289" href="#L289">289</a> }); -<a class="jxr_linenumber" name="L290" href="#L290">290</a> -<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_comment">// Generate static site</em> -<a class="jxr_linenumber" name="L292" href="#L292">292</a> context.setRootDirectory(project.getBasedir()); -<a class="jxr_linenumber" name="L293" href="#L293">293</a> -<a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong class="jxr_keyword">return</strong> context; -<a class="jxr_linenumber" name="L295" href="#L295">295</a> } -<a class="jxr_linenumber" name="L296" href="#L296">296</a> -<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> * Generate a report.</em> -<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"> * @param sink the sink to use for the generation.</em> -<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment"> * @param locale the wanted locale to generate the report, could be null.</em> -<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> * @throws MavenReportException if any</em> -<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment"> * @deprecated use {@link #generate(Sink, SinkFactory, Locale)} instead.</em> -<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L305" href="#L305">305</a> @Deprecated -<a class="jxr_linenumber" name="L306" href="#L306">306</a> @Override -<a class="jxr_linenumber" name="L307" href="#L307">307</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="L308" href="#L308">308</a> generate(sink, <strong class="jxr_keyword">null</strong>, locale); -<a class="jxr_linenumber" name="L309" href="#L309">309</a> } -<a class="jxr_linenumber" name="L310" href="#L310">310</a> -<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment"> * This method is called when the report generation is invoked by maven-site-plugin.</em> -<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"> * @param sink</em> -<a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment"> * @param sinkFactory</em> -<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> * @param locale</em> -<a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> * @throws MavenReportException</em> -<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L319" href="#L319">319</a> @Override -<a class="jxr_linenumber" name="L320" href="#L320">320</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="L321" href="#L321">321</a> <strong class="jxr_keyword">if</strong> (!canGenerateReport()) { -<a class="jxr_linenumber" name="L322" href="#L322">322</a> getLog().info(<span class="jxr_string">"This report cannot be generated as part of the current build. "</span> -<a class="jxr_linenumber" name="L323" href="#L323">323</a> + <span class="jxr_string">"The report name should be referenced in this line of output."</span>); -<a class="jxr_linenumber" name="L324" href="#L324">324</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L325" href="#L325">325</a> } -<a class="jxr_linenumber" name="L326" href="#L326">326</a> -<a class="jxr_linenumber" name="L327" href="#L327">327</a> <strong class="jxr_keyword">this</strong>.sink = sink; -<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>.sinkFactory = sinkFactory; -<a class="jxr_linenumber" name="L330" href="#L330">330</a> -<a class="jxr_linenumber" name="L331" href="#L331">331</a> executeReport(locale); -<a class="jxr_linenumber" name="L332" href="#L332">332</a> -<a class="jxr_linenumber" name="L333" href="#L333">333</a> closeReport(); -<a class="jxr_linenumber" name="L334" href="#L334">334</a> } -<a class="jxr_linenumber" name="L335" href="#L335">335</a> -<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L337" href="#L337">337</a> <em class="jxr_javadoccomment"> * @return CATEGORY_PROJECT_REPORTS</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> @Override -<a class="jxr_linenumber" name="L340" href="#L340">340</a> <strong class="jxr_keyword">public</strong> String getCategoryName() { -<a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong class="jxr_keyword">return</strong> CATEGORY_PROJECT_REPORTS; -<a class="jxr_linenumber" name="L342" href="#L342">342</a> } -<a class="jxr_linenumber" name="L343" href="#L343">343</a> -<a class="jxr_linenumber" name="L344" href="#L344">344</a> @Override -<a class="jxr_linenumber" name="L345" href="#L345">345</a> <strong class="jxr_keyword">public</strong> File getReportOutputDirectory() { -<a class="jxr_linenumber" name="L346" href="#L346">346</a> <strong class="jxr_keyword">if</strong> (reportOutputDirectory == <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L347" href="#L347">347</a> reportOutputDirectory = <strong class="jxr_keyword">new</strong> File(getOutputDirectory()); -<a class="jxr_linenumber" name="L348" href="#L348">348</a> } -<a class="jxr_linenumber" name="L349" href="#L349">349</a> -<a class="jxr_linenumber" name="L350" href="#L350">350</a> <strong class="jxr_keyword">return</strong> reportOutputDirectory; -<a class="jxr_linenumber" name="L351" href="#L351">351</a> } -<a class="jxr_linenumber" name="L352" href="#L352">352</a> -<a class="jxr_linenumber" name="L353" href="#L353">353</a> @Override -<a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setReportOutputDirectory(File reportOutputDirectory) { -<a class="jxr_linenumber" name="L355" href="#L355">355</a> <strong class="jxr_keyword">this</strong>.reportOutputDirectory = reportOutputDirectory; -<a class="jxr_linenumber" name="L356" href="#L356">356</a> <strong class="jxr_keyword">this</strong>.outputDirectory = reportOutputDirectory; -<a class="jxr_linenumber" name="L357" href="#L357">357</a> } -<a class="jxr_linenumber" name="L358" href="#L358">358</a> -<a class="jxr_linenumber" name="L359" href="#L359">359</a> <strong class="jxr_keyword">protected</strong> String getOutputDirectory() { -<a class="jxr_linenumber" name="L360" href="#L360">360</a> <strong class="jxr_keyword">return</strong> outputDirectory.getAbsolutePath(); -<a class="jxr_linenumber" name="L361" href="#L361">361</a> } -<a class="jxr_linenumber" name="L362" href="#L362">362</a> -<a class="jxr_linenumber" name="L363" href="#L363">363</a> <strong class="jxr_keyword">protected</strong> MavenProject getProject() { -<a class="jxr_linenumber" name="L364" href="#L364">364</a> <strong class="jxr_keyword">return</strong> project; -<a class="jxr_linenumber" name="L365" href="#L365">365</a> } -<a class="jxr_linenumber" name="L366" href="#L366">366</a> -<a class="jxr_linenumber" name="L367" href="#L367">367</a> <strong class="jxr_keyword">protected</strong> Renderer getSiteRenderer() { -<a class="jxr_linenumber" name="L368" href="#L368">368</a> <strong class="jxr_keyword">return</strong> siteRenderer; -<a class="jxr_linenumber" name="L369" href="#L369">369</a> } -<a class="jxr_linenumber" name="L370" href="#L370">370</a> -<a class="jxr_linenumber" name="L371" href="#L371">371</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L372" href="#L372">372</a> <em class="jxr_javadoccomment"> * Gets the input files encoding.</em> -<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"> * @return The input files encoding, never <code>null</code>.</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> <strong class="jxr_keyword">protected</strong> String getInputEncoding() { -<a class="jxr_linenumber" name="L377" href="#L377">377</a> <strong class="jxr_keyword">return</strong> (inputEncoding == <strong class="jxr_keyword">null</strong>) ? ReaderFactory.FILE_ENCODING : inputEncoding; -<a class="jxr_linenumber" name="L378" href="#L378">378</a> } -<a class="jxr_linenumber" name="L379" href="#L379">379</a> -<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"> * Gets the effective reporting output files encoding.</em> -<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"> * @return The effective reporting output file encoding, never <code>null</code>.</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> <strong class="jxr_keyword">protected</strong> String getOutputEncoding() { -<a class="jxr_linenumber" name="L386" href="#L386">386</a> <strong class="jxr_keyword">return</strong> (outputEncoding == <strong class="jxr_keyword">null</strong>) ? WriterFactory.UTF_8 : outputEncoding; -<a class="jxr_linenumber" name="L387" href="#L387">387</a> } -<a class="jxr_linenumber" name="L388" href="#L388">388</a> -<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L390" href="#L390">390</a> <em class="jxr_javadoccomment"> * Gets the locale</em> -<a class="jxr_linenumber" name="L391" href="#L391">391</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L392" href="#L392">392</a> <em class="jxr_javadoccomment"> * @return the locale for this standalone report</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> <strong class="jxr_keyword">protected</strong> Locale getLocale() { -<a class="jxr_linenumber" name="L395" href="#L395">395</a> <strong class="jxr_keyword">return</strong> siteTool.getSiteLocales(locale).get(0); -<a class="jxr_linenumber" name="L396" href="#L396">396</a> } -<a class="jxr_linenumber" name="L397" href="#L397">397</a> -<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> <em class="jxr_javadoccomment"> * Actions when closing the report.</em> -<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> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> closeReport() { -<a class="jxr_linenumber" name="L402" href="#L402">402</a> <strong class="jxr_keyword">if</strong> (getSink() != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L403" href="#L403">403</a> getSink().close(); -<a class="jxr_linenumber" name="L404" href="#L404">404</a> } -<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> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L408" href="#L408">408</a> <em class="jxr_javadoccomment"> * @return the sink used</em> -<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> <strong class="jxr_keyword">public</strong> Sink getSink() { -<a class="jxr_linenumber" name="L411" href="#L411">411</a> <strong class="jxr_keyword">return</strong> sink; -<a class="jxr_linenumber" name="L412" href="#L412">412</a> } -<a class="jxr_linenumber" name="L413" href="#L413">413</a> -<a class="jxr_linenumber" name="L414" href="#L414">414</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L415" href="#L415">415</a> <em class="jxr_javadoccomment"> * @return the sink factory used</em> -<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> <strong class="jxr_keyword">public</strong> SinkFactory getSinkFactory() { -<a class="jxr_linenumber" name="L418" href="#L418">418</a> <strong class="jxr_keyword">return</strong> sinkFactory; -<a class="jxr_linenumber" name="L419" href="#L419">419</a> } -<a class="jxr_linenumber" name="L420" href="#L420">420</a> -<a class="jxr_linenumber" name="L421" href="#L421">421</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L422" href="#L422">422</a> <em class="jxr_javadoccomment"> * @see org.apache.maven.reporting.MavenReport#isExternalReport()</em> -<a class="jxr_linenumber" name="L423" href="#L423">423</a> <em class="jxr_javadoccomment"> * @return {@code false} by default.</em> -<a class="jxr_linenumber" name="L424" href="#L424">424</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L425" href="#L425">425</a> @Override -<a class="jxr_linenumber" name="L426" href="#L426">426</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isExternalReport() { -<a class="jxr_linenumber" name="L427" href="#L427">427</a> <strong class="jxr_keyword">return</strong> false; -<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> @Override -<a class="jxr_linenumber" name="L431" href="#L431">431</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() { -<a class="jxr_linenumber" name="L432" href="#L432">432</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; -<a class="jxr_linenumber" name="L433" href="#L433">433</a> } -<a class="jxr_linenumber" name="L434" href="#L434">434</a> -<a class="jxr_linenumber" name="L435" href="#L435">435</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L436" href="#L436">436</a> <em class="jxr_javadoccomment"> * Execute the generation of the report.</em> -<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"> * @param locale the wanted locale to return the report's description, could be <code>null</code>.</em> -<a class="jxr_linenumber" name="L439" href="#L439">439</a> <em class="jxr_javadoccomment"> * @throws MavenReportException if any</em> -<a class="jxr_linenumber" name="L440" href="#L440">440</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L441" href="#L441">441</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="L442" href="#L442">442</a> } +<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="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; +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.tools.SiteToolException; +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo; +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component; +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.utils.WriterFactory; +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.PlexusContainer; +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.component.repository.exception.ComponentLookupException; +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory; +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.RepositorySystemSession; +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.repository.RemoteRepository; +<a class="jxr_linenumber" name="L55" href="#L55">55</a> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong> org.apache.maven.shared.utils.logging.MessageUtils.buffer; +<a class="jxr_linenumber" name="L57" href="#L57">57</a> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * The basis for a Maven report which can be generated both as part of a site generation or</em> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * as a direct standalone goal invocation.</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * Both invocations are delegated to <code>abstract executeReport( Locale )</code> from:</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * <ul></em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * <li>Mojo's <code>execute()</code> method, see maven-plugin-api</li></em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * <li>MavenMultiPageReport's <code>generate( Sink, SinkFactory, Locale )</code>, see maven-reporting-api</li></em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * </ul></em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * @author <a href="eveni...@apache.org">Emmanuel Venisse</a></em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * @since 2.0</em> +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * @see #execute() <code>Mojo.execute()</code>, from maven-plugin-api</em> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * @see #generate(Sink, SinkFactory, Locale) <code>MavenMultiPageReport.generate( Sink, SinkFactory, Locale )</code>,</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * from maven-reporting-api</em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * @see #executeReport(Locale) <code>abstract executeReport( Locale )</code></em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractMavenReport" href="../../../../org/apache/maven/reporting/AbstractMavenReport.html#AbstractMavenReport">AbstractMavenReport</a> <strong class="jxr_keyword">extends</strong> AbstractMojo <strong class="jxr_keyword">implements</strong> MavenMultiPageReport { +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * The output directory for the report. Note that this parameter is only evaluated if the goal is run directly from</em> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * the command line. If the goal is run indirectly as part of a site generation, the output directory configured in</em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * the Maven Site Plugin is used instead.</em> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> @Parameter(defaultValue = <span class="jxr_string">"${project.reporting.outputDirectory}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">protected</strong> File outputDirectory; +<a class="jxr_linenumber" name="L82" href="#L82">82</a> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * The Maven Project.</em> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> @Parameter(defaultValue = <span class="jxr_string">"${project}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">protected</strong> MavenProject project; +<a class="jxr_linenumber" name="L88" href="#L88">88</a> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * The reactor projects.</em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> @Parameter(defaultValue = <span class="jxr_string">"${reactorProjects}"</span>, required = <strong class="jxr_keyword">true</strong>, readonly = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">protected</strong> List<MavenProject> reactorProjects; +<a class="jxr_linenumber" name="L94" href="#L94">94</a> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * Specifies the input encoding.</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> @Parameter(property = <span class="jxr_string">"encoding"</span>, defaultValue = <span class="jxr_string">"${project.build.sourceEncoding}"</span>, readonly = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">private</strong> String inputEncoding; +<a class="jxr_linenumber" name="L100" href="#L100">100</a> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * Specifies the output encoding.</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> @Parameter(property = <span class="jxr_string">"outputEncoding"</span>, defaultValue = <span class="jxr_string">"${project.reporting.outputEncoding}"</span>, readonly = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">private</strong> String outputEncoding; +<a class="jxr_linenumber" name="L106" href="#L106">106</a> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * The repository system session.</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> @Parameter(defaultValue = <span class="jxr_string">"${repositorySystemSession}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">protected</strong> RepositorySystemSession repoSession; +<a class="jxr_linenumber" name="L112" href="#L112">112</a> +<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> <em class="jxr_javadoccomment"> * Remote project repositories used for the project.</em> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> @Parameter(defaultValue = <span class="jxr_string">"${project.remoteProjectRepositories}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong>) +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">protected</strong> List<RemoteRepository> remoteProjectRepositories; +<a class="jxr_linenumber" name="L118" href="#L118">118</a> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * Directory containing the <code>site.xml</code> file.</em> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> @Parameter(defaultValue = <span class="jxr_string">"${basedir}/src/site"</span>) +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">protected</strong> File siteDirectory; +<a class="jxr_linenumber" name="L124" href="#L124">124</a> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> * The locale to use when the report generation is invoked directly as a standalone Mojo.</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * <p></em> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * <b>Default value is</b>: {@link SiteTool#DEFAULT_LOCALE}</em> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * @see SiteTool#getSiteLocales(String)</em> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> @Parameter(defaultValue = <span class="jxr_string">"default"</span>) +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">protected</strong> String locale; +<a class="jxr_linenumber" name="L134" href="#L134">134</a> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * SiteTool.</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> @Component +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">protected</strong> SiteTool siteTool; +<a class="jxr_linenumber" name="L140" href="#L140">140</a> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * Doxia Site Renderer component.</em> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> @Component +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">protected</strong> Renderer siteRenderer; +<a class="jxr_linenumber" name="L146" href="#L146">146</a> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment">/** The current sink to use */</em> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">private</strong> Sink sink; +<a class="jxr_linenumber" name="L149" href="#L149">149</a> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment">/** The sink factory to use */</em> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">private</strong> SinkFactory sinkFactory; +<a class="jxr_linenumber" name="L152" href="#L152">152</a> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment">/** The current report output directory to use */</em> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">private</strong> File reportOutputDirectory; +<a class="jxr_linenumber" name="L155" href="#L155">155</a> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L159" href="#L159">159</a> @Parameter(property = <span class="jxr_string">"output.format"</span>) +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">protected</strong> String outputFormat; +<a class="jxr_linenumber" name="L161" href="#L161">161</a> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> @Component +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">private</strong> PlexusContainer container; +<a class="jxr_linenumber" name="L164" href="#L164">164</a> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * This method is called when the report generation is invoked directly as a standalone Mojo.</em> +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if an error occurs when generating the report</em> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment"> * @see org.apache.maven.plugin.Mojo#execute()</em> +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L171" href="#L171">171</a> @Override +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">if</strong> (!canGenerateReport()) { +<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L175" href="#L175">175</a> } +<a class="jxr_linenumber" name="L176" href="#L176">176</a> +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">if</strong> (outputFormat != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L178" href="#L178">178</a> reportToMarkup(); +<a class="jxr_linenumber" name="L179" href="#L179">179</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L180" href="#L180">180</a> reportToSite(); +<a class="jxr_linenumber" name="L181" href="#L181">181</a> } +<a class="jxr_linenumber" name="L182" href="#L182">182</a> } +<a class="jxr_linenumber" name="L183" href="#L183">183</a> +<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> reportToMarkup() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L185" href="#L185">185</a> getLog().info(<span class="jxr_string">"Rendering to "</span> + outputFormat + <span class="jxr_string">" markup"</span>); +<a class="jxr_linenumber" name="L186" href="#L186">186</a> +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">if</strong> (!isExternalReport()) { +<a class="jxr_linenumber" name="L188" href="#L188">188</a> String filename = getOutputName() + '.' + outputFormat; +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L190" href="#L190">190</a> sinkFactory = container.lookup(SinkFactory.<strong class="jxr_keyword">class</strong>, outputFormat); +<a class="jxr_linenumber" name="L191" href="#L191">191</a> sink = sinkFactory.createSink(outputDirectory, filename); +<a class="jxr_linenumber" name="L192" href="#L192">192</a> } <strong class="jxr_keyword">catch</strong> (ComponentLookupException cle) { +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( +<a class="jxr_linenumber" name="L194" href="#L194">194</a> <span class="jxr_string">"Cannot find SinkFactory for Doxia output format: "</span> + outputFormat, cle); +<a class="jxr_linenumber" name="L195" href="#L195">195</a> } <strong class="jxr_keyword">catch</strong> (IOException ioe) { +<a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Cannot create sink to "</span> + <strong class="jxr_keyword">new</strong> File(outputDirectory, filename), ioe); +<a class="jxr_linenumber" name="L197" href="#L197">197</a> } +<a class="jxr_linenumber" name="L198" href="#L198">198</a> } +<a class="jxr_linenumber" name="L199" href="#L199">199</a> +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L201" href="#L201">201</a> Locale locale = getLocale(); +<a class="jxr_linenumber" name="L202" href="#L202">202</a> generate(sink, sinkFactory, locale); +<a class="jxr_linenumber" name="L203" href="#L203">203</a> } <strong class="jxr_keyword">catch</strong> (MavenReportException e) { +<a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( +<a class="jxr_linenumber" name="L205" href="#L205">205</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="L206" href="#L206">206</a> } <strong class="jxr_keyword">finally</strong> { +<a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">if</strong> (sink != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L208" href="#L208">208</a> sink.close(); +<a class="jxr_linenumber" name="L209" href="#L209">209</a> } +<a class="jxr_linenumber" name="L210" href="#L210">210</a> } +<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">private</strong> <strong class="jxr_keyword">void</strong> reportToSite() <strong class="jxr_keyword">throws</strong> MojoExecutionException { +<a class="jxr_linenumber" name="L214" href="#L214">214</a> File outputDirectory = <strong class="jxr_keyword">new</strong> File(getOutputDirectory()); +<a class="jxr_linenumber" name="L215" href="#L215">215</a> +<a class="jxr_linenumber" name="L216" href="#L216">216</a> String filename = getOutputName() + <span class="jxr_string">".html"</span>; +<a class="jxr_linenumber" name="L217" href="#L217">217</a> +<a class="jxr_linenumber" name="L218" href="#L218">218</a> Locale locale = getLocale(); +<a class="jxr_linenumber" name="L219" href="#L219">219</a> +<a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">try</strong> { +<a class="jxr_linenumber" name="L221" href="#L221">221</a> SiteRenderingContext siteContext = createSiteRenderingContext(locale); +<a class="jxr_linenumber" name="L222" href="#L222">222</a> +<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_comment">// copy resources</em> +<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>);
[... 123 lines stripped ...]