You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by mi...@apache.org on 2022/02/05 21:39:47 UTC
svn commit: r1897792 [21/23] - in /maven/website/components/shared-archives/maven-reporting-impl-LATEST: ./ apidocs/ apidocs/org/apache/maven/reporting/ apidocs/org/apache/maven/reporting/class-use/ apidocs/resources/ css/ fonts/ js/ testapidocs/ testa...
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 Sat Feb 5 21:39:46 2022
@@ -1,378 +1,365 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
-<title>AbstractMavenReport xref</title>
-<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
-</head>
-<body>
-<div id="overview"><a href="../../../../../apidocs/org/apache/maven/reporting/AbstractMavenReport.html">View Javadoc</a></div><pre>
-<a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.reporting;
-<a class="jxr_linenumber" name="L2" href="#L2">2</a>
-<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment">/*</em>
-<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
-<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
-<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
-<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
-<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
-<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
-<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
-<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
-<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
-<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> *</em>
-<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
-<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
-<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
-<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
-<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
-<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> * under the License.</em>
-<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment"> */</em>
-<a class="jxr_linenumber" name="L21" href="#L21">21</a>
-<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.Sink;
-<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.SinkFactory;
-<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.DecorationModel;
-<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.Renderer;
-<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.RendererException;
-<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.RenderingContext;
-<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.SiteRenderingContext;
-<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
-<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo;
-<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
-<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component;
-<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter;
-<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
-<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.utils.WriterFactory;
-<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.utils.io.IOUtil;
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory;
-<a class="jxr_linenumber" name="L38" href="#L38">38</a>
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> java.io.File;
-<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> java.io.FileOutputStream;
-<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> java.io.OutputStreamWriter;
-<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> java.io.Writer;
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> java.util.HashMap;
-<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
-<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> java.util.Map;
-<a class="jxr_linenumber" name="L47" href="#L47">47</a>
-<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L49" href="#L49">49</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="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * as a direct standalone goal invocation.</em>
-<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * Both invocations are delegated to <code>abstract executeReport( Locale )</code> from:</em>
-<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * <ul></em>
-<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * <li>Mojo's <code>execute()</code> method, see maven-plugin-api</li></em>
-<a class="jxr_linenumber" name="L54" href="#L54">54</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="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * </ul></em>
-<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * @author <a href="evenisse@apache.org">Emmanuel Venisse</a></em>
-<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * @version $Id: AbstractMavenReport.java 1777736 2017-01-06 23:54:39Z michaelo $</em>
-<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * @since 2.0</em>
-<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * @see #execute() <code>Mojo.execute()</code>, from maven-plugin-api</em>
-<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * @see #generate(Sink, SinkFactory, Locale) <code>MavenMultiPageReport.generate( Sink, SinkFactory, Locale )</code>,</em>
-<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * from maven-reporting-api</em>
-<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * @see #executeReport(Locale) <code>abstract executeReport( Locale )</code></em>
-<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html">AbstractMavenReport</a>
-<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">extends</strong> AbstractMojo
-<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">implements</strong> MavenMultiPageReport
-<a class="jxr_linenumber" name="L68" href="#L68">68</a> {
-<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L70" href="#L70">70</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="L71" href="#L71">71</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="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * the Maven Site Plugin is used instead.</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> @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="L75" href="#L75">75</a> <strong class="jxr_keyword">protected</strong> File outputDirectory;
-<a class="jxr_linenumber" name="L76" href="#L76">76</a>
-<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * The Maven Project.</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}"</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> MavenProject project;
-<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"> * Specifies the input encoding.</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( 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="L87" href="#L87">87</a> <strong class="jxr_keyword">private</strong> String inputEncoding;
-<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"> * Specifies the output encoding.</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( 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="L93" href="#L93">93</a> <strong class="jxr_keyword">private</strong> String outputEncoding;
-<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"> * Doxia Site Renderer component.</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> @Component
-<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">protected</strong> Renderer siteRenderer;
-<a class="jxr_linenumber" name="L100" href="#L100">100</a>
-<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment">/** The current sink to use */</em>
-<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">private</strong> Sink sink;
-<a class="jxr_linenumber" name="L103" href="#L103">103</a>
-<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment">/** The sink factory to use */</em>
-<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">private</strong> SinkFactory sinkFactory;
-<a class="jxr_linenumber" name="L106" href="#L106">106</a>
-<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment">/** The current report output directory to use */</em>
-<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">private</strong> File reportOutputDirectory;
-<a class="jxr_linenumber" name="L109" href="#L109">109</a>
-<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L111" href="#L111">111</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="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if an error occurs when generating the report</em>
-<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * @see org.apache.maven.plugins.site.ReportDocumentRender</em>
-<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * @see org.apache.maven.plugin.Mojo#execute()</em>
-<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute()
-<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
-<a class="jxr_linenumber" name="L119" href="#L119">119</a> {
-<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">if</strong> ( !canGenerateReport() )
-<a class="jxr_linenumber" name="L121" href="#L121">121</a> {
-<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">return</strong>;
-<a class="jxr_linenumber" name="L123" href="#L123">123</a> }
-<a class="jxr_linenumber" name="L124" href="#L124">124</a>
-<a class="jxr_linenumber" name="L125" href="#L125">125</a> Writer writer = <strong class="jxr_keyword">null</strong>;
-<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">try</strong>
-<a class="jxr_linenumber" name="L127" href="#L127">127</a> {
-<a class="jxr_linenumber" name="L128" href="#L128">128</a> File outputDirectory = <strong class="jxr_keyword">new</strong> File( getOutputDirectory() );
-<a class="jxr_linenumber" name="L129" href="#L129">129</a>
-<a class="jxr_linenumber" name="L130" href="#L130">130</a> String filename = getOutputName() + <span class="jxr_string">".html"</span>;
-<a class="jxr_linenumber" name="L131" href="#L131">131</a>
-<a class="jxr_linenumber" name="L132" href="#L132">132</a> Locale locale = Locale.getDefault();
-<a class="jxr_linenumber" name="L133" href="#L133">133</a>
-<a class="jxr_linenumber" name="L134" href="#L134">134</a> SiteRenderingContext siteContext = <strong class="jxr_keyword">new</strong> SiteRenderingContext();
-<a class="jxr_linenumber" name="L135" href="#L135">135</a> siteContext.setDecoration( <strong class="jxr_keyword">new</strong> DecorationModel() );
-<a class="jxr_linenumber" name="L136" href="#L136">136</a> siteContext.setTemplateName( <span class="jxr_string">"org/apache/maven/doxia/siterenderer/resources/default-site.vm"</span> );
-<a class="jxr_linenumber" name="L137" href="#L137">137</a> siteContext.setLocale( locale );
-<a class="jxr_linenumber" name="L138" href="#L138">138</a> siteContext.setTemplateProperties( getTemplateProperties() );
-<a class="jxr_linenumber" name="L139" href="#L139">139</a>
-<a class="jxr_linenumber" name="L140" href="#L140">140</a> RenderingContext context = <strong class="jxr_keyword">new</strong> RenderingContext( outputDirectory, filename );
-<a class="jxr_linenumber" name="L141" href="#L141">141</a>
-<a class="jxr_linenumber" name="L142" href="#L142">142</a> SiteRendererSink sink = <strong class="jxr_keyword">new</strong> SiteRendererSink( context );
-<a class="jxr_linenumber" name="L143" href="#L143">143</a>
-<a class="jxr_linenumber" name="L144" href="#L144">144</a> generate( sink, <strong class="jxr_keyword">null</strong>, locale );
-<a class="jxr_linenumber" name="L145" href="#L145">145</a>
-<a class="jxr_linenumber" name="L146" href="#L146">146</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="L147" href="#L147">147</a> {
-<a class="jxr_linenumber" name="L148" href="#L148">148</a> outputDirectory.mkdirs();
-<a class="jxr_linenumber" name="L149" href="#L149">149</a>
-<a class="jxr_linenumber" name="L150" href="#L150">150</a> writer =
-<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">new</strong> OutputStreamWriter( <strong class="jxr_keyword">new</strong> FileOutputStream( <strong class="jxr_keyword">new</strong> File( outputDirectory, filename ) ),
-<a class="jxr_linenumber" name="L152" href="#L152">152</a> getOutputEncoding() );
-<a class="jxr_linenumber" name="L153" href="#L153">153</a>
-<a class="jxr_linenumber" name="L154" href="#L154">154</a> getSiteRenderer().generateDocument( writer, sink, siteContext );
-<a class="jxr_linenumber" name="L155" href="#L155">155</a>
-<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_comment">//getSiteRenderer().copyResources( siteContext, new File( project.getBasedir(), "src/site/resources" ),</em>
-<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_comment">// outputDirectory );</em>
-<a class="jxr_linenumber" name="L158" href="#L158">158</a> }
-<a class="jxr_linenumber" name="L159" href="#L159">159</a> }
-<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">catch</strong> ( RendererException e )
-<a class="jxr_linenumber" name="L161" href="#L161">161</a> {
-<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(
-<a class="jxr_linenumber" name="L163" href="#L163">163</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="L164" href="#L164">164</a> }
-<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
-<a class="jxr_linenumber" name="L166" href="#L166">166</a> {
-<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(
-<a class="jxr_linenumber" name="L168" href="#L168">168</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="L169" href="#L169">169</a> }
-<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">catch</strong> ( MavenReportException e )
-<a class="jxr_linenumber" name="L171" href="#L171">171</a> {
-<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(
-<a class="jxr_linenumber" name="L173" href="#L173">173</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="L174" href="#L174">174</a> }
-<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">finally</strong>
-<a class="jxr_linenumber" name="L176" href="#L176">176</a> {
-<a class="jxr_linenumber" name="L177" href="#L177">177</a> IOUtil.close( writer );
-<a class="jxr_linenumber" name="L178" href="#L178">178</a> }
-<a class="jxr_linenumber" name="L179" href="#L179">179</a> }
-<a class="jxr_linenumber" name="L180" href="#L180">180</a>
-<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> * create template properties like done in maven-site-plugin's</em>
-<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * <code>AbstractSiteRenderingMojo.createSiteRenderingContext( Locale )</code></em>
-<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * @return properties</em>
-<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">private</strong> Map<String, Object> getTemplateProperties()
-<a class="jxr_linenumber" name="L187" href="#L187">187</a> {
-<a class="jxr_linenumber" name="L188" href="#L188">188</a> Map<String, Object> templateProperties = <strong class="jxr_keyword">new</strong> HashMap<String, Object>();
-<a class="jxr_linenumber" name="L189" href="#L189">189</a> templateProperties.put( <span class="jxr_string">"project"</span>, getProject() );
-<a class="jxr_linenumber" name="L190" href="#L190">190</a> templateProperties.put( <span class="jxr_string">"inputEncoding"</span>, getInputEncoding() );
-<a class="jxr_linenumber" name="L191" href="#L191">191</a> templateProperties.put( <span class="jxr_string">"outputEncoding"</span>, getOutputEncoding() );
-<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_comment">// Put any of the properties in directly into the Velocity context</em>
-<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">for</strong> ( Map.Entry<Object, Object> entry : getProject().getProperties().entrySet() )
-<a class="jxr_linenumber" name="L194" href="#L194">194</a> {
-<a class="jxr_linenumber" name="L195" href="#L195">195</a> templateProperties.put( (String) entry.getKey(), entry.getValue() );
-<a class="jxr_linenumber" name="L196" href="#L196">196</a> }
-<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">return</strong> templateProperties;
-<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> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> * Generate a report.</em>
-<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * @param sink the sink to use for the generation.</em>
-<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * @param locale the wanted locale to generate the report, could be null.</em>
-<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> * @throws MavenReportException if any</em>
-<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment"> * @deprecated use {@link #generate(Sink, SinkFactory, Locale)} instead.</em>
-<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> generate( org.codehaus.doxia.sink.Sink sink, Locale locale )
-<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">throws</strong> MavenReportException
-<a class="jxr_linenumber" name="L210" href="#L210">210</a> {
-<a class="jxr_linenumber" name="L211" href="#L211">211</a> generate( sink, <strong class="jxr_keyword">null</strong>, locale );
-<a class="jxr_linenumber" name="L212" href="#L212">212</a> }
-<a class="jxr_linenumber" name="L213" href="#L213">213</a>
-<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * Generate a report.</em>
-<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * @param sink</em>
-<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> * @param locale</em>
-<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> * @throws MavenReportException</em>
-<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * @see org.apache.maven.reporting.MavenReport#generate(org.apache.maven.doxia.sink.Sink, java.util.Locale)</em>
-<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> * @deprecated use {@link #generate(Sink, SinkFactory, Locale)} instead.</em>
-<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> generate( Sink sink, Locale locale )
-<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">throws</strong> MavenReportException
-<a class="jxr_linenumber" name="L225" href="#L225">225</a> {
-<a class="jxr_linenumber" name="L226" href="#L226">226</a> generate( sink, <strong class="jxr_keyword">null</strong>, locale );
-<a class="jxr_linenumber" name="L227" href="#L227">227</a> }
-<a class="jxr_linenumber" name="L228" href="#L228">228</a>
-<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> * This method is called when the report generation is invoked by maven-site-plugin.</em>
-<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> * @param sink</em>
-<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> * @param sinkFactory</em>
-<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> * @param locale</em>
-<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> * @throws MavenReportException</em>
-<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> generate( Sink sink, SinkFactory sinkFactory, Locale locale )
-<a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">throws</strong> MavenReportException
-<a class="jxr_linenumber" name="L239" href="#L239">239</a> {
-<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">if</strong> ( !canGenerateReport() )
-<a class="jxr_linenumber" name="L241" href="#L241">241</a> {
-<a class="jxr_linenumber" name="L242" href="#L242">242</a> getLog().info( <span class="jxr_string">"This report cannot be generated as part of the current build. "</span>
-<a class="jxr_linenumber" name="L243" href="#L243">243</a> + <span class="jxr_string">"The report name should be referenced in this line of output."</span> );
-<a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">return</strong>;
-<a class="jxr_linenumber" name="L245" href="#L245">245</a> }
-<a class="jxr_linenumber" name="L246" href="#L246">246</a>
-<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">this</strong>.sink = sink;
-<a class="jxr_linenumber" name="L248" href="#L248">248</a>
-<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">this</strong>.sinkFactory = sinkFactory;
-<a class="jxr_linenumber" name="L250" href="#L250">250</a>
-<a class="jxr_linenumber" name="L251" href="#L251">251</a> executeReport( locale );
-<a class="jxr_linenumber" name="L252" href="#L252">252</a>
-<a class="jxr_linenumber" name="L253" href="#L253">253</a> closeReport();
-<a class="jxr_linenumber" name="L254" href="#L254">254</a> }
-<a class="jxr_linenumber" name="L255" href="#L255">255</a>
-<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * {@inheritDoc}</em>
-<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * @return CATEGORY_PROJECT_REPORTS</em>
-<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">public</strong> String getCategoryName()
-<a class="jxr_linenumber" name="L261" href="#L261">261</a> {
-<a class="jxr_linenumber" name="L262" href="#L262">262</a> <strong class="jxr_keyword">return</strong> CATEGORY_PROJECT_REPORTS;
-<a class="jxr_linenumber" name="L263" href="#L263">263</a> }
-<a class="jxr_linenumber" name="L264" href="#L264">264</a>
-<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em>
-<a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong class="jxr_keyword">public</strong> File getReportOutputDirectory()
-<a class="jxr_linenumber" name="L267" href="#L267">267</a> {
-<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">if</strong> ( reportOutputDirectory == <strong class="jxr_keyword">null</strong> )
-<a class="jxr_linenumber" name="L269" href="#L269">269</a> {
-<a class="jxr_linenumber" name="L270" href="#L270">270</a> reportOutputDirectory = <strong class="jxr_keyword">new</strong> File( getOutputDirectory() );
-<a class="jxr_linenumber" name="L271" href="#L271">271</a> }
-<a class="jxr_linenumber" name="L272" href="#L272">272</a>
-<a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">return</strong> reportOutputDirectory;
-<a class="jxr_linenumber" name="L274" href="#L274">274</a> }
-<a class="jxr_linenumber" name="L275" href="#L275">275</a>
-<a class="jxr_linenumber" name="L276" href="#L276">276</a> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em>
-<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setReportOutputDirectory( File reportOutputDirectory )
-<a class="jxr_linenumber" name="L278" href="#L278">278</a> {
-<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">this</strong>.reportOutputDirectory = reportOutputDirectory;
-<a class="jxr_linenumber" name="L280" href="#L280">280</a> <strong class="jxr_keyword">this</strong>.outputDirectory = reportOutputDirectory;
-<a class="jxr_linenumber" name="L281" href="#L281">281</a> }
-<a class="jxr_linenumber" name="L282" href="#L282">282</a>
-<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">protected</strong> String getOutputDirectory()
-<a class="jxr_linenumber" name="L284" href="#L284">284</a> {
-<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">return</strong> outputDirectory.getAbsolutePath();
-<a class="jxr_linenumber" name="L286" href="#L286">286</a> }
-<a class="jxr_linenumber" name="L287" href="#L287">287</a>
-<a class="jxr_linenumber" name="L288" href="#L288">288</a> <strong class="jxr_keyword">protected</strong> MavenProject getProject()
-<a class="jxr_linenumber" name="L289" href="#L289">289</a> {
-<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">return</strong> project;
-<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> <strong class="jxr_keyword">protected</strong> Renderer getSiteRenderer()
-<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> siteRenderer;
-<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"> * Gets the input files encoding.</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"> * @return The input files encoding, never <code>null</code>.</em>
-<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">protected</strong> String getInputEncoding()
-<a class="jxr_linenumber" name="L304" href="#L304">304</a> {
-<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">return</strong> ( inputEncoding == <strong class="jxr_keyword">null</strong> ) ? ReaderFactory.FILE_ENCODING : inputEncoding;
-<a class="jxr_linenumber" name="L306" href="#L306">306</a> }
-<a class="jxr_linenumber" name="L307" href="#L307">307</a>
-<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> * Gets the effective reporting output files encoding.</em>
-<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment"> * @return The effective reporting output file encoding, never <code>null</code>.</em>
-<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L313" href="#L313">313</a> <strong class="jxr_keyword">protected</strong> String getOutputEncoding()
-<a class="jxr_linenumber" name="L314" href="#L314">314</a> {
-<a class="jxr_linenumber" name="L315" href="#L315">315</a> <strong class="jxr_keyword">return</strong> ( outputEncoding == <strong class="jxr_keyword">null</strong> ) ? WriterFactory.UTF_8 : outputEncoding;
-<a class="jxr_linenumber" name="L316" href="#L316">316</a> }
-<a class="jxr_linenumber" name="L317" href="#L317">317</a>
-<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> * Actions when closing the report.</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> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> closeReport()
-<a class="jxr_linenumber" name="L322" href="#L322">322</a> {
-<a class="jxr_linenumber" name="L323" href="#L323">323</a> getSink().close();
-<a class="jxr_linenumber" name="L324" href="#L324">324</a> }
-<a class="jxr_linenumber" name="L325" href="#L325">325</a>
-<a class="jxr_linenumber" name="L326" href="#L326">326</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L327" href="#L327">327</a> <em class="jxr_javadoccomment"> * @return the sink used</em>
-<a class="jxr_linenumber" name="L328" href="#L328">328</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L329" href="#L329">329</a> <strong class="jxr_keyword">public</strong> Sink getSink()
-<a class="jxr_linenumber" name="L330" href="#L330">330</a> {
-<a class="jxr_linenumber" name="L331" href="#L331">331</a> <strong class="jxr_keyword">return</strong> sink;
-<a class="jxr_linenumber" name="L332" href="#L332">332</a> }
-<a class="jxr_linenumber" name="L333" href="#L333">333</a>
-<a class="jxr_linenumber" name="L334" href="#L334">334</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L335" href="#L335">335</a> <em class="jxr_javadoccomment"> * @return the sink factory used</em>
-<a class="jxr_linenumber" name="L336" href="#L336">336</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L337" href="#L337">337</a> <strong class="jxr_keyword">public</strong> SinkFactory getSinkFactory()
-<a class="jxr_linenumber" name="L338" href="#L338">338</a> {
-<a class="jxr_linenumber" name="L339" href="#L339">339</a> <strong class="jxr_keyword">return</strong> sinkFactory;
-<a class="jxr_linenumber" name="L340" href="#L340">340</a> }
-<a class="jxr_linenumber" name="L341" href="#L341">341</a>
-<a class="jxr_linenumber" name="L342" href="#L342">342</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L343" href="#L343">343</a> <em class="jxr_javadoccomment"> * @see org.apache.maven.reporting.MavenReport#isExternalReport()</em>
-<a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_javadoccomment"> * @return <tt>false</tt> by default.</em>
-<a class="jxr_linenumber" name="L345" href="#L345">345</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L346" href="#L346">346</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isExternalReport()
-<a class="jxr_linenumber" name="L347" href="#L347">347</a> {
-<a class="jxr_linenumber" name="L348" href="#L348">348</a> <strong class="jxr_keyword">return</strong> false;
-<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> <em class="jxr_javadoccomment">/** {@inheritDoc} */</em>
-<a class="jxr_linenumber" name="L352" href="#L352">352</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport()
-<a class="jxr_linenumber" name="L353" href="#L353">353</a> {
-<a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
-<a class="jxr_linenumber" name="L355" href="#L355">355</a> }
-<a class="jxr_linenumber" name="L356" href="#L356">356</a>
-<a class="jxr_linenumber" name="L357" href="#L357">357</a> <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L358" href="#L358">358</a> <em class="jxr_javadoccomment"> * Execute the generation of the report.</em>
-<a class="jxr_linenumber" name="L359" href="#L359">359</a> <em class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L360" href="#L360">360</a> <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="L361" href="#L361">361</a> <em class="jxr_javadoccomment"> * @throws MavenReportException if any</em>
-<a class="jxr_linenumber" name="L362" href="#L362">362</a> <em class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L363" href="#L363">363</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> executeReport( Locale locale )
-<a class="jxr_linenumber" name="L364" href="#L364">364</a> <strong class="jxr_keyword">throws</strong> MavenReportException;
-<a class="jxr_linenumber" name="L365" href="#L365">365</a> }
-</pre>
-<hr/>
-<div id="footer">Copyright © 2002–2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
-</body>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+<title>AbstractMavenReport xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../apidocs/org/apache/maven/reporting/AbstractMavenReport.html">View Javadoc</a></div><pre>
+<a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.reporting;
+<a class="jxr_linenumber" name="L2" href="#L2">2</a>
+<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
+<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
+<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
+<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
+<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
+<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
+<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
+<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
+<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
+<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
+<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
+<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
+<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
+<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> * under the License.</em>
+<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment"> */</em>
+<a class="jxr_linenumber" name="L21" href="#L21">21</a>
+<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.Sink;
+<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.sink.SinkFactory;
+<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.DecorationModel;
+<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.Renderer;
+<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.RendererException;
+<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.RenderingContext;
+<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.SiteRenderingContext;
+<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
+<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo;
+<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
+<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component;
+<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter;
+<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.utils.WriterFactory;
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory;
+<a class="jxr_linenumber" name="L37" href="#L37">37</a>
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> java.io.File;
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> java.io.FileOutputStream;
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> java.io.OutputStreamWriter;
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> java.io.Writer;
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> java.util.HashMap;
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
+<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> java.util.Map;
+<a class="jxr_linenumber" name="L46" href="#L46">46</a>
+<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L48" href="#L48">48</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="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * as a direct standalone goal invocation.</em>
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * Both invocations are delegated to <code>abstract executeReport( Locale )</code> from:</em>
+<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * <ul></em>
+<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * <li>Mojo's <code>execute()</code> method, see maven-plugin-api</li></em>
+<a class="jxr_linenumber" name="L53" href="#L53">53</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="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * </ul></em>
+<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * @author <a href="evenisse@apache.org">Emmanuel Venisse</a></em>
+<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * @since 2.0</em>
+<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * @see #execute() <code>Mojo.execute()</code>, from maven-plugin-api</em>
+<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * @see #generate(Sink, SinkFactory, Locale) <code>MavenMultiPageReport.generate( Sink, SinkFactory, Locale )</code>,</em>
+<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * from maven-reporting-api</em>
+<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * @see #executeReport(Locale) <code>abstract executeReport( Locale )</code></em>
+<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/maven/reporting/AbstractMavenReport.html">AbstractMavenReport</a>
+<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">extends</strong> AbstractMojo
+<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">implements</strong> MavenMultiPageReport
+<a class="jxr_linenumber" name="L66" href="#L66">66</a> {
+<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L68" href="#L68">68</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="L69" href="#L69">69</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="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * the Maven Site Plugin is used instead.</em>
+<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L72" href="#L72">72</a> @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="L73" href="#L73">73</a> <strong class="jxr_keyword">protected</strong> File outputDirectory;
+<a class="jxr_linenumber" name="L74" href="#L74">74</a>
+<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 Maven Project.</em>
+<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L78" href="#L78">78</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="L79" href="#L79">79</a> <strong class="jxr_keyword">protected</strong> MavenProject project;
+<a class="jxr_linenumber" name="L80" href="#L80">80</a>
+<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * Specifies the input encoding.</em>
+<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> @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="L85" href="#L85">85</a> <strong class="jxr_keyword">private</strong> String inputEncoding;
+<a class="jxr_linenumber" name="L86" href="#L86">86</a>
+<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * Specifies the output encoding.</em>
+<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> @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="L91" href="#L91">91</a> <strong class="jxr_keyword">private</strong> String outputEncoding;
+<a class="jxr_linenumber" name="L92" href="#L92">92</a>
+<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * Doxia Site Renderer component.</em>
+<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> @Component
+<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">protected</strong> Renderer siteRenderer;
+<a class="jxr_linenumber" name="L98" href="#L98">98</a>
+<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment">/** The current sink to use */</em>
+<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">private</strong> Sink sink;
+<a class="jxr_linenumber" name="L101" href="#L101">101</a>
+<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment">/** The sink factory to use */</em>
+<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">private</strong> SinkFactory sinkFactory;
+<a class="jxr_linenumber" name="L104" href="#L104">104</a>
+<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment">/** The current report output directory to use */</em>
+<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">private</strong> File reportOutputDirectory;
+<a class="jxr_linenumber" name="L107" href="#L107">107</a>
+<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> <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="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException if an error occurs when generating the report</em>
+<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * @see org.apache.maven.plugin.Mojo#execute()</em>
+<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L114" href="#L114">114</a> @Override
+<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute()
+<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
+<a class="jxr_linenumber" name="L117" href="#L117">117</a> {
+<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">if</strong> ( !canGenerateReport() )
+<a class="jxr_linenumber" name="L119" href="#L119">119</a> {
+<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">return</strong>;
+<a class="jxr_linenumber" name="L121" href="#L121">121</a> }
+<a class="jxr_linenumber" name="L122" href="#L122">122</a>
+<a class="jxr_linenumber" name="L123" href="#L123">123</a> File outputDirectory = <strong class="jxr_keyword">new</strong> File( getOutputDirectory() );
+<a class="jxr_linenumber" name="L124" href="#L124">124</a>
+<a class="jxr_linenumber" name="L125" href="#L125">125</a> String filename = getOutputName() + <span class="jxr_string">".html"</span>;
+<a class="jxr_linenumber" name="L126" href="#L126">126</a>
+<a class="jxr_linenumber" name="L127" href="#L127">127</a> Locale locale = Locale.getDefault();
+<a class="jxr_linenumber" name="L128" href="#L128">128</a>
+<a class="jxr_linenumber" name="L129" href="#L129">129</a> SiteRenderingContext siteContext = <strong class="jxr_keyword">new</strong> SiteRenderingContext();
+<a class="jxr_linenumber" name="L130" href="#L130">130</a> siteContext.setDecoration( <strong class="jxr_keyword">new</strong> DecorationModel() );
+<a class="jxr_linenumber" name="L131" href="#L131">131</a> siteContext.setTemplateName( <span class="jxr_string">"org/apache/maven/doxia/siterenderer/resources/default-site.vm"</span> );
+<a class="jxr_linenumber" name="L132" href="#L132">132</a> siteContext.setLocale( locale );
+<a class="jxr_linenumber" name="L133" href="#L133">133</a> siteContext.setTemplateProperties( getTemplateProperties() );
+<a class="jxr_linenumber" name="L134" href="#L134">134</a>
+<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_comment">// TODO Replace null with real value</em>
+<a class="jxr_linenumber" name="L136" href="#L136">136</a> RenderingContext context = <strong class="jxr_keyword">new</strong> RenderingContext( outputDirectory, filename, <strong class="jxr_keyword">null</strong> );
+<a class="jxr_linenumber" name="L137" href="#L137">137</a>
+<a class="jxr_linenumber" name="L138" href="#L138">138</a> SiteRendererSink sink = <strong class="jxr_keyword">new</strong> SiteRendererSink( context );
+<a class="jxr_linenumber" name="L139" href="#L139">139</a>
+<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">try</strong>
+<a class="jxr_linenumber" name="L141" href="#L141">141</a> {
+<a class="jxr_linenumber" name="L142" href="#L142">142</a>
+<a class="jxr_linenumber" name="L143" href="#L143">143</a> generate( sink, <strong class="jxr_keyword">null</strong>, locale );
+<a class="jxr_linenumber" name="L144" href="#L144">144</a>
+<a class="jxr_linenumber" name="L145" href="#L145">145</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="L146" href="#L146">146</a> {
+<a class="jxr_linenumber" name="L147" href="#L147">147</a> outputDirectory.mkdirs();
+<a class="jxr_linenumber" name="L148" href="#L148">148</a>
+<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">try</strong> ( Writer writer =
+<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">new</strong> OutputStreamWriter( <strong class="jxr_keyword">new</strong> FileOutputStream( <strong class="jxr_keyword">new</strong> File( outputDirectory, filename ) ),
+<a class="jxr_linenumber" name="L151" href="#L151">151</a> getOutputEncoding() ) )
+<a class="jxr_linenumber" name="L152" href="#L152">152</a> {
+<a class="jxr_linenumber" name="L153" href="#L153">153</a> getSiteRenderer().mergeDocumentIntoSite( writer, sink, siteContext );
+<a class="jxr_linenumber" name="L154" href="#L154">154</a> }
+<a class="jxr_linenumber" name="L155" href="#L155">155</a> }
+<a class="jxr_linenumber" name="L156" href="#L156">156</a> }
+<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">catch</strong> ( RendererException | IOException | MavenReportException e )
+<a class="jxr_linenumber" name="L158" href="#L158">158</a> {
+<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(
+<a class="jxr_linenumber" name="L160" href="#L160">160</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="L161" href="#L161">161</a> }
+<a class="jxr_linenumber" name="L162" href="#L162">162</a> }
+<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"> * create template properties like done in maven-site-plugin's</em>
+<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * <code>AbstractSiteRenderingMojo.createSiteRenderingContext( Locale )</code></em>
+<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * @return properties</em>
+<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">private</strong> Map<String, Object> getTemplateProperties()
+<a class="jxr_linenumber" name="L170" href="#L170">170</a> {
+<a class="jxr_linenumber" name="L171" href="#L171">171</a> Map<String, Object> templateProperties = <strong class="jxr_keyword">new</strong> HashMap<>();
+<a class="jxr_linenumber" name="L172" href="#L172">172</a> templateProperties.put( <span class="jxr_string">"project"</span>, getProject() );
+<a class="jxr_linenumber" name="L173" href="#L173">173</a> templateProperties.put( <span class="jxr_string">"inputEncoding"</span>, getInputEncoding() );
+<a class="jxr_linenumber" name="L174" href="#L174">174</a> templateProperties.put( <span class="jxr_string">"outputEncoding"</span>, getOutputEncoding() );
+<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_comment">// Put any of the properties in directly into the Velocity context</em>
+<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">for</strong> ( Map.Entry<Object, Object> entry : getProject().getProperties().entrySet() )
+<a class="jxr_linenumber" name="L177" href="#L177">177</a> {
+<a class="jxr_linenumber" name="L178" href="#L178">178</a> templateProperties.put( (String) entry.getKey(), entry.getValue() );
+<a class="jxr_linenumber" name="L179" href="#L179">179</a> }
+<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">return</strong> templateProperties;
+<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> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * Generate a report.</em>
+<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * @param sink the sink to use for the generation.</em>
+<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * @param locale the wanted locale to generate the report, could be null.</em>
+<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * @throws MavenReportException if any</em>
+<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> * @deprecated use {@link #generate(Sink, SinkFactory, Locale)} instead.</em>
+<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L191" href="#L191">191</a> @Deprecated
+<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> generate( org.codehaus.doxia.sink.Sink sink, Locale locale )
+<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">throws</strong> MavenReportException
+<a class="jxr_linenumber" name="L194" href="#L194">194</a> {
+<a class="jxr_linenumber" name="L195" href="#L195">195</a> generate( sink, <strong class="jxr_keyword">null</strong>, locale );
+<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> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * Generate a report.</em>
+<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> * @param sink</em>
+<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * @param locale</em>
+<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * @throws MavenReportException</em>
+<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> * @deprecated use {@link #generate(Sink, SinkFactory, Locale)} instead.</em>
+<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L206" href="#L206">206</a> @Deprecated
+<a class="jxr_linenumber" name="L207" href="#L207">207</a> @Override
+<a class="jxr_linenumber" name="L208" href="#L208">208</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> generate( Sink sink, Locale locale )
+<a class="jxr_linenumber" name="L209" href="#L209">209</a> <strong class="jxr_keyword">throws</strong> MavenReportException
+<a class="jxr_linenumber" name="L210" href="#L210">210</a> {
+<a class="jxr_linenumber" name="L211" href="#L211">211</a> generate( sink, <strong class="jxr_keyword">null</strong>, locale );
+<a class="jxr_linenumber" name="L212" href="#L212">212</a> }
+<a class="jxr_linenumber" name="L213" href="#L213">213</a>
+<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * This method is called when the report generation is invoked by maven-site-plugin.</em>
+<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * @param sink</em>
+<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> * @param sinkFactory</em>
+<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> * @param locale</em>
+<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * @throws MavenReportException</em>
+<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L222" href="#L222">222</a> @Override
+<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> generate( Sink sink, SinkFactory sinkFactory, Locale locale )
+<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">throws</strong> MavenReportException
+<a class="jxr_linenumber" name="L225" href="#L225">225</a> {
+<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong class="jxr_keyword">if</strong> ( !canGenerateReport() )
+<a class="jxr_linenumber" name="L227" href="#L227">227</a> {
+<a class="jxr_linenumber" name="L228" href="#L228">228</a> getLog().info( <span class="jxr_string">"This report cannot be generated as part of the current build. "</span>
+<a class="jxr_linenumber" name="L229" href="#L229">229</a> + <span class="jxr_string">"The report name should be referenced in this line of output."</span> );
+<a class="jxr_linenumber" name="L230" href="#L230">230</a> <strong class="jxr_keyword">return</strong>;
+<a class="jxr_linenumber" name="L231" href="#L231">231</a> }
+<a class="jxr_linenumber" name="L232" href="#L232">232</a>
+<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">this</strong>.sink = sink;
+<a class="jxr_linenumber" name="L234" href="#L234">234</a>
+<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">this</strong>.sinkFactory = sinkFactory;
+<a class="jxr_linenumber" name="L236" href="#L236">236</a>
+<a class="jxr_linenumber" name="L237" href="#L237">237</a> executeReport( locale );
+<a class="jxr_linenumber" name="L238" href="#L238">238</a>
+<a class="jxr_linenumber" name="L239" href="#L239">239</a> closeReport();
+<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> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment"> * @return CATEGORY_PROJECT_REPORTS</em>
+<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L245" href="#L245">245</a> @Override
+<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">public</strong> String getCategoryName()
+<a class="jxr_linenumber" name="L247" href="#L247">247</a> {
+<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong class="jxr_keyword">return</strong> CATEGORY_PROJECT_REPORTS;
+<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> @Override
+<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">public</strong> File getReportOutputDirectory()
+<a class="jxr_linenumber" name="L253" href="#L253">253</a> {
+<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">if</strong> ( reportOutputDirectory == <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="L255" href="#L255">255</a> {
+<a class="jxr_linenumber" name="L256" href="#L256">256</a> reportOutputDirectory = <strong class="jxr_keyword">new</strong> File( getOutputDirectory() );
+<a class="jxr_linenumber" name="L257" href="#L257">257</a> }
+<a class="jxr_linenumber" name="L258" href="#L258">258</a>
+<a class="jxr_linenumber" name="L259" href="#L259">259</a> <strong class="jxr_keyword">return</strong> reportOutputDirectory;
+<a class="jxr_linenumber" name="L260" href="#L260">260</a> }
+<a class="jxr_linenumber" name="L261" href="#L261">261</a>
+<a class="jxr_linenumber" name="L262" href="#L262">262</a> @Override
+<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setReportOutputDirectory( File reportOutputDirectory )
+<a class="jxr_linenumber" name="L264" href="#L264">264</a> {
+<a class="jxr_linenumber" name="L265" href="#L265">265</a> <strong class="jxr_keyword">this</strong>.reportOutputDirectory = reportOutputDirectory;
+<a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong class="jxr_keyword">this</strong>.outputDirectory = reportOutputDirectory;
+<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> <strong class="jxr_keyword">protected</strong> String getOutputDirectory()
+<a class="jxr_linenumber" name="L270" href="#L270">270</a> {
+<a class="jxr_linenumber" name="L271" href="#L271">271</a> <strong class="jxr_keyword">return</strong> outputDirectory.getAbsolutePath();
+<a class="jxr_linenumber" name="L272" href="#L272">272</a> }
+<a class="jxr_linenumber" name="L273" href="#L273">273</a>
+<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">protected</strong> MavenProject getProject()
+<a class="jxr_linenumber" name="L275" href="#L275">275</a> {
+<a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong class="jxr_keyword">return</strong> project;
+<a class="jxr_linenumber" name="L277" href="#L277">277</a> }
+<a class="jxr_linenumber" name="L278" href="#L278">278</a>
+<a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">protected</strong> Renderer getSiteRenderer()
+<a class="jxr_linenumber" name="L280" href="#L280">280</a> {
+<a class="jxr_linenumber" name="L281" href="#L281">281</a> <strong class="jxr_keyword">return</strong> siteRenderer;
+<a class="jxr_linenumber" name="L282" href="#L282">282</a> }
+<a class="jxr_linenumber" name="L283" href="#L283">283</a>
+<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> * Gets the input files encoding.</em>
+<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * @return The input files encoding, never <code>null</code>.</em>
+<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">protected</strong> String getInputEncoding()
+<a class="jxr_linenumber" name="L290" href="#L290">290</a> {
+<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">return</strong> ( inputEncoding == <strong class="jxr_keyword">null</strong> ) ? ReaderFactory.FILE_ENCODING : inputEncoding;
+<a class="jxr_linenumber" name="L292" href="#L292">292</a> }
+<a class="jxr_linenumber" name="L293" href="#L293">293</a>
+<a class="jxr_linenumber" name="L294" href="#L294">294</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L295" href="#L295">295</a> <em class="jxr_javadoccomment"> * Gets the effective reporting output files encoding.</em>
+<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> * @return The effective reporting output file encoding, never <code>null</code>.</em>
+<a class="jxr_linenumber" name="L298" href="#L298">298</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L299" href="#L299">299</a> <strong class="jxr_keyword">protected</strong> String getOutputEncoding()
+<a class="jxr_linenumber" name="L300" href="#L300">300</a> {
+<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong class="jxr_keyword">return</strong> ( outputEncoding == <strong class="jxr_keyword">null</strong> ) ? WriterFactory.UTF_8 : outputEncoding;
+<a class="jxr_linenumber" name="L302" href="#L302">302</a> }
+<a class="jxr_linenumber" name="L303" href="#L303">303</a>
+<a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment"> * Actions when closing the report.</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> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> closeReport()
+<a class="jxr_linenumber" name="L308" href="#L308">308</a> {
+<a class="jxr_linenumber" name="L309" href="#L309">309</a> getSink().close();
+<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"> * @return the sink used</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> <strong class="jxr_keyword">public</strong> Sink getSink()
+<a class="jxr_linenumber" name="L316" href="#L316">316</a> {
+<a class="jxr_linenumber" name="L317" href="#L317">317</a> <strong class="jxr_keyword">return</strong> sink;
+<a class="jxr_linenumber" name="L318" href="#L318">318</a> }
+<a class="jxr_linenumber" name="L319" href="#L319">319</a>
+<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> <em class="jxr_javadoccomment"> * @return the sink factory used</em>
+<a class="jxr_linenumber" name="L322" href="#L322">322</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L323" href="#L323">323</a> <strong class="jxr_keyword">public</strong> SinkFactory getSinkFactory()
+<a class="jxr_linenumber" name="L324" href="#L324">324</a> {
+<a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong class="jxr_keyword">return</strong> sinkFactory;
+<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> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L329" href="#L329">329</a> <em class="jxr_javadoccomment"> * @see org.apache.maven.reporting.MavenReport#isExternalReport()</em>
+<a class="jxr_linenumber" name="L330" href="#L330">330</a> <em class="jxr_javadoccomment"> * @return {@code false} by default.</em>
+<a class="jxr_linenumber" name="L331" href="#L331">331</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L332" href="#L332">332</a> @Override
+<a class="jxr_linenumber" name="L333" href="#L333">333</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isExternalReport()
+<a class="jxr_linenumber" name="L334" href="#L334">334</a> {
+<a class="jxr_linenumber" name="L335" href="#L335">335</a> <strong class="jxr_keyword">return</strong> false;
+<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> @Override
+<a class="jxr_linenumber" name="L339" href="#L339">339</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport()
+<a class="jxr_linenumber" name="L340" href="#L340">340</a> {
+<a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<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> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L345" href="#L345">345</a> <em class="jxr_javadoccomment"> * Execute the generation of the report.</em>
+<a class="jxr_linenumber" name="L346" href="#L346">346</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L347" href="#L347">347</a> <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="L348" href="#L348">348</a> <em class="jxr_javadoccomment"> * @throws MavenReportException if any</em>
+<a class="jxr_linenumber" name="L349" href="#L349">349</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L350" href="#L350">350</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> executeReport( Locale locale )
+<a class="jxr_linenumber" name="L351" href="#L351">351</a> <strong class="jxr_keyword">throws</strong> MavenReportException;
+<a class="jxr_linenumber" name="L352" href="#L352">352</a> }
+</pre>
+<hr/>
+<div id="footer">Copyright © 2002–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
+</body>
</html>
\ No newline at end of file