You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2012/05/08 14:09:45 UTC
svn commit: r816568 [36/49] - in
/websites/production/maventest/content/plugins/maven-site-plugin-latest: ./
apidocs/ apidocs/org/apache/maven/plugins/site/
apidocs/org/apache/maven/plugins/site/class-use/
apidocs/org/apache/maven/plugins/site/wagon/ a...
Propchange: websites/production/maventest/content/plugins/maven-site-plugin-latest/xref/org/apache/maven/plugins/site/AbstractDeployMojo.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/maventest/content/plugins/maven-site-plugin-latest/xref/org/apache/maven/plugins/site/AbstractDeployMojo.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Modified: websites/production/maventest/content/plugins/maven-site-plugin-latest/xref/org/apache/maven/plugins/site/AbstractSiteMojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-site-plugin-latest/xref/org/apache/maven/plugins/site/AbstractSiteMojo.html (original)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/xref/org/apache/maven/plugins/site/AbstractSiteMojo.html Tue May 8 12:09:38 2012
@@ -1,224 +1,181 @@
<!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=ISO-8859-1" />
+<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>AbstractSiteMojo xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/site/AbstractSiteMojo.html">View Javadoc</a></div><pre>
-<a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.site;
-<a name="2" href="#2">2</a>
-<a name="3" href="#3">3</a> <em class="jxr_comment">/*</em>
-<a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
-<a name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
-<a name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
-<a name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
-<a name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
-<a name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
-<a name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
-<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
-<a name="12" href="#12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
-<a name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
-<a name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
-<a name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
-<a name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
-<a name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
-<a name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
-<a name="19" href="#19">19</a> <em class="jxr_comment"> * under the License.</em>
-<a name="20" href="#20">20</a> <em class="jxr_comment"> */</em>
-<a name="21" href="#21">21</a>
-<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.File;
-<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.Iterator;
-<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.List;
-<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
-<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.Map;
-<a name="27" href="#27">27</a>
-<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.repository.ArtifactRepository;
-<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.DecorationModel;
-<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.Menu;
-<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.MenuItem;
-<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.tools.SiteTool;
-<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo;
-<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
-<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReport;
-<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.i18n.I18N;
-<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory;
-<a name="38" href="#38">38</a>
-<a name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em>
-<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * Base class for site mojos.</em>
-<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> *</em>
-<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:brett@apache.org" target="alexandria_uri">mailto:brett@apache.org</a>">Brett Porter</a></em>
-<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> */</em>
-<a name="44" href="#44">44</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/site/AbstractSiteMojo.html">AbstractSiteMojo</a>
-<a name="45" href="#45">45</a> <strong class="jxr_keyword">extends</strong> AbstractMojo
-<a name="46" href="#46">46</a> {
-<a name="47" href="#47">47</a>
-<a name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em>
-<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * @parameter</em>
-<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * @since 3.0-beta-1</em>
-<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> */</em>
-<a name="52" href="#52">52</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/maven/plugins/site/ReportPlugin.html">ReportPlugin</a>[] reportPlugins;
-<a name="53" href="#53">53</a>
-<a name="54" href="#54">54</a> <em class="jxr_javadoccomment">/**</em>
-<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * A comma separated list of locales supported by Maven. The first valid token will be the default Locale</em>
-<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * for this instance of the Java Virtual Machine.</em>
-<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> *</em>
-<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * @parameter expression="${locales}"</em>
-<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> */</em>
-<a name="60" href="#60">60</a> <strong class="jxr_keyword">protected</strong> String locales;
-<a name="61" href="#61">61</a>
-<a name="62" href="#62">62</a> <em class="jxr_javadoccomment">/**</em>
-<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * SiteTool.</em>
-<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> *</em>
-<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * @component</em>
-<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> */</em>
-<a name="67" href="#67">67</a> <strong class="jxr_keyword">protected</strong> SiteTool siteTool;
-<a name="68" href="#68">68</a>
-<a name="69" href="#69">69</a> <em class="jxr_javadoccomment">/**</em>
-<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * Internationalization.</em>
-<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> *</em>
-<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @component</em>
-<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> */</em>
-<a name="74" href="#74">74</a> <strong class="jxr_keyword">protected</strong> I18N i18n;
-<a name="75" href="#75">75</a>
-<a name="76" href="#76">76</a> <em class="jxr_javadoccomment">/**</em>
-<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * Directory containing the site.xml file and the source for apt, fml and xdoc docs.</em>
-<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> *</em>
-<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * @parameter default-value="${basedir}/src/site"</em>
-<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> */</em>
-<a name="81" href="#81">81</a> <strong class="jxr_keyword">protected</strong> File siteDirectory;
-<a name="82" href="#82">82</a>
-<a name="83" href="#83">83</a> <em class="jxr_javadoccomment">/**</em>
-<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * The maven project.</em>
-<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> *</em>
-<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * @parameter default-value="${project}"</em>
-<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * @required</em>
-<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * @readonly</em>
-<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> */</em>
-<a name="90" href="#90">90</a> <strong class="jxr_keyword">protected</strong> MavenProject project;
-<a name="91" href="#91">91</a>
-<a name="92" href="#92">92</a> <em class="jxr_javadoccomment">/**</em>
-<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * The local repository.</em>
-<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> *</em>
-<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * @parameter default-value="${localRepository}"</em>
-<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> */</em>
-<a name="97" href="#97">97</a> <strong class="jxr_keyword">protected</strong> ArtifactRepository localRepository;
-<a name="98" href="#98">98</a>
-<a name="99" href="#99">99</a> <em class="jxr_javadoccomment">/**</em>
-<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * The reactor projects.</em>
-<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> *</em>
-<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * @parameter default-value="${reactorProjects}"</em>
-<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * @required</em>
-<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * @readonly</em>
-<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> */</em>
-<a name="106" href="#106">106</a> <strong class="jxr_keyword">protected</strong> List<MavenProject> reactorProjects;
-<a name="107" href="#107">107</a>
-<a name="108" href="#108">108</a> <em class="jxr_javadoccomment">/**</em>
-<a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * Specifies the input encoding.</em>
-<a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> *</em>
-<a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * @parameter expression="${encoding}" default-value="${project.build.sourceEncoding}"</em>
-<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> */</em>
-<a name="113" href="#113">113</a> <strong class="jxr_keyword">private</strong> String inputEncoding;
-<a name="114" href="#114">114</a>
-<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">/**</em>
-<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * Specifies the output encoding.</em>
-<a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> *</em>
-<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * @parameter expression="${outputEncoding}" default-value="${project.reporting.outputEncoding}"</em>
-<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> */</em>
-<a name="120" href="#120">120</a> <strong class="jxr_keyword">private</strong> String outputEncoding;
-<a name="121" href="#121">121</a>
-<a name="122" href="#122">122</a> <em class="jxr_javadoccomment">/**</em>
-<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * Gets the input files encoding.</em>
-<a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> *</em>
-<a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * @return The input files encoding, never <code>null</code>.</em>
-<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> */</em>
-<a name="127" href="#127">127</a> <strong class="jxr_keyword">protected</strong> String getInputEncoding()
-<a name="128" href="#128">128</a> {
-<a name="129" href="#129">129</a> <strong class="jxr_keyword">return</strong> ( inputEncoding == <strong class="jxr_keyword">null</strong> ) ? ReaderFactory.ISO_8859_1 : inputEncoding;
-<a name="130" href="#130">130</a> }
-<a name="131" href="#131">131</a>
-<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">/**</em>
-<a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * Gets the effective reporting output files encoding.</em>
-<a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> *</em>
-<a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * @return The effective reporting output file encoding, never <code>null</code>.</em>
-<a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> */</em>
-<a name="137" href="#137">137</a> <strong class="jxr_keyword">protected</strong> String getOutputEncoding()
-<a name="138" href="#138">138</a> {
-<a name="139" href="#139">139</a> <strong class="jxr_keyword">return</strong> ( outputEncoding == <strong class="jxr_keyword">null</strong> ) ? ReaderFactory.UTF_8 : outputEncoding;
-<a name="140" href="#140">140</a> }
-<a name="141" href="#141">141</a>
-<a name="142" href="#142">142</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> populateReportItems( DecorationModel decorationModel, Locale locale,
-<a name="143" href="#143">143</a> Map<String, MavenReport> reportsByOutputName )
-<a name="144" href="#144">144</a> {
-<a name="145" href="#145">145</a> <strong class="jxr_keyword">for</strong> ( Iterator<Menu> i = decorationModel.getMenus().iterator(); i.hasNext(); )
-<a name="146" href="#146">146</a> {
-<a name="147" href="#147">147</a> Menu menu = i.next();
-<a name="148" href="#148">148</a>
-<a name="149" href="#149">149</a> populateItemRefs( menu.getItems(), locale, reportsByOutputName );
-<a name="150" href="#150">150</a> }
-<a name="151" href="#151">151</a> }
-<a name="152" href="#152">152</a>
-<a name="153" href="#153">153</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> populateItemRefs( List<MenuItem> items, Locale locale, Map<String, MavenReport> reportsByOutputName )
-<a name="154" href="#154">154</a> {
-<a name="155" href="#155">155</a> <strong class="jxr_keyword">for</strong> ( Iterator<MenuItem> i = items.iterator(); i.hasNext(); )
-<a name="156" href="#156">156</a> {
-<a name="157" href="#157">157</a> MenuItem item = i.next();
-<a name="158" href="#158">158</a>
-<a name="159" href="#159">159</a> <strong class="jxr_keyword">if</strong> ( item.getRef() != <strong class="jxr_keyword">null</strong> )
-<a name="160" href="#160">160</a> {
-<a name="161" href="#161">161</a> MavenReport report = reportsByOutputName.get( item.getRef() );
-<a name="162" href="#162">162</a>
-<a name="163" href="#163">163</a> <strong class="jxr_keyword">if</strong> ( report != <strong class="jxr_keyword">null</strong> )
-<a name="164" href="#164">164</a> {
-<a name="165" href="#165">165</a>
-<a name="166" href="#166">166</a> <strong class="jxr_keyword">if</strong> ( item.getName() == <strong class="jxr_keyword">null</strong> )
-<a name="167" href="#167">167</a> {
-<a name="168" href="#168">168</a> item.setName( report.getName( locale ) );
-<a name="169" href="#169">169</a> }
-<a name="170" href="#170">170</a>
-<a name="171" href="#171">171</a> <strong class="jxr_keyword">if</strong> ( item.getHref() == <strong class="jxr_keyword">null</strong> || item.getHref().length() == 0 )
-<a name="172" href="#172">172</a> {
-<a name="173" href="#173">173</a> item.setHref( report.getOutputName() + <span class="jxr_string">".html"</span> );
-<a name="174" href="#174">174</a> }
-<a name="175" href="#175">175</a> }
-<a name="176" href="#176">176</a> <strong class="jxr_keyword">else</strong>
-<a name="177" href="#177">177</a> {
-<a name="178" href="#178">178</a> getLog().warn( <span class="jxr_string">"Unrecognised reference: '"</span> + item.getRef() + <span class="jxr_string">"'"</span> );
-<a name="179" href="#179">179</a> i.remove();
-<a name="180" href="#180">180</a> }
-<a name="181" href="#181">181</a> }
-<a name="182" href="#182">182</a> populateItemRefs( item.getItems(), locale, reportsByOutputName );
-<a name="183" href="#183">183</a> }
-<a name="184" href="#184">184</a> }
-<a name="185" href="#185">185</a>
-<a name="186" href="#186">186</a> <em class="jxr_javadoccomment">/**</em>
-<a name="187" href="#187">187</a> <em class="jxr_javadoccomment"> * TODO should be removed see PLXUTILS-61</em>
-<a name="188" href="#188">188</a> <em class="jxr_javadoccomment"> *</em>
-<a name="189" href="#189">189</a> <em class="jxr_javadoccomment"> * @param basedir</em>
-<a name="190" href="#190">190</a> <em class="jxr_javadoccomment"> * @param absolutePath</em>
-<a name="191" href="#191">191</a> <em class="jxr_javadoccomment"> * @return</em>
-<a name="192" href="#192">192</a> <em class="jxr_javadoccomment"> */</em>
-<a name="193" href="#193">193</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> String toRelative( File basedir, String absolutePath )
-<a name="194" href="#194">194</a> {
-<a name="195" href="#195">195</a> String relative;
-<a name="196" href="#196">196</a>
-<a name="197" href="#197">197</a> absolutePath = absolutePath.replace( '\\', '/' );
-<a name="198" href="#198">198</a> String basedirPath = basedir.getAbsolutePath().replace( '\\', '/' );
-<a name="199" href="#199">199</a>
-<a name="200" href="#200">200</a> <strong class="jxr_keyword">if</strong> ( absolutePath.startsWith( basedirPath ) )
-<a name="201" href="#201">201</a> {
-<a name="202" href="#202">202</a> relative = absolutePath.substring( basedirPath.length() + 1 );
-<a name="203" href="#203">203</a> }
-<a name="204" href="#204">204</a> <strong class="jxr_keyword">else</strong>
-<a name="205" href="#205">205</a> {
-<a name="206" href="#206">206</a> relative = absolutePath;
-<a name="207" href="#207">207</a> }
-<a name="208" href="#208">208</a>
-<a name="209" href="#209">209</a> <strong class="jxr_keyword">return</strong> relative;
-<a name="210" href="#210">210</a> }
-<a name="211" href="#211">211</a> }
+<a class="jxr_linenumber" name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.site;
+<a class="jxr_linenumber" name="2" href="#2">2</a>
+<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
+<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
+<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
+<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
+<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
+<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
+<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
+<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
+<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
+<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
+<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
+<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
+<a class="jxr_linenumber" name="19" href="#19">19</a> <em class="jxr_comment"> * under the License.</em>
+<a class="jxr_linenumber" name="20" href="#20">20</a> <em class="jxr_comment"> */</em>
+<a class="jxr_linenumber" name="21" href="#21">21</a>
+<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.File;
+<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
+<a class="jxr_linenumber" name="25" href="#25">25</a>
+<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.List;
+<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.Properties;
+<a class="jxr_linenumber" name="28" href="#28">28</a>
+<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.repository.ArtifactRepository;
+<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.versioning.ComparableVersion;
+<a class="jxr_linenumber" name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.tools.SiteTool;
+<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo;
+<a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
+<a class="jxr_linenumber" name="34" href="#34">34</a>
+<a class="jxr_linenumber" name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.i18n.I18N;
+<a class="jxr_linenumber" name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.IOUtil;
+<a class="jxr_linenumber" name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory;
+<a class="jxr_linenumber" name="38" href="#38">38</a>
+<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * Base class for site mojos.</em>
+<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:brett@apache.org" target="alexandria_uri">mailto:brett@apache.org</a>">Brett Porter</a></em>
+<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="44" href="#44">44</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/site/AbstractSiteMojo.html">AbstractSiteMojo</a>
+<a class="jxr_linenumber" name="45" href="#45">45</a> <strong class="jxr_keyword">extends</strong> AbstractMojo
+<a class="jxr_linenumber" name="46" href="#46">46</a> {
+<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * A comma separated list of locales supported by Maven. The first valid token will be the default Locale</em>
+<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * for this instance of the Java Virtual Machine.</em>
+<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * @parameter expression="${locales}"</em>
+<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="53" href="#53">53</a> <strong class="jxr_keyword">protected</strong> String locales;
+<a class="jxr_linenumber" name="54" href="#54">54</a>
+<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * SiteTool.</em>
+<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * @component</em>
+<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="60" href="#60">60</a> <strong class="jxr_keyword">protected</strong> SiteTool siteTool;
+<a class="jxr_linenumber" name="61" href="#61">61</a>
+<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * Internationalization.</em>
+<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * @component</em>
+<a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="67" href="#67">67</a> <strong class="jxr_keyword">protected</strong> I18N i18n;
+<a class="jxr_linenumber" name="68" href="#68">68</a>
+<a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * Directory containing the site.xml file and the source for apt, fml and xdoc docs.</em>
+<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @parameter default-value="${basedir}/src/site"</em>
+<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="74" href="#74">74</a> <strong class="jxr_keyword">protected</strong> File siteDirectory;
+<a class="jxr_linenumber" name="75" href="#75">75</a>
+<a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * The maven project.</em>
+<a class="jxr_linenumber" name="78" href="#78">78</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * @parameter default-value="${project}"</em>
+<a class="jxr_linenumber" name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * @required</em>
+<a class="jxr_linenumber" name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * @readonly</em>
+<a class="jxr_linenumber" name="82" href="#82">82</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="83" href="#83">83</a> <strong class="jxr_keyword">protected</strong> MavenProject project;
+<a class="jxr_linenumber" name="84" href="#84">84</a>
+<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * The local repository.</em>
+<a class="jxr_linenumber" name="87" href="#87">87</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * @parameter default-value="${localRepository}"</em>
+<a class="jxr_linenumber" name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * @readonly</em>
+<a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="91" href="#91">91</a> <strong class="jxr_keyword">protected</strong> ArtifactRepository localRepository;
+<a class="jxr_linenumber" name="92" href="#92">92</a>
+<a class="jxr_linenumber" name="93" href="#93">93</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * The reactor projects.</em>
+<a class="jxr_linenumber" name="95" href="#95">95</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * @parameter default-value="${reactorProjects}"</em>
+<a class="jxr_linenumber" name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * @required</em>
+<a class="jxr_linenumber" name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * @readonly</em>
+<a class="jxr_linenumber" name="99" href="#99">99</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="100" href="#100">100</a> <strong class="jxr_keyword">protected</strong> List<MavenProject> reactorProjects;
+<a class="jxr_linenumber" name="101" href="#101">101</a>
+<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * Specifies the input encoding.</em>
+<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * @parameter expression="${encoding}" default-value="${project.build.sourceEncoding}"</em>
+<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="107" href="#107">107</a> <strong class="jxr_keyword">private</strong> String inputEncoding;
+<a class="jxr_linenumber" name="108" href="#108">108</a>
+<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * Specifies the output encoding.</em>
+<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * @parameter expression="${outputEncoding}" default-value="${project.reporting.outputEncoding}"</em>
+<a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="114" href="#114">114</a> <strong class="jxr_keyword">private</strong> String outputEncoding;
+<a class="jxr_linenumber" name="115" href="#115">115</a>
+<a class="jxr_linenumber" name="116" href="#116">116</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * Gets the input files encoding.</em>
+<a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * @return The input files encoding, never <code>null</code>.</em>
+<a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="121" href="#121">121</a> <strong class="jxr_keyword">protected</strong> String getInputEncoding()
+<a class="jxr_linenumber" name="122" href="#122">122</a> {
+<a class="jxr_linenumber" name="123" href="#123">123</a> <strong class="jxr_keyword">return</strong> ( inputEncoding == <strong class="jxr_keyword">null</strong> ) ? ReaderFactory.ISO_8859_1 : inputEncoding;
+<a class="jxr_linenumber" name="124" href="#124">124</a> }
+<a class="jxr_linenumber" name="125" href="#125">125</a>
+<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * Gets the effective reporting output files encoding.</em>
+<a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * @return The effective reporting output file encoding, never <code>null</code>.</em>
+<a class="jxr_linenumber" name="130" href="#130">130</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="131" href="#131">131</a> <strong class="jxr_keyword">protected</strong> String getOutputEncoding()
+<a class="jxr_linenumber" name="132" href="#132">132</a> {
+<a class="jxr_linenumber" name="133" href="#133">133</a> <strong class="jxr_keyword">return</strong> ( outputEncoding == <strong class="jxr_keyword">null</strong> ) ? ReaderFactory.UTF_8 : outputEncoding;
+<a class="jxr_linenumber" name="134" href="#134">134</a> }
+<a class="jxr_linenumber" name="135" href="#135">135</a>
+<a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * Check the current Maven version to see if it's Maven 3.0 or newer.</em>
+<a class="jxr_linenumber" name="138" href="#138">138</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="139" href="#139">139</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isMaven3OrMore()
+<a class="jxr_linenumber" name="140" href="#140">140</a> {
+<a class="jxr_linenumber" name="141" href="#141">141</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> ComparableVersion( getMavenVersion() ).compareTo( <strong class="jxr_keyword">new</strong> ComparableVersion( <span class="jxr_string">"3.0"</span> ) ) >= 0;
+<a class="jxr_linenumber" name="142" href="#142">142</a> }
+<a class="jxr_linenumber" name="143" href="#143">143</a>
+<a class="jxr_linenumber" name="144" href="#144">144</a> <strong class="jxr_keyword">protected</strong> String getMavenVersion()
+<a class="jxr_linenumber" name="145" href="#145">145</a> {
+<a class="jxr_linenumber" name="146" href="#146">146</a> <em class="jxr_comment">// This relies on the fact that MavenProject is the in core classloader</em>
+<a class="jxr_linenumber" name="147" href="#147">147</a> <em class="jxr_comment">// and that the core classloader is for the maven-core artifact</em>
+<a class="jxr_linenumber" name="148" href="#148">148</a> <em class="jxr_comment">// and that should have a pom.properties file</em>
+<a class="jxr_linenumber" name="149" href="#149">149</a> <em class="jxr_comment">// if this ever changes, we will have to revisit this code.</em>
+<a class="jxr_linenumber" name="150" href="#150">150</a> <strong class="jxr_keyword">final</strong> Properties properties = <strong class="jxr_keyword">new</strong> Properties();
+<a class="jxr_linenumber" name="151" href="#151">151</a> <strong class="jxr_keyword">final</strong> InputStream in =
+<a class="jxr_linenumber" name="152" href="#152">152</a> MavenProject.<strong class="jxr_keyword">class</strong>.getClassLoader().getResourceAsStream( <span class="jxr_string">"META-INF/maven/org.apache.maven/maven-core/pom.properties"</span> );
+<a class="jxr_linenumber" name="153" href="#153">153</a> <strong class="jxr_keyword">try</strong>
+<a class="jxr_linenumber" name="154" href="#154">154</a> {
+<a class="jxr_linenumber" name="155" href="#155">155</a> properties.load( in );
+<a class="jxr_linenumber" name="156" href="#156">156</a> }
+<a class="jxr_linenumber" name="157" href="#157">157</a> <strong class="jxr_keyword">catch</strong> ( IOException ioe )
+<a class="jxr_linenumber" name="158" href="#158">158</a> {
+<a class="jxr_linenumber" name="159" href="#159">159</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">""</span>;
+<a class="jxr_linenumber" name="160" href="#160">160</a> }
+<a class="jxr_linenumber" name="161" href="#161">161</a> <strong class="jxr_keyword">finally</strong>
+<a class="jxr_linenumber" name="162" href="#162">162</a> {
+<a class="jxr_linenumber" name="163" href="#163">163</a> IOUtil.close( in );
+<a class="jxr_linenumber" name="164" href="#164">164</a> }
+<a class="jxr_linenumber" name="165" href="#165">165</a>
+<a class="jxr_linenumber" name="166" href="#166">166</a> <strong class="jxr_keyword">return</strong> properties.getProperty( <span class="jxr_string">"version"</span> ).trim();
+<a class="jxr_linenumber" name="167" href="#167">167</a> }
+<a class="jxr_linenumber" name="168" href="#168">168</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>