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 [42/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...
Modified: websites/production/maventest/content/plugins/maven-site-plugin-latest/xref/org/apache/maven/plugins/site/SiteDescriptorAttachMojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-site-plugin-latest/xref/org/apache/maven/plugins/site/SiteDescriptorAttachMojo.html (original)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/xref/org/apache/maven/plugins/site/SiteDescriptorAttachMojo.html Tue May 8 12:09:38 2012
@@ -1,186 +1,136 @@
<!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>SiteDescriptorAttachMojo xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/site/SiteDescriptorAttachMojo.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.io.IOException;
-<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.StringReader;
-<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.io.Writer;
-<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.HashMap;
-<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.List;
-<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
-<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.util.Map;
-<a name="30" href="#30">30</a>
-<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.commons.io.IOUtils;
-<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.DecorationModel;
-<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Reader;
-<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.site.decoration.io.xpp3.DecorationXpp3Writer;
-<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.apache.maven.doxia.tools.SiteToolException;
-<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
-<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
-<a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProjectHelper;
-<a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.IOUtil;
-<a name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory;
-<a name="41" href="#41">41</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.WriterFactory;
-<a name="42" href="#42">42</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.XmlStreamReader;
-<a name="43" href="#43">43</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.xml.pull.XmlPullParserException;
-<a name="44" href="#44">44</a>
-<a name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em>
-<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Adds the site descriptor (<code>site.xml</code>) to the list of files to be installed/deployed.</em>
-<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> *</em>
-<a name="48" href="#48">48</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="49" href="#49">49</a> <em class="jxr_javadoccomment"> * @version $Id$</em>
-<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * @goal attach-descriptor</em>
-<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * @phase package</em>
-<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em>
-<a name="53" href="#53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/site/SiteDescriptorAttachMojo.html">SiteDescriptorAttachMojo</a>
-<a name="54" href="#54">54</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugins/site/AbstractSiteMojo.html">AbstractSiteMojo</a>
-<a name="55" href="#55">55</a> {
-<a name="56" href="#56">56</a>
-<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="${basedir}"</em>
-<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * @required</em>
-<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * @readonly</em>
-<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> */</em>
-<a name="62" href="#62">62</a> <strong class="jxr_keyword">private</strong> File basedir;
-<a name="63" href="#63">63</a>
-<a name="64" href="#64">64</a> <em class="jxr_javadoccomment">/**</em>
-<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * Maven ProjectHelper.</em>
-<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> *</em>
-<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @component</em>
-<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * @readonly</em>
-<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * @since 2.1.1</em>
-<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> */</em>
-<a name="71" href="#71">71</a> <strong class="jxr_keyword">private</strong> MavenProjectHelper projectHelper;
-<a name="72" href="#72">72</a>
-<a name="73" href="#73">73</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute()
-<a name="74" href="#74">74</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
-<a name="75" href="#75">75</a> {
-<a name="76" href="#76">76</a> List<Locale> localesList = siteTool.getAvailableLocales( locales );
-<a name="77" href="#77">77</a>
-<a name="78" href="#78">78</a> <strong class="jxr_keyword">for</strong> ( Locale locale : localesList )
-<a name="79" href="#79">79</a> {
-<a name="80" href="#80">80</a> File descriptorFile = siteTool.getSiteDescriptorFromBasedir( toRelative( project.getBasedir(),
-<a name="81" href="#81">81</a> siteDirectory.getAbsolutePath() ),
-<a name="82" href="#82">82</a> basedir, locale );
-<a name="83" href="#83">83</a>
-<a name="84" href="#84">84</a> <strong class="jxr_keyword">if</strong> ( descriptorFile.exists() )
-<a name="85" href="#85">85</a> {
-<a name="86" href="#86">86</a> Map<String, String> props = <strong class="jxr_keyword">new</strong> HashMap<String, String>();
-<a name="87" href="#87">87</a> props.put( <span class="jxr_string">"reports"</span>, <span class="jxr_string">"<menu ref=\"reports\"/>"</span> );
-<a name="88" href="#88">88</a> props.put( <span class="jxr_string">"modules"</span>, <span class="jxr_string">"<menu ref=\"modules\"/>"</span> );
-<a name="89" href="#89">89</a>
-<a name="90" href="#90">90</a> DecorationModel decoration;
-<a name="91" href="#91">91</a> XmlStreamReader reader = <strong class="jxr_keyword">null</strong>;
-<a name="92" href="#92">92</a> <strong class="jxr_keyword">try</strong>
-<a name="93" href="#93">93</a> {
-<a name="94" href="#94">94</a> reader = ReaderFactory.newXmlReader( descriptorFile );
-<a name="95" href="#95">95</a> String siteDescriptorContent = IOUtil.toString( reader );
-<a name="96" href="#96">96</a>
-<a name="97" href="#97">97</a> siteDescriptorContent =
-<a name="98" href="#98">98</a> siteTool.getInterpolatedSiteDescriptorContent( props, project, siteDescriptorContent,
-<a name="99" href="#99">99</a> getInputEncoding(), getOutputEncoding() );
-<a name="100" href="#100">100</a>
-<a name="101" href="#101">101</a> decoration = <strong class="jxr_keyword">new</strong> DecorationXpp3Reader().read( <strong class="jxr_keyword">new</strong> StringReader( siteDescriptorContent ) );
-<a name="102" href="#102">102</a> }
-<a name="103" href="#103">103</a> <strong class="jxr_keyword">catch</strong> ( XmlPullParserException e )
-<a name="104" href="#104">104</a> {
-<a name="105" href="#105">105</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Error parsing site descriptor"</span>, e );
-<a name="106" href="#106">106</a> }
-<a name="107" href="#107">107</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
-<a name="108" href="#108">108</a> {
-<a name="109" href="#109">109</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Error reading site descriptor"</span>, e );
-<a name="110" href="#110">110</a> }
-<a name="111" href="#111">111</a> <strong class="jxr_keyword">catch</strong> ( SiteToolException e )
-<a name="112" href="#112">112</a> {
-<a name="113" href="#113">113</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Error when interpolating site descriptor"</span>, e );
-<a name="114" href="#114">114</a> }
-<a name="115" href="#115">115</a> <strong class="jxr_keyword">finally</strong>
-<a name="116" href="#116">116</a> {
-<a name="117" href="#117">117</a> IOUtils.closeQuietly( reader );
-<a name="118" href="#118">118</a> }
-<a name="119" href="#119">119</a>
-<a name="120" href="#120">120</a> MavenProject parentProject = siteTool.getParentProject( project, reactorProjects, localRepository );
-<a name="121" href="#121">121</a> <strong class="jxr_keyword">if</strong> ( parentProject != <strong class="jxr_keyword">null</strong> && project.getUrl() != <strong class="jxr_keyword">null</strong> && parentProject.getUrl() != <strong class="jxr_keyword">null</strong> )
-<a name="122" href="#122">122</a> {
-<a name="123" href="#123">123</a> siteTool.populateParentMenu( decoration, locale, project, parentProject, <strong class="jxr_keyword">true</strong> );
-<a name="124" href="#124">124</a> }
-<a name="125" href="#125">125</a> <strong class="jxr_keyword">try</strong>
-<a name="126" href="#126">126</a> {
-<a name="127" href="#127">127</a> siteTool.populateModulesMenu( project, reactorProjects, localRepository, decoration, locale, <strong class="jxr_keyword">true</strong> );
-<a name="128" href="#128">128</a> }
-<a name="129" href="#129">129</a> <strong class="jxr_keyword">catch</strong> ( SiteToolException e )
-<a name="130" href="#130">130</a> {
-<a name="131" href="#131">131</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Error when populating modules"</span>, e );
-<a name="132" href="#132">132</a> }
-<a name="133" href="#133">133</a>
-<a name="134" href="#134">134</a> <em class="jxr_comment">// Calculate the classifier to use</em>
-<a name="135" href="#135">135</a> String classifier = <strong class="jxr_keyword">null</strong>;
-<a name="136" href="#136">136</a> <strong class="jxr_keyword">int</strong> index = descriptorFile.getName().lastIndexOf( '.' );
-<a name="137" href="#137">137</a> <strong class="jxr_keyword">if</strong> ( index > 0 )
-<a name="138" href="#138">138</a> {
-<a name="139" href="#139">139</a> classifier = descriptorFile.getName().substring( 0, index );
-<a name="140" href="#140">140</a> }
-<a name="141" href="#141">141</a> <strong class="jxr_keyword">else</strong>
-<a name="142" href="#142">142</a> {
-<a name="143" href="#143">143</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Unable to determine the classifier to use"</span> );
-<a name="144" href="#144">144</a> }
-<a name="145" href="#145">145</a>
-<a name="146" href="#146">146</a> <em class="jxr_comment">// Prepare a file for the interpolated site descriptor</em>
-<a name="147" href="#147">147</a> String filename = project.getArtifactId() + <span class="jxr_string">"-"</span> + project.getVersion() + <span class="jxr_string">"-"</span> + descriptorFile.getName();
-<a name="148" href="#148">148</a> File interpolatedDescriptorFile = <strong class="jxr_keyword">new</strong> File( project.getBuild().getDirectory(), filename );
-<a name="149" href="#149">149</a> interpolatedDescriptorFile.getParentFile().mkdirs();
-<a name="150" href="#150">150</a>
-<a name="151" href="#151">151</a> Writer writer = <strong class="jxr_keyword">null</strong>;
-<a name="152" href="#152">152</a> <strong class="jxr_keyword">try</strong>
-<a name="153" href="#153">153</a> {
-<a name="154" href="#154">154</a> <em class="jxr_comment">// Write the interpolated site descriptor to a file</em>
-<a name="155" href="#155">155</a> writer = WriterFactory.newXmlWriter( interpolatedDescriptorFile );
-<a name="156" href="#156">156</a> <strong class="jxr_keyword">new</strong> DecorationXpp3Writer().write( writer, decoration );
-<a name="157" href="#157">157</a> <em class="jxr_comment">// Attach the interpolated site descriptor</em>
-<a name="158" href="#158">158</a> getLog().debug( <span class="jxr_string">"Attaching the site descriptor '"</span> + interpolatedDescriptorFile.getAbsolutePath()
-<a name="159" href="#159">159</a> + <span class="jxr_string">"' with classifier '"</span> + classifier + <span class="jxr_string">"' to the project."</span> );
-<a name="160" href="#160">160</a> projectHelper.attachArtifact( project, <span class="jxr_string">"xml"</span>, classifier, interpolatedDescriptorFile );
-<a name="161" href="#161">161</a> }
-<a name="162" href="#162">162</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
-<a name="163" href="#163">163</a> {
-<a name="164" href="#164">164</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Unable to store interpolated site descriptor"</span>, e );
-<a name="165" href="#165">165</a> }
-<a name="166" href="#166">166</a> <strong class="jxr_keyword">finally</strong>
-<a name="167" href="#167">167</a> {
-<a name="168" href="#168">168</a> IOUtils.closeQuietly( writer );
-<a name="169" href="#169">169</a> }
-<a name="170" href="#170">170</a> }
-<a name="171" href="#171">171</a> }
-<a name="172" href="#172">172</a> }
-<a name="173" href="#173">173</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>
+<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.List;
+<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
+<a class="jxr_linenumber" name="27" href="#27">27</a>
+<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
+<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProjectHelper;
+<a class="jxr_linenumber" name="30" href="#30">30</a>
+<a class="jxr_linenumber" name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.FileUtils;
+<a class="jxr_linenumber" name="32" href="#32">32</a>
+<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * Adds the site descriptor (<code>site.xml</code>) to the list of files to be installed/deployed.</em>
+<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * By default, this is enabled only when the project has pom packaging since it will be used by modules inheriting,</em>
+<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * but this can be enabled for other projects packaging if needed.</em>
+<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="38" href="#38">38</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="39" href="#39">39</a> <em class="jxr_javadoccomment"> * @version $Id$</em>
+<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @goal attach-descriptor</em>
+<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @phase package</em>
+<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="43" href="#43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/site/SiteDescriptorAttachMojo.html">SiteDescriptorAttachMojo</a>
+<a class="jxr_linenumber" name="44" href="#44">44</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugins/site/AbstractSiteMojo.html">AbstractSiteMojo</a>
+<a class="jxr_linenumber" name="45" href="#45">45</a> {
+<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @parameter expression="${basedir}"</em>
+<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * @required</em>
+<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * @readonly</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> <strong class="jxr_keyword">private</strong> File basedir;
+<a class="jxr_linenumber" name="52" href="#52">52</a>
+<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * Maven ProjectHelper.</em>
+<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"> * @component</em>
+<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * @readonly</em>
+<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * @since 2.1.1</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">private</strong> MavenProjectHelper projectHelper;
+<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"> * @parameter default-value="true"</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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> pomPackagingOnly;
+<a class="jxr_linenumber" name="66" href="#66">66</a>
+<a class="jxr_linenumber" name="67" href="#67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute()
+<a class="jxr_linenumber" name="68" href="#68">68</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
+<a class="jxr_linenumber" name="69" href="#69">69</a> {
+<a class="jxr_linenumber" name="70" href="#70">70</a> <strong class="jxr_keyword">if</strong> ( pomPackagingOnly && !<span class="jxr_string">"pom"</span>.equals( project.getPackaging() ) )
+<a class="jxr_linenumber" name="71" href="#71">71</a> {
+<a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_comment">// http://jira.codehaus.org/browse/MSITE-597</em>
+<a class="jxr_linenumber" name="73" href="#73">73</a> <strong class="jxr_keyword">return</strong>;
+<a class="jxr_linenumber" name="74" href="#74">74</a> }
+<a class="jxr_linenumber" name="75" href="#75">75</a>
+<a class="jxr_linenumber" name="76" href="#76">76</a> List<Locale> localesList = siteTool.getAvailableLocales( locales );
+<a class="jxr_linenumber" name="77" href="#77">77</a>
+<a class="jxr_linenumber" name="78" href="#78">78</a> <strong class="jxr_keyword">for</strong> ( Locale locale : localesList )
+<a class="jxr_linenumber" name="79" href="#79">79</a> {
+<a class="jxr_linenumber" name="80" href="#80">80</a> File descriptorFile = siteTool.getSiteDescriptorFromBasedir(
+<a class="jxr_linenumber" name="81" href="#81">81</a> siteTool.getRelativePath( siteDirectory.getAbsolutePath(), project.getBasedir().getAbsolutePath() ),
+<a class="jxr_linenumber" name="82" href="#82">82</a> basedir, locale );
+<a class="jxr_linenumber" name="83" href="#83">83</a>
+<a class="jxr_linenumber" name="84" href="#84">84</a> <strong class="jxr_keyword">if</strong> ( descriptorFile.exists() )
+<a class="jxr_linenumber" name="85" href="#85">85</a> {
+<a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_comment">// Calculate the classifier to use</em>
+<a class="jxr_linenumber" name="87" href="#87">87</a> String classifier = getClassifier( descriptorFile );
+<a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_comment">// Prepare a file for the interpolated site descriptor</em>
+<a class="jxr_linenumber" name="89" href="#89">89</a> String filename = project.getArtifactId() + <span class="jxr_string">"-"</span> + project.getVersion() + <span class="jxr_string">"-"</span> + descriptorFile.getName();
+<a class="jxr_linenumber" name="90" href="#90">90</a> File targetDescriptorFile = <strong class="jxr_keyword">new</strong> File( project.getBuild().getDirectory(), filename );
+<a class="jxr_linenumber" name="91" href="#91">91</a>
+<a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">try</strong>
+<a class="jxr_linenumber" name="93" href="#93">93</a> {
+<a class="jxr_linenumber" name="94" href="#94">94</a> <em class="jxr_comment">// Copy the site descriptor to a file</em>
+<a class="jxr_linenumber" name="95" href="#95">95</a> FileUtils.copyFile( descriptorFile, targetDescriptorFile );
+<a class="jxr_linenumber" name="96" href="#96">96</a> <em class="jxr_comment">// Attach the site descriptor</em>
+<a class="jxr_linenumber" name="97" href="#97">97</a> getLog().debug( <span class="jxr_string">"Attaching the site descriptor '"</span> + targetDescriptorFile.getAbsolutePath()
+<a class="jxr_linenumber" name="98" href="#98">98</a> + <span class="jxr_string">"' with classifier '"</span> + classifier + <span class="jxr_string">"' to the project."</span> );
+<a class="jxr_linenumber" name="99" href="#99">99</a> projectHelper.attachArtifact( project, <span class="jxr_string">"xml"</span>, classifier, targetDescriptorFile );
+<a class="jxr_linenumber" name="100" href="#100">100</a> }
+<a class="jxr_linenumber" name="101" href="#101">101</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
+<a class="jxr_linenumber" name="102" href="#102">102</a> {
+<a class="jxr_linenumber" name="103" href="#103">103</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Unable to copy site descriptor"</span>, e );
+<a class="jxr_linenumber" name="104" href="#104">104</a> }
+<a class="jxr_linenumber" name="105" href="#105">105</a> }
+<a class="jxr_linenumber" name="106" href="#106">106</a> }
+<a class="jxr_linenumber" name="107" href="#107">107</a> }
+<a class="jxr_linenumber" name="108" href="#108">108</a>
+<a class="jxr_linenumber" name="109" href="#109">109</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String getClassifier( <strong class="jxr_keyword">final</strong> File descriptorFile )
+<a class="jxr_linenumber" name="110" href="#110">110</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException
+<a class="jxr_linenumber" name="111" href="#111">111</a> {
+<a class="jxr_linenumber" name="112" href="#112">112</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> index = descriptorFile.getName().lastIndexOf( '.' );
+<a class="jxr_linenumber" name="113" href="#113">113</a>
+<a class="jxr_linenumber" name="114" href="#114">114</a> <strong class="jxr_keyword">if</strong> ( index > 0 )
+<a class="jxr_linenumber" name="115" href="#115">115</a> {
+<a class="jxr_linenumber" name="116" href="#116">116</a> <strong class="jxr_keyword">return</strong> descriptorFile.getName().substring( 0, index );
+<a class="jxr_linenumber" name="117" href="#117">117</a> }
+<a class="jxr_linenumber" name="118" href="#118">118</a> <strong class="jxr_keyword">else</strong>
+<a class="jxr_linenumber" name="119" href="#119">119</a> {
+<a class="jxr_linenumber" name="120" href="#120">120</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Unable to determine the classifier to use"</span> );
+<a class="jxr_linenumber" name="121" href="#121">121</a> }
+<a class="jxr_linenumber" name="122" href="#122">122</a> }
+<a class="jxr_linenumber" name="123" href="#123">123</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>
Modified: websites/production/maventest/content/plugins/maven-site-plugin-latest/xref/org/apache/maven/plugins/site/SiteJarMojo.html
==============================================================================
--- websites/production/maventest/content/plugins/maven-site-plugin-latest/xref/org/apache/maven/plugins/site/SiteJarMojo.html (original)
+++ websites/production/maventest/content/plugins/maven-site-plugin-latest/xref/org/apache/maven/plugins/site/SiteJarMojo.html Tue May 8 12:09:38 2012
@@ -1,158 +1,159 @@
<!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>SiteJarMojo xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/site/SiteJarMojo.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> org.apache.maven.plugin.MojoExecutionException;
-<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException;
-<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProjectHelper;
-<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.archiver.ArchiverException;
-<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.archiver.jar.JarArchiver;
-<a name="27" href="#27">27</a>
-<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.io.File;
-<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
-<a name="30" href="#30">30</a>
-<a name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em>
-<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * Bundles the site output into a JAR so that it can be deployed to a repository.</em>
-<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> *</em>
-<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:mbeerman@yahoo.com" target="alexandria_uri">mailto:mbeerman@yahoo.com</a>">Matthew Beermann</a></em>
-<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * @version $Id$</em>
-<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * @goal jar</em>
-<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * @phase package</em>
-<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * @since 2.0-beta-6</em>
-<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> */</em>
-<a name="40" href="#40">40</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/site/SiteJarMojo.html">SiteJarMojo</a>
-<a name="41" href="#41">41</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugins/site/SiteMojo.html">SiteMojo</a>
-<a name="42" href="#42">42</a> {
-<a name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em>
-<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * Specifies the directory where the generated jar file will be put.</em>
-<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> *</em>
-<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * @parameter expression="${project.build.directory}"</em>
-<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @required</em>
-<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> */</em>
-<a name="49" href="#49">49</a> <strong class="jxr_keyword">private</strong> String jarOutputDirectory;
-<a name="50" href="#50">50</a>
-<a name="51" href="#51">51</a> <em class="jxr_javadoccomment">/**</em>
-<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * Specifies the filename that will be used for the generated jar file.</em>
-<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * Please note that "-site" will be appended to the file name.</em>
-<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> *</em>
-<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * @parameter expression="${project.build.finalName}"</em>
-<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * @required</em>
-<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em>
-<a name="58" href="#58">58</a> <strong class="jxr_keyword">private</strong> String finalName;
-<a name="59" href="#59">59</a>
-<a name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em>
-<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * Used for attaching the artifact in the project.</em>
-<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> *</em>
-<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * @component</em>
-<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> */</em>
-<a name="65" href="#65">65</a> <strong class="jxr_keyword">private</strong> MavenProjectHelper projectHelper;
-<a name="66" href="#66">66</a>
-<a name="67" href="#67">67</a> <em class="jxr_javadoccomment">/**</em>
-<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * Specifies whether to attach the generated artifact to the project.</em>
-<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> *</em>
-<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * @parameter expression="${site.attach}" default-value="true"</em>
-<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> */</em>
-<a name="72" href="#72">72</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> attach;
-<a name="73" href="#73">73</a>
-<a name="74" href="#74">74</a> <em class="jxr_javadoccomment">/**</em>
-<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * @see org.apache.maven.plugin.Mojo#execute()</em>
-<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> */</em>
-<a name="77" href="#77">77</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute()
-<a name="78" href="#78">78</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException
-<a name="79" href="#79">79</a> {
-<a name="80" href="#80">80</a> <strong class="jxr_keyword">if</strong> ( !outputDirectory.exists() )
-<a name="81" href="#81">81</a> {
-<a name="82" href="#82">82</a> <strong class="jxr_keyword">super</strong>.execute();
-<a name="83" href="#83">83</a> }
-<a name="84" href="#84">84</a>
-<a name="85" href="#85">85</a> <strong class="jxr_keyword">try</strong>
-<a name="86" href="#86">86</a> {
-<a name="87" href="#87">87</a> File outputFile = createArchive( outputDirectory,
-<a name="88" href="#88">88</a> finalName + <span class="jxr_string">"-"</span> + getClassifier() + <span class="jxr_string">"."</span> + getArtifactType() );
-<a name="89" href="#89">89</a>
-<a name="90" href="#90">90</a> <strong class="jxr_keyword">if</strong> ( attach )
-<a name="91" href="#91">91</a> {
-<a name="92" href="#92">92</a> projectHelper.attachArtifact( project, getArtifactType(), getClassifier(), outputFile );
-<a name="93" href="#93">93</a> }
-<a name="94" href="#94">94</a> <strong class="jxr_keyword">else</strong>
-<a name="95" href="#95">95</a> {
-<a name="96" href="#96">96</a> getLog().info( <span class="jxr_string">"NOT adding site jar to the list of attached artifacts."</span> );
-<a name="97" href="#97">97</a> }
-<a name="98" href="#98">98</a> }
-<a name="99" href="#99">99</a> <strong class="jxr_keyword">catch</strong> ( ArchiverException e )
-<a name="100" href="#100">100</a> {
-<a name="101" href="#101">101</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Error while creating archive."</span>, e );
-<a name="102" href="#102">102</a> }
-<a name="103" href="#103">103</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
-<a name="104" href="#104">104</a> {
-<a name="105" href="#105">105</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Error while creating archive."</span>, e );
-<a name="106" href="#106">106</a> }
-<a name="107" href="#107">107</a> }
-<a name="108" href="#108">108</a>
-<a name="109" href="#109">109</a> <strong class="jxr_keyword">protected</strong> String getArtifactType()
-<a name="110" href="#110">110</a> {
-<a name="111" href="#111">111</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"jar"</span>;
-<a name="112" href="#112">112</a> }
-<a name="113" href="#113">113</a>
-<a name="114" href="#114">114</a> <strong class="jxr_keyword">protected</strong> String getClassifier()
-<a name="115" href="#115">115</a> {
-<a name="116" href="#116">116</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"site"</span>;
-<a name="117" href="#117">117</a> }
-<a name="118" href="#118">118</a>
-<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">/**</em>
-<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * Method that creates the jar file.</em>
-<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> *</em>
-<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * @param siteDirectory the directory where the site files are located</em>
-<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * @param jarFilename the filename of the created jar file</em>
-<a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * @return a File object that contains the created jar file</em>
-<a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * @throws ArchiverException</em>
-<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * @throws IOException</em>
-<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> */</em>
-<a name="128" href="#128">128</a> <strong class="jxr_keyword">private</strong> File createArchive( File siteDirectory, String jarFilename )
-<a name="129" href="#129">129</a> <strong class="jxr_keyword">throws</strong> ArchiverException, IOException
-<a name="130" href="#130">130</a> {
-<a name="131" href="#131">131</a> File siteJar = <strong class="jxr_keyword">new</strong> File( jarOutputDirectory, jarFilename );
-<a name="132" href="#132">132</a>
-<a name="133" href="#133">133</a> <strong class="jxr_keyword">if</strong> ( siteJar.exists() )
-<a name="134" href="#134">134</a> {
-<a name="135" href="#135">135</a> siteJar.delete();
-<a name="136" href="#136">136</a> }
-<a name="137" href="#137">137</a>
-<a name="138" href="#138">138</a> JarArchiver archiver = <strong class="jxr_keyword">new</strong> JarArchiver();
-<a name="139" href="#139">139</a> archiver.addDirectory( siteDirectory );
-<a name="140" href="#140">140</a> archiver.setDestFile( siteJar );
-<a name="141" href="#141">141</a> archiver.createArchive();
-<a name="142" href="#142">142</a>
-<a name="143" href="#143">143</a> <strong class="jxr_keyword">return</strong> siteJar;
-<a name="144" href="#144">144</a> }
-<a name="145" href="#145">145</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>
+<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
+<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoFailureException;
+<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProjectHelper;
+<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.codehaus.plexus.archiver.ArchiverException;
+<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.archiver.jar.JarArchiver;
+<a class="jxr_linenumber" name="31" href="#31">31</a>
+<a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * Bundles the site output into a JAR so that it can be deployed to a repository.</em>
+<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:mbeerman@yahoo.com" target="alexandria_uri">mailto:mbeerman@yahoo.com</a>">Matthew Beermann</a></em>
+<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * @version $Id$</em>
+<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * @goal jar</em>
+<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * @phase package</em>
+<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * @since 2.0-beta-6</em>
+<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="41" href="#41">41</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/site/SiteJarMojo.html">SiteJarMojo</a>
+<a class="jxr_linenumber" name="42" href="#42">42</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugins/site/SiteMojo.html">SiteMojo</a>
+<a class="jxr_linenumber" name="43" href="#43">43</a> {
+<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * Specifies the directory where the generated jar file will be put.</em>
+<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @parameter expression="${project.build.directory}"</em>
+<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * @required</em>
+<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="50" href="#50">50</a> <strong class="jxr_keyword">private</strong> String jarOutputDirectory;
+<a class="jxr_linenumber" name="51" href="#51">51</a>
+<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> <em class="jxr_javadoccomment"> * Specifies the filename that will be used for the generated jar file.</em>
+<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * Please note that "-site" will be appended to the file name.</em>
+<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"> * @parameter expression="${project.build.finalName}"</em>
+<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * @required</em>
+<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="59" href="#59">59</a> <strong class="jxr_keyword">private</strong> String finalName;
+<a class="jxr_linenumber" name="60" href="#60">60</a>
+<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * Used for attaching the artifact in the project.</em>
+<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @component</em>
+<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="66" href="#66">66</a> <strong class="jxr_keyword">private</strong> MavenProjectHelper projectHelper;
+<a class="jxr_linenumber" name="67" href="#67">67</a>
+<a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * Specifies whether to attach the generated artifact to the project.</em>
+<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @parameter expression="${site.attach}" default-value="true"</em>
+<a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="73" href="#73">73</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> attach;
+<a class="jxr_linenumber" name="74" href="#74">74</a>
+<a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * @see org.apache.maven.plugin.Mojo#execute()</em>
+<a class="jxr_linenumber" name="77" href="#77">77</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="78" href="#78">78</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute()
+<a class="jxr_linenumber" name="79" href="#79">79</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException
+<a class="jxr_linenumber" name="80" href="#80">80</a> {
+<a class="jxr_linenumber" name="81" href="#81">81</a> <strong class="jxr_keyword">if</strong> ( !outputDirectory.exists() )
+<a class="jxr_linenumber" name="82" href="#82">82</a> {
+<a class="jxr_linenumber" name="83" href="#83">83</a> <strong class="jxr_keyword">super</strong>.execute();
+<a class="jxr_linenumber" name="84" href="#84">84</a> }
+<a class="jxr_linenumber" name="85" href="#85">85</a>
+<a class="jxr_linenumber" name="86" href="#86">86</a> <strong class="jxr_keyword">try</strong>
+<a class="jxr_linenumber" name="87" href="#87">87</a> {
+<a class="jxr_linenumber" name="88" href="#88">88</a> File outputFile = createArchive( outputDirectory,
+<a class="jxr_linenumber" name="89" href="#89">89</a> finalName + <span class="jxr_string">"-"</span> + getClassifier() + <span class="jxr_string">"."</span> + getArtifactType() );
+<a class="jxr_linenumber" name="90" href="#90">90</a>
+<a class="jxr_linenumber" name="91" href="#91">91</a> <strong class="jxr_keyword">if</strong> ( attach )
+<a class="jxr_linenumber" name="92" href="#92">92</a> {
+<a class="jxr_linenumber" name="93" href="#93">93</a> projectHelper.attachArtifact( project, getArtifactType(), getClassifier(), outputFile );
+<a class="jxr_linenumber" name="94" href="#94">94</a> }
+<a class="jxr_linenumber" name="95" href="#95">95</a> <strong class="jxr_keyword">else</strong>
+<a class="jxr_linenumber" name="96" href="#96">96</a> {
+<a class="jxr_linenumber" name="97" href="#97">97</a> getLog().info( <span class="jxr_string">"NOT adding site jar to the list of attached artifacts."</span> );
+<a class="jxr_linenumber" name="98" href="#98">98</a> }
+<a class="jxr_linenumber" name="99" href="#99">99</a> }
+<a class="jxr_linenumber" name="100" href="#100">100</a> <strong class="jxr_keyword">catch</strong> ( ArchiverException e )
+<a class="jxr_linenumber" name="101" href="#101">101</a> {
+<a class="jxr_linenumber" name="102" href="#102">102</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Error while creating archive."</span>, e );
+<a class="jxr_linenumber" name="103" href="#103">103</a> }
+<a class="jxr_linenumber" name="104" href="#104">104</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
+<a class="jxr_linenumber" name="105" href="#105">105</a> {
+<a class="jxr_linenumber" name="106" href="#106">106</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Error while creating archive."</span>, e );
+<a class="jxr_linenumber" name="107" href="#107">107</a> }
+<a class="jxr_linenumber" name="108" href="#108">108</a> }
+<a class="jxr_linenumber" name="109" href="#109">109</a>
+<a class="jxr_linenumber" name="110" href="#110">110</a> <strong class="jxr_keyword">protected</strong> String getArtifactType()
+<a class="jxr_linenumber" name="111" href="#111">111</a> {
+<a class="jxr_linenumber" name="112" href="#112">112</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"jar"</span>;
+<a class="jxr_linenumber" name="113" href="#113">113</a> }
+<a class="jxr_linenumber" name="114" href="#114">114</a>
+<a class="jxr_linenumber" name="115" href="#115">115</a> <strong class="jxr_keyword">protected</strong> String getClassifier()
+<a class="jxr_linenumber" name="116" href="#116">116</a> {
+<a class="jxr_linenumber" name="117" href="#117">117</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"site"</span>;
+<a class="jxr_linenumber" name="118" href="#118">118</a> }
+<a class="jxr_linenumber" name="119" href="#119">119</a>
+<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> <em class="jxr_javadoccomment"> * Method that creates the jar file.</em>
+<a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * @param siteDirectory the directory where the site files are located</em>
+<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * @param jarFilename the filename of the created jar file</em>
+<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * @return a File object that contains the created jar file</em>
+<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * @throws ArchiverException</em>
+<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * @throws IOException</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> <strong class="jxr_keyword">private</strong> File createArchive( File siteDirectory, String jarFilename )
+<a class="jxr_linenumber" name="130" href="#130">130</a> <strong class="jxr_keyword">throws</strong> ArchiverException, IOException
+<a class="jxr_linenumber" name="131" href="#131">131</a> {
+<a class="jxr_linenumber" name="132" href="#132">132</a> File siteJar = <strong class="jxr_keyword">new</strong> File( jarOutputDirectory, jarFilename );
+<a class="jxr_linenumber" name="133" href="#133">133</a>
+<a class="jxr_linenumber" name="134" href="#134">134</a> <strong class="jxr_keyword">if</strong> ( siteJar.exists() )
+<a class="jxr_linenumber" name="135" href="#135">135</a> {
+<a class="jxr_linenumber" name="136" href="#136">136</a> siteJar.delete();
+<a class="jxr_linenumber" name="137" href="#137">137</a> }
+<a class="jxr_linenumber" name="138" href="#138">138</a>
+<a class="jxr_linenumber" name="139" href="#139">139</a> JarArchiver archiver = <strong class="jxr_keyword">new</strong> JarArchiver();
+<a class="jxr_linenumber" name="140" href="#140">140</a> archiver.addDirectory( siteDirectory );
+<a class="jxr_linenumber" name="141" href="#141">141</a> archiver.setDestFile( siteJar );
+<a class="jxr_linenumber" name="142" href="#142">142</a> archiver.createArchive();
+<a class="jxr_linenumber" name="143" href="#143">143</a>
+<a class="jxr_linenumber" name="144" href="#144">144</a> <strong class="jxr_keyword">return</strong> siteJar;
+<a class="jxr_linenumber" name="145" href="#145">145</a> }
+<a class="jxr_linenumber" name="146" href="#146">146</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>