Google Git
Sign in
apache / creadur-site / 884397342c3371df8a501072a271104b6416a3a1 / . / apache-rat-plugin / xref / org / apache / rat / mp / RatReportMojo.html
blob: 1e4c01a2f3a570cc68ccb460ebd2a56548257fc6 [file] [log] [blame]
<!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>RatReportMojo xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/rat/mp/RatReportMojo.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> org.apache.rat.mp;
<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.artifact.Artifact;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.factory.ArtifactFactory;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.repository.ArtifactRepository;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.resolver.ArtifactNotFoundException;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.resolver.ArtifactResolutionException;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.resolver.ArtifactResolver;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.versioning.InvalidVersionSpecificationException;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.versioning.VersionRange;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.Body;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.DecorationModel;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.Skin;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.Renderer;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.RendererException;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.RenderingContext;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.SiteRenderingContext;
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.siterenderer.sink.SiteRendererSink;
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException;
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component;
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo;
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter;
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.ResolutionScope;
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReport;
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReportException;
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">import</strong> org.apache.rat.Defaults;
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">import</strong> org.codehaus.doxia.sink.Sink;
<a class="jxr_linenumber" name="L48" href="#L48">48</a>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">import</strong> java.io.FileWriter;
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">import</strong> java.io.Writer;
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">import</strong> java.util.HashMap;
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">import</strong> java.util.Iterator;
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">import</strong> java.util.ResourceBundle;
<a class="jxr_linenumber" name="L58" href="#L58">58</a>
<a class="jxr_linenumber" name="L59" href="#L59">59</a>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * Generates a report with Rat's output.</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> @SuppressWarnings(<span class="jxr_string">"deprecation"</span>) <em class="jxr_comment">// MavenReport invokes the deprecated Sink implementation</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> @Mojo(name = <span class="jxr_string">"rat"</span>, requiresDependencyResolution = ResolutionScope.TEST)
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/rat/mp/RatReportMojo.html">RatReportMojo</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/rat/mp/AbstractRatMojo.html">AbstractRatMojo</a> <strong class="jxr_keyword">implements</strong> MavenReport {
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DOT_HTML = <span class="jxr_string">".html"</span>;
<a class="jxr_linenumber" name="L67" href="#L67">67</a> @Component
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">private</strong> Renderer siteRenderer;
<a class="jxr_linenumber" name="L69" href="#L69">69</a>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> @Component
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">private</strong> ArtifactFactory factory;
<a class="jxr_linenumber" name="L72" href="#L72">72</a>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> @Component
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">private</strong> ArtifactResolver resolver;
<a class="jxr_linenumber" name="L75" href="#L75">75</a>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * Specifies the directory where the report will be generated</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>, required = <strong class="jxr_keyword">true</strong>)
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">private</strong> File outputDirectory;
<a class="jxr_linenumber" name="L81" href="#L81">81</a>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> @Parameter(defaultValue = <span class="jxr_string">"${localRepository}"</span>, required = <strong class="jxr_keyword">true</strong>, readonly = <strong class="jxr_keyword">true</strong>)
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> ArtifactRepository localRepository;
<a class="jxr_linenumber" name="L84" href="#L84">84</a>
<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> <em class="jxr_javadoccomment"> * Returns the skins artifact file.</em>
<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"> * @return Artifact file</em>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException An error in the plugin configuration was detected.</em>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException An error occurred while searching for the artifact file.</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> <strong class="jxr_keyword">private</strong> File getSkinArtifactFile() <strong class="jxr_keyword">throws</strong> MojoFailureException, MojoExecutionException {
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">final</strong> Skin skin = Skin.getDefaultSkin();
<a class="jxr_linenumber" name="L94" href="#L94">94</a>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> String version = skin.getVersion();
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">final</strong> Artifact artifact;
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">if</strong> (version == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L99" href="#L99">99</a> version = Artifact.RELEASE_VERSION;
<a class="jxr_linenumber" name="L100" href="#L100">100</a> }
<a class="jxr_linenumber" name="L101" href="#L101">101</a> VersionRange versionSpec = VersionRange.createFromVersionSpec(version);
<a class="jxr_linenumber" name="L102" href="#L102">102</a> artifact =
<a class="jxr_linenumber" name="L103" href="#L103">103</a> factory.createDependencyArtifact(skin.getGroupId(), skin.getArtifactId(), versionSpec, <span class="jxr_string">"jar"</span>, <strong class="jxr_keyword">null</strong>,
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L105" href="#L105">105</a>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> resolver.resolve(artifact, getProject().getRemoteArtifactRepositories(), localRepository);
<a class="jxr_linenumber" name="L107" href="#L107">107</a> } <strong class="jxr_keyword">catch</strong> (InvalidVersionSpecificationException e) {
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException(<span class="jxr_string">"The skin version '"</span> + version + <span class="jxr_string">"' is not valid: "</span> + e.getMessage());
<a class="jxr_linenumber" name="L109" href="#L109">109</a> } <strong class="jxr_keyword">catch</strong> (ArtifactResolutionException e) {
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Unable to find skin"</span>, e);
<a class="jxr_linenumber" name="L111" href="#L111">111</a> } <strong class="jxr_keyword">catch</strong> (ArtifactNotFoundException e) {
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException(<span class="jxr_string">"The skin does not exist: "</span> + e.getMessage());
<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
<a class="jxr_linenumber" name="L114" href="#L114">114</a>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">return</strong> artifact.getFile();
<a class="jxr_linenumber" name="L116" href="#L116">116</a> }
<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"> * Called from Maven to invoke the plugin.</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> <em class="jxr_javadoccomment"> * @throws MojoFailureException An error in the plugin configuration was detected.</em>
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException An error occurred while creating the report.</em>
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">if</strong> (skip) {
<a class="jxr_linenumber" name="L126" href="#L126">126</a> getLog().info(<span class="jxr_string">"RAT will not execute since it is configured to be skipped via system property 'rat.skip'."</span>);
<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="L128" href="#L128">128</a> }
<a class="jxr_linenumber" name="L129" href="#L129">129</a>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">final</strong> DecorationModel model = <strong class="jxr_keyword">new</strong> DecorationModel();
<a class="jxr_linenumber" name="L131" href="#L131">131</a> model.setBody(<strong class="jxr_keyword">new</strong> Body());
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">final</strong> Map&lt;String, String&gt; attributes = <strong class="jxr_keyword">new</strong> HashMap&lt;String, String&gt;();
<a class="jxr_linenumber" name="L133" href="#L133">133</a> attributes.put(<span class="jxr_string">"outputEncoding"</span>, <span class="jxr_string">"UTF-8"</span>);
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">final</strong> Locale locale = Locale.getDefault();
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">final</strong> SiteRenderingContext siteContext =
<a class="jxr_linenumber" name="L137" href="#L137">137</a> siteRenderer.createContextForSkin(getSkinArtifactFile(), attributes, model, getName(locale),
<a class="jxr_linenumber" name="L138" href="#L138">138</a> locale);
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">final</strong> RenderingContext context = <strong class="jxr_keyword">new</strong> RenderingContext(outputDirectory, getOutputName() + DOT_HTML);
<a class="jxr_linenumber" name="L140" href="#L140">140</a>
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">final</strong> SiteRendererSink sink = <strong class="jxr_keyword">new</strong> SiteRendererSink(context);
<a class="jxr_linenumber" name="L142" href="#L142">142</a> generate(sink, locale);
<a class="jxr_linenumber" name="L143" href="#L143">143</a>
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">if</strong> (!outputDirectory.mkdirs() &amp;&amp; !outputDirectory.isDirectory()) {
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(<span class="jxr_string">"Could not create output directory "</span> + outputDirectory);
<a class="jxr_linenumber" name="L146" href="#L146">146</a> }
<a class="jxr_linenumber" name="L147" href="#L147">147</a>
<a class="jxr_linenumber" name="L148" href="#L148">148</a>
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">final</strong> Writer writer = <strong class="jxr_keyword">new</strong> FileWriter(<strong class="jxr_keyword">new</strong> File(outputDirectory, getOutputName() + DOT_HTML));
<a class="jxr_linenumber" name="L150" href="#L150">150</a>
<a class="jxr_linenumber" name="L151" href="#L151">151</a> siteRenderer.generateDocument(writer, sink, siteContext);
<a class="jxr_linenumber" name="L152" href="#L152">152</a>
<a class="jxr_linenumber" name="L153" href="#L153">153</a> siteRenderer.copyResources(siteContext, <strong class="jxr_keyword">new</strong> File(getProject().getBasedir(), <span class="jxr_string">"src/site/resources"</span>),
<a class="jxr_linenumber" name="L154" href="#L154">154</a> outputDirectory);
<a class="jxr_linenumber" name="L155" href="#L155">155</a> } <strong class="jxr_keyword">catch</strong> (IOException e) {
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(e.getMessage(), e);
<a class="jxr_linenumber" name="L157" href="#L157">157</a> } <strong class="jxr_keyword">catch</strong> (MavenReportException e) {
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(e.getMessage(), e);
<a class="jxr_linenumber" name="L159" href="#L159">159</a> } <strong class="jxr_keyword">catch</strong> (RendererException e) {
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(e.getMessage(), 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"> * Returns, whether the report may be generated.</em>
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * @return Always true.</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">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() {
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L171" href="#L171">171</a> }
<a class="jxr_linenumber" name="L172" href="#L172">172</a>
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * Searches for a Rat artifact in the dependency list and returns its version.</em>
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * @return Version number, if found, or null.</em>
<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">private</strong> String getRatVersion() {
<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">for</strong> (@SuppressWarnings(<span class="jxr_string">"unchecked"</span>) <em class="jxr_comment">// library is not yet generified</em>
<a class="jxr_linenumber" name="L180" href="#L180">180</a> Iterator&lt;Artifact&gt; iter = getProject().getDependencyArtifacts().iterator(); iter.hasNext(); ) {
<a class="jxr_linenumber" name="L181" href="#L181">181</a> Artifact a = iter.next();
<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"rat-lib"</span>.equals(a.getArtifactId())) {
<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">return</strong> a.getVersion();
<a class="jxr_linenumber" name="L184" href="#L184">184</a> }
<a class="jxr_linenumber" name="L185" href="#L185">185</a> }
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L187" href="#L187">187</a> }
<a class="jxr_linenumber" name="L188" href="#L188">188</a>
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_javadoccomment"> * Writes the report to the Doxia sink.</em>
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_javadoccomment"> * @param sink The doxia sink, kind of a SAX handler.</em>
<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_javadoccomment"> * @param locale The locale to use for writing the report.</em>
<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em class="jxr_javadoccomment"> * @throws MavenReportException Writing the report failed.</em>
<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L196" href="#L196">196</a> <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="L197" href="#L197">197</a> ResourceBundle bundle = getBundle(locale);
<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">final</strong> String title = bundle.getString(<span class="jxr_string">"report.rat.title"</span>);
<a class="jxr_linenumber" name="L199" href="#L199">199</a> sink.head();
<a class="jxr_linenumber" name="L200" href="#L200">200</a> sink.title();
<a class="jxr_linenumber" name="L201" href="#L201">201</a> sink.text(title);
<a class="jxr_linenumber" name="L202" href="#L202">202</a> sink.title_();
<a class="jxr_linenumber" name="L203" href="#L203">203</a> sink.head_();
<a class="jxr_linenumber" name="L204" href="#L204">204</a>
<a class="jxr_linenumber" name="L205" href="#L205">205</a> sink.body();
<a class="jxr_linenumber" name="L206" href="#L206">206</a>
<a class="jxr_linenumber" name="L207" href="#L207">207</a> sink.section1();
<a class="jxr_linenumber" name="L208" href="#L208">208</a> sink.sectionTitle1();
<a class="jxr_linenumber" name="L209" href="#L209">209</a> sink.text(title);
<a class="jxr_linenumber" name="L210" href="#L210">210</a> sink.sectionTitle1_();
<a class="jxr_linenumber" name="L211" href="#L211">211</a>
<a class="jxr_linenumber" name="L212" href="#L212">212</a> sink.paragraph();
<a class="jxr_linenumber" name="L213" href="#L213">213</a> sink.text(bundle.getString(<span class="jxr_string">"report.rat.link"</span>) + <span class="jxr_string">" "</span>);
<a class="jxr_linenumber" name="L214" href="#L214">214</a> sink.link(bundle.getString(<span class="jxr_string">"report.rat.url"</span>));
<a class="jxr_linenumber" name="L215" href="#L215">215</a> sink.text(bundle.getString(<span class="jxr_string">"report.rat.fullName"</span>));
<a class="jxr_linenumber" name="L216" href="#L216">216</a> sink.link_();
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">final</strong> String ratVersion = getRatVersion();
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">if</strong> (ratVersion != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L219" href="#L219">219</a> sink.text(<span class="jxr_string">" "</span> + ratVersion);
<a class="jxr_linenumber" name="L220" href="#L220">220</a> }
<a class="jxr_linenumber" name="L221" href="#L221">221</a> sink.text(<span class="jxr_string">"."</span>);
<a class="jxr_linenumber" name="L222" href="#L222">222</a> sink.paragraph_();
<a class="jxr_linenumber" name="L223" href="#L223">223</a>
<a class="jxr_linenumber" name="L224" href="#L224">224</a> sink.paragraph();
<a class="jxr_linenumber" name="L225" href="#L225">225</a> sink.verbatim(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L227" href="#L227">227</a> sink.text(createReport(Defaults.getDefaultStyleSheet()));
<a class="jxr_linenumber" name="L228" href="#L228">228</a> } <strong class="jxr_keyword">catch</strong> (MojoExecutionException e) {
<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(e.getMessage(), e);
<a class="jxr_linenumber" name="L230" href="#L230">230</a> } <strong class="jxr_keyword">catch</strong> (MojoFailureException e) {
<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MavenReportException(e.getMessage(), e);
<a class="jxr_linenumber" name="L232" href="#L232">232</a> }
<a class="jxr_linenumber" name="L233" href="#L233">233</a> sink.verbatim_();
<a class="jxr_linenumber" name="L234" href="#L234">234</a> sink.paragraph_();
<a class="jxr_linenumber" name="L235" href="#L235">235</a> sink.section1_();
<a class="jxr_linenumber" name="L236" href="#L236">236</a> sink.body_();
<a class="jxr_linenumber" name="L237" href="#L237">237</a> }
<a class="jxr_linenumber" name="L238" href="#L238">238</a>
<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> * Returns the reports category name.</em>
<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> * @return {@link MavenReport#CATEGORY_PROJECT_REPORTS}</em>
<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">public</strong> String getCategoryName() {
<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">return</strong> MavenReport.CATEGORY_PROJECT_REPORTS;
<a class="jxr_linenumber" name="L246" href="#L246">246</a> }
<a class="jxr_linenumber" name="L247" href="#L247">247</a>
<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em class="jxr_javadoccomment"> * Returns the reports bundle</em>
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment"> * @param locale Requested locale of the bundle</em>
<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> * @return The bundle, which is used to read localized strings.</em>
<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <strong class="jxr_keyword">private</strong> ResourceBundle getBundle(Locale locale) {
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">return</strong> ResourceBundle.getBundle(<span class="jxr_string">"org/apache/rat/mp/rat-report"</span>, locale, getClass().getClassLoader());
<a class="jxr_linenumber" name="L256" href="#L256">256</a> }
<a class="jxr_linenumber" name="L257" href="#L257">257</a>
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> * Returns the reports description.</em>
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment"> * @param locale Requested locale of the bundle</em>
<a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_javadoccomment"> * @return Report description, as given by the key "report.rat.description" in the bundle.</em>
<a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L264" href="#L264">264</a> <strong class="jxr_keyword">public</strong> String getDescription(Locale locale) {
<a class="jxr_linenumber" name="L265" href="#L265">265</a> <strong class="jxr_keyword">return</strong> getBundle(locale).getString(<span class="jxr_string">"report.rat.description"</span>);
<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> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * Returns the reports name.</em>
<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> * @param locale Requested locale of the bundle</em>
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> * @return Report name, as given by the key "report.rat.name" in the bundle.</em>
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">public</strong> String getName(Locale locale) {
<a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">return</strong> getBundle(locale).getString(<span class="jxr_string">"report.rat.name"</span>);
<a class="jxr_linenumber" name="L276" href="#L276">276</a> }
<a class="jxr_linenumber" name="L277" href="#L277">277</a>
<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em class="jxr_javadoccomment"> * Returns the reports file name.</em>
<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_javadoccomment"> * @return "rat-report"</em>
<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <strong class="jxr_keyword">public</strong> String getOutputName() {
<a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"rat-report"</span>;
<a class="jxr_linenumber" name="L285" href="#L285">285</a> }
<a class="jxr_linenumber" name="L286" href="#L286">286</a>
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> * Returns the reports output directory.</em>
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> * @return Value of the "outputDirectory" parameter.</em>
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong class="jxr_keyword">public</strong> File getReportOutputDirectory() {
<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">return</strong> outputDirectory;
<a class="jxr_linenumber" name="L294" href="#L294">294</a> }
<a class="jxr_linenumber" name="L295" href="#L295">295</a>
<a class="jxr_linenumber" name="L296" href="#L296">296</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L297" href="#L297">297</a> <em class="jxr_javadoccomment"> * Returns, whether this is an external report.</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> <em class="jxr_javadoccomment"> * @return Always false.</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isExternalReport() {
<a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L303" href="#L303">303</a> }
<a class="jxr_linenumber" name="L304" href="#L304">304</a>
<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> <em class="jxr_javadoccomment"> * Sets the reports output directory.</em>
<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment"> * @param pOutputDirectory Reports target directory.</em>
<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setReportOutputDirectory(File pOutputDirectory) {
<a class="jxr_linenumber" name="L311" href="#L311">311</a> outputDirectory = pOutputDirectory;
<a class="jxr_linenumber" name="L312" href="#L312">312</a> }
<a class="jxr_linenumber" name="L313" href="#L313">313</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2007&#x2013;2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>