Modified:
websites/production/maven-doxia/content/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/org/apache/maven/doxia/tools/SiteTool.html
==============================================================================
---
websites/production/maven-doxia/content/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/org/apache/maven/doxia/tools/SiteTool.html
(original)
+++
websites/production/maven-doxia/content/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/org/apache/maven/doxia/tools/SiteTool.html
Mon Dec 28 15:13:00 2015
@@ -141,74 +141,76 @@
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em
class="jxr_javadoccomment"> * @return the
<code>DecorationModel</code> object corresponding to the
<code>site.xml</code> file with some</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em
class="jxr_javadoccomment"> * interpolations.</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em
class="jxr_javadoccomment"> * @throws SiteToolException if any</em>
-<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L137" href="#L137">137</a> <a
href="../../../../../org/apache/maven/doxia/site/decoration/DecorationModel.html">DecorationModel</a>
getDecorationModel( File siteDirectory, Locale locale, MavenProject project,
-<a class="jxr_linenumber" name="L138" href="#L138">138</a>
List<MavenProject> reactorProjects,
ArtifactRepository localRepository,
-<a class="jxr_linenumber" name="L139" href="#L139">139</a>
List<ArtifactRepository> repositories )
-<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong
class="jxr_keyword">throws</strong> SiteToolException;
-<a class="jxr_linenumber" name="L141" href="#L141">141</a>
-<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em
class="jxr_javadoccomment"> * Populate the pre-defined
<code>reports</code> menu of the decoration model,</em>
-<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em
class="jxr_javadoccomment"> * if used through <code>&lt;menu
ref="reports"/&gt;</code>. Notice this menu reference is translated
into</em>
-<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em
class="jxr_javadoccomment"> * 2 separate menus: "Project Information" and
"Project Reports".</em>
-<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em
class="jxr_javadoccomment"> * @param decorationModel the Doxia Sitetools
DecorationModel, not null.</em>
-<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em
class="jxr_javadoccomment"> * @param locale the locale used for the i18n in
DecorationModel. If null, using the default locale in the jvm.</em>
-<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em
class="jxr_javadoccomment"> * @param reportsPerCategory reports per
category to put in "Reports" or "Information" menus, not null.</em>
-<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em
class="jxr_javadoccomment"> * @see
MavenReport#CATEGORY_PROJECT_INFORMATION</em>
-<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em
class="jxr_javadoccomment"> * @see MavenReport#CATEGORY_PROJECT_REPORTS</em>
-<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong
class="jxr_keyword">void</strong> populateReportsMenu( DecorationModel
decorationModel, Locale locale,
-<a class="jxr_linenumber" name="L154" href="#L154">154</a>
Map<String, List<MavenReport>> reportsPerCategory );
-<a class="jxr_linenumber" name="L155" href="#L155">155</a>
-<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em
class="jxr_javadoccomment"> * Extracts from a comma-separated list the
locales that are available in <code>site-tool</code></em>
-<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em
class="jxr_javadoccomment"> * resource bundle. Notice that
<code>default</code> value will be changed to the default locale
of</em>
-<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em
class="jxr_javadoccomment"> * the JVM.</em>
-<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em
class="jxr_javadoccomment"> * @param locales A comma separated list of
locales</em>
-<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em
class="jxr_javadoccomment"> * @return a list of
<code>Locale</code>, which at least contains the Maven default
locale which is english</em>
-<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L164" href="#L164">164</a>
List<Locale> getSiteLocales( String locales );
-<a class="jxr_linenumber" name="L165" href="#L165">165</a>
-<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em
class="jxr_javadoccomment"> * Calculate the relative path between two URLs
or between two files.</em>
-<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em
class="jxr_javadoccomment"> * For example:</em>
-<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em
class="jxr_javadoccomment"> * <dl></em>
-<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em
class="jxr_javadoccomment"> * <dt>to = "<a
href="http://maven.apache.org";
target="alexandria_uri">http://maven.apache.org</a>" and from = "<a
href="http://maven.apache.org";
target="alexandria_uri">http://maven.apache.org</a>"</dt></em>
-<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em
class="jxr_javadoccomment"> * <dd>return ""</dd></em>
-<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em
class="jxr_javadoccomment"> * <dt>to = "<a
href="http://maven.apache.org";
target="alexandria_uri">http://maven.apache.org</a>" and from = "<a
href="http://maven.apache.org";
target="alexandria_uri">http://maven.apache.org</a>/plugins/maven-site-plugin/"</dt></em>
-<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em
class="jxr_javadoccomment"> * <dd>return "../.."</dd></em>
-<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em
class="jxr_javadoccomment"> * <dt>to = "<a
href="http://maven.apache.org/plugins/maven-site-plugin/";
target="alexandria_uri">http://maven.apache.org/plugins/maven-site-plugin/</a>"
and from = "http://maven.apache.org"</dt></em>
-<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em
class="jxr_javadoccomment"> * <dd>return
"plugins/maven-site-plugin"</dd></em>
-<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em
class="jxr_javadoccomment"> * <dt>to = "/myproject/myproject-module1"
and from = "/myproject/myproject"</dt></em>
-<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em
class="jxr_javadoccomment"> * <dd>return
"../myproject-module1"</dd></em>
-<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em
class="jxr_javadoccomment"> * </dl></em>
-<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em
class="jxr_javadoccomment"> * <b>Note</b>: The file separator
depends on the system.</em>
-<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em
class="jxr_javadoccomment"> * @param to the <code>to</code> url
of file as string</em>
-<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em
class="jxr_javadoccomment"> * @param from the <code>from</code>
url of file as string</em>
-<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em
class="jxr_javadoccomment"> * @return a relative path from
<code>from</code> to <code>to</code>.</em>
-<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L186" href="#L186">186</a> String
getRelativePath( String to, String from );
-<a class="jxr_linenumber" name="L187" href="#L187">187</a>
-<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em
class="jxr_javadoccomment"> * Returns the parent POM with interpolated
URLs. Attempts to source this value from the</em>
-<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em
class="jxr_javadoccomment"> * <code>reactorProjects</code>
parameters if available (reactor env model attributes</em>
-<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em
class="jxr_javadoccomment"> * are interpolated), or if the reactor is
unavailable (-N) resorts to the</em>
-<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em
class="jxr_javadoccomment"> *
<code>project.getParent().getUrl()</code> value which will NOT have
been interpolated.</em>
-<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em
class="jxr_javadoccomment"> * <p/></em>
-<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em
class="jxr_javadoccomment"> * TODO: once bug is fixed in Maven proper,
remove this.</em>
-<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em
class="jxr_javadoccomment"> * @param aProject a Maven project, not
null.</em>
-<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em
class="jxr_javadoccomment"> * @param reactorProjects the Maven reactor
projects, not null.</em>
-<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em
class="jxr_javadoccomment"> * @param localRepository the Maven local
repository, not null.</em>
-<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em
class="jxr_javadoccomment"> * @return the parent project with interpolated
URLs.</em>
-<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L201" href="#L201">201</a> MavenProject
getParentProject( MavenProject aProject, List<MavenProject>
reactorProjects,
-<a class="jxr_linenumber" name="L202" href="#L202">202</a>
ArtifactRepository localRepository );
-<a class="jxr_linenumber" name="L203" href="#L203">203</a> }
+<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em
class="jxr_javadoccomment"> * @since 1.7, was previously with other
parameter types and order</em>
+<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L138" href="#L138">138</a> <a
href="../../../../../org/apache/maven/doxia/site/decoration/DecorationModel.html">DecorationModel</a>
getDecorationModel( File siteDirectory, Locale locale, MavenProject project,
+<a class="jxr_linenumber" name="L139" href="#L139">139</a>
List<MavenProject> reactorProjects,
ArtifactRepository localRepository,
+<a class="jxr_linenumber" name="L140" href="#L140">140</a>
List<ArtifactRepository> repositories )
+<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong
class="jxr_keyword">throws</strong> SiteToolException;
+<a class="jxr_linenumber" name="L142" href="#L142">142</a>
+<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em
class="jxr_javadoccomment"> * Populate the pre-defined
<code>reports</code> menu of the decoration model,</em>
+<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em
class="jxr_javadoccomment"> * if used through <code>&lt;menu
ref="reports"/&gt;</code>. Notice this menu reference is translated
into</em>
+<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em
class="jxr_javadoccomment"> * 2 separate menus: "Project Information" and
"Project Reports".</em>
+<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em
class="jxr_javadoccomment"> * @param decorationModel the Doxia Sitetools
DecorationModel, not null.</em>
+<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em
class="jxr_javadoccomment"> * @param locale the locale used for the i18n in
DecorationModel. If null, using the default locale in the jvm.</em>
+<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em
class="jxr_javadoccomment"> * @param reportsPerCategory reports per
category to put in "Reports" or "Information" menus, not null.</em>
+<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em
class="jxr_javadoccomment"> * @see
MavenReport#CATEGORY_PROJECT_INFORMATION</em>
+<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em
class="jxr_javadoccomment"> * @see MavenReport#CATEGORY_PROJECT_REPORTS</em>
+<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong
class="jxr_keyword">void</strong> populateReportsMenu( DecorationModel
decorationModel, Locale locale,
+<a class="jxr_linenumber" name="L155" href="#L155">155</a>
Map<String, List<MavenReport>> reportsPerCategory );
+<a class="jxr_linenumber" name="L156" href="#L156">156</a>
+<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em
class="jxr_javadoccomment"> * Extracts from a comma-separated list the
locales that are available in <code>site-tool</code></em>
+<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em
class="jxr_javadoccomment"> * resource bundle. Notice that
<code>default</code> value will be changed to the default locale
of</em>
+<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em
class="jxr_javadoccomment"> * the JVM.</em>
+<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em
class="jxr_javadoccomment"> * @param locales A comma separated list of
locales</em>
+<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em
class="jxr_javadoccomment"> * @return a list of
<code>Locale</code>, which at least contains the Maven default
locale which is english</em>
+<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em
class="jxr_javadoccomment"> * @since 1.7, was previously
getAvailableLocales(String)</em>
+<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L166" href="#L166">166</a>
List<Locale> getSiteLocales( String locales );
+<a class="jxr_linenumber" name="L167" href="#L167">167</a>
+<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em
class="jxr_javadoccomment"> * Calculate the relative path between two URLs
or between two files.</em>
+<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em
class="jxr_javadoccomment"> * For example:</em>
+<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em
class="jxr_javadoccomment"> * <dl></em>
+<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em
class="jxr_javadoccomment"> * <dt>to = "<a
href="http://maven.apache.org";
target="alexandria_uri">http://maven.apache.org</a>" and from = "<a
href="http://maven.apache.org";
target="alexandria_uri">http://maven.apache.org</a>"</dt></em>
+<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em
class="jxr_javadoccomment"> * <dd>return ""</dd></em>
+<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em
class="jxr_javadoccomment"> * <dt>to = "<a
href="http://maven.apache.org";
target="alexandria_uri">http://maven.apache.org</a>" and from = "<a
href="http://maven.apache.org";
target="alexandria_uri">http://maven.apache.org</a>/plugins/maven-site-plugin/"</dt></em>
+<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em
class="jxr_javadoccomment"> * <dd>return "../.."</dd></em>
+<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em
class="jxr_javadoccomment"> * <dt>to = "<a
href="http://maven.apache.org/plugins/maven-site-plugin/";
target="alexandria_uri">http://maven.apache.org/plugins/maven-site-plugin/</a>"
and from = "http://maven.apache.org"</dt></em>
+<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em
class="jxr_javadoccomment"> * <dd>return
"plugins/maven-site-plugin"</dd></em>
+<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em
class="jxr_javadoccomment"> * <dt>to = "/myproject/myproject-module1"
and from = "/myproject/myproject"</dt></em>
+<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em
class="jxr_javadoccomment"> * <dd>return
"../myproject-module1"</dd></em>
+<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em
class="jxr_javadoccomment"> * </dl></em>
+<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em
class="jxr_javadoccomment"> * <b>Note</b>: The file separator
depends on the system.</em>
+<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em
class="jxr_javadoccomment"> * @param to the <code>to</code> url
of file as string</em>
+<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em
class="jxr_javadoccomment"> * @param from the <code>from</code>
url of file as string</em>
+<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em
class="jxr_javadoccomment"> * @return a relative path from
<code>from</code> to <code>to</code>.</em>
+<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L188" href="#L188">188</a> String
getRelativePath( String to, String from );
+<a class="jxr_linenumber" name="L189" href="#L189">189</a>
+<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em
class="jxr_javadoccomment"> * Returns the parent POM with interpolated
URLs. Attempts to source this value from the</em>
+<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em
class="jxr_javadoccomment"> * <code>reactorProjects</code>
parameters if available (reactor env model attributes</em>
+<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em
class="jxr_javadoccomment"> * are interpolated), or if the reactor is
unavailable (-N) resorts to the</em>
+<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em
class="jxr_javadoccomment"> *
<code>project.getParent().getUrl()</code> value which will NOT have
been interpolated.</em>
+<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em
class="jxr_javadoccomment"> * <p/></em>
+<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em
class="jxr_javadoccomment"> * TODO: once bug is fixed in Maven proper,
remove this.</em>
+<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em
class="jxr_javadoccomment"> * @param aProject a Maven project, not
null.</em>
+<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em
class="jxr_javadoccomment"> * @param reactorProjects the Maven reactor
projects, not null.</em>
+<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em
class="jxr_javadoccomment"> * @param localRepository the Maven local
repository, not null.</em>
+<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em
class="jxr_javadoccomment"> * @return the parent project with interpolated
URLs.</em>
+<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L203" href="#L203">203</a> MavenProject
getParentProject( MavenProject aProject, List<MavenProject>
reactorProjects,
+<a class="jxr_linenumber" name="L204" href="#L204">204</a>
ArtifactRepository localRepository );
+<a class="jxr_linenumber" name="L205" href="#L205">205</a> }
</pre>
<hr/>
<div id="footer">Copyright © 2005–2015 <a
href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights
reserved.</div>
