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 2014/06/30 21:16:47 UTC
svn commit: r914477 [5/24] - in
/websites/production/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST:
./ apidocs/ cobertura/ css/ images/ maven-doxia/ maven-doxia/content/
maven-doxia/content/doxia-tools-archives/ maven-doxia/co...
Added: websites/production/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/apidocs/org/apache/maven/doxia/tools/SiteTool.html
==============================================================================
--- websites/production/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/apidocs/org/apache/maven/doxia/tools/SiteTool.html (added)
+++ websites/production/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/apidocs/org/apache/maven/doxia/tools/SiteTool.html Mon Jun 30 19:16:43 2014
@@ -0,0 +1,685 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="fr">
+<head>
+<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
+<title>SiteTool (Doxia :: Integration Tools 1.6-SNAPSHOT API)</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="SiteTool (Doxia :: Integration Tools 1.6-SNAPSHOT API)";
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar_top">
+<!-- -->
+</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../org/apache/maven/doxia/tools/package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/SiteTool.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../org/apache/maven/doxia/tools/ReportComparator.html" title="class in org.apache.maven.doxia.tools"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/maven/doxia/tools/SiteToolException.html" title="class in org.apache.maven.doxia.tools"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/maven/doxia/tools/SiteTool.html" target="_top">Frames</a></li>
+<li><a href="SiteTool.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#field_summary">Field</a> | </li>
+<li>Constr | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field_detail">Field</a> | </li>
+<li>Constr | </li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.maven.doxia.tools</div>
+<h2 title="Interface SiteTool" class="title">Interface SiteTool</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Known Implementing Classes:</dt>
+<dd><a href="../../../../../org/apache/maven/doxia/tools/DefaultSiteTool.html" title="class in org.apache.maven.doxia.tools">DefaultSiteTool</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public interface <span class="strong">SiteTool</span></pre>
+<div class="block">Tool to play with <a href="http://maven.apache.org/doxia/">Doxia</a> objects
+ like <code>DecorationModel</code>.</div>
+<dl><dt><span class="strong">Version:</span></dt>
+ <dd>$Id$</dd>
+<dt><span class="strong">Author:</span></dt>
+ <dd><a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a></dd></dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- =========== FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field_summary">
+<!-- -->
+</a>
+<h3>Field Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
+<caption><span>Fields</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Field and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#DEFAULT_LOCALE">DEFAULT_LOCALE</a></strong></code>
+<div class="block">The locale by default for all default bundles</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#ROLE">ROLE</a></strong></code>
+<div class="block">Plexus Role</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span>Methods</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#codeToLocale(java.lang.String)">codeToLocale</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> localeCode)</code>
+<div class="block">Converts a locale code like "en", "en_US" or "en_US_win" to a <code>java.util.Locale</code>
+ object.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#getAvailableLocales(java.lang.String)">getAvailableLocales</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> locales)</code>
+<div class="block">Init the <code>localesList</code> variable.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html?is-external=true" title="class or interface in org.apache.maven.doxia.site.decoration">DecorationModel</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#getDecorationModel(org.apache.maven.project.MavenProject, java.util.List, org.apache.maven.artifact.repository.ArtifactRepository, java.util.List, java.lang.String, java.util.Locale)">getDecorationModel</a></strong>(<a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> project,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a>> reactorProjects,
+ <a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a> localRepository,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a>> repositories,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> siteDirectory,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</code>
+<div class="block">Get a decoration model for a project.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/Artifact.html?is-external=true" title="class or interface in org.apache.maven.artifact">Artifact</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#getDefaultSkinArtifact(org.apache.maven.artifact.repository.ArtifactRepository, java.util.List)">getDefaultSkinArtifact</a></strong>(<a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a> localRepository,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a>> remoteArtifactRepositories)</code>
+<div class="block">Get the default skin artifact for a project from one of the repositories.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#getInterpolatedSiteDescriptorContent(java.util.Map, org.apache.maven.project.MavenProject, java.lang.String)">getInterpolatedSiteDescriptorContent</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> props,
+ <a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> aProject,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> siteDescriptorContent)</code>
+<div class="block">Interpolating several expressions in the site descriptor content.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#getParentProject(org.apache.maven.project.MavenProject, java.util.List, org.apache.maven.artifact.repository.ArtifactRepository)">getParentProject</a></strong>(<a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> aProject,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a>> reactorProjects,
+ <a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a> localRepository)</code>
+<div class="block">Returns the parent POM with interpolated URLs.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#getRelativePath(java.lang.String, java.lang.String)">getRelativePath</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> to,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> from)</code>
+<div class="block">Calculate the relative path between two URLs or between two files.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#getSiteDescriptorFromBasedir(java.lang.String, java.io.File, java.util.Locale)">getSiteDescriptorFromBasedir</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> siteDirectory,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> basedir,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</code>
+<div class="block">Get a site descriptor from the project's base directory.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#getSiteDescriptorFromRepository(org.apache.maven.project.MavenProject, org.apache.maven.artifact.repository.ArtifactRepository, java.util.List, java.util.Locale)">getSiteDescriptorFromRepository</a></strong>(<a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> project,
+ <a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a> localRepository,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a>> repositories,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</code>
+<div class="block">Get a site descriptor from one of the repositories.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/Artifact.html?is-external=true" title="class or interface in org.apache.maven.artifact">Artifact</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#getSkinArtifactFromRepository(org.apache.maven.artifact.repository.ArtifactRepository, java.util.List, org.apache.maven.doxia.site.decoration.DecorationModel)">getSkinArtifactFromRepository</a></strong>(<a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a> localRepository,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a>> remoteArtifactRepositories,
+ <a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html?is-external=true" title="class or interface in org.apache.maven.doxia.site.decoration">DecorationModel</a> decoration)</code>
+<div class="block">Get a skin artifact from one of the repositories.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#populateModules(org.apache.maven.project.MavenProject, java.util.List, org.apache.maven.artifact.repository.ArtifactRepository, org.apache.maven.doxia.site.decoration.DecorationModel, java.util.Locale, boolean)">populateModules</a></strong>(<a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> project,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a>> reactorProjects,
+ <a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a> localRepository,
+ <a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html?is-external=true" title="class or interface in org.apache.maven.doxia.site.decoration">DecorationModel</a> decorationModel,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale,
+ boolean keepInheritedRefs)</code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>Please use
+ <a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#populateModulesMenu(org.apache.maven.project.MavenProject, java.util.List, org.apache.maven.artifact.repository.ArtifactRepository, org.apache.maven.doxia.site.decoration.DecorationModel, java.util.Locale, boolean)"><code>populateModulesMenu(MavenProject, List, ArtifactRepository, DecorationModel, Locale, boolean)</code></a>
+ instead</i></div>
+</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#populateModulesMenu(org.apache.maven.project.MavenProject, java.util.List, org.apache.maven.artifact.repository.ArtifactRepository, org.apache.maven.doxia.site.decoration.DecorationModel, java.util.Locale, boolean)">populateModulesMenu</a></strong>(<a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> project,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a>> reactorProjects,
+ <a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a> localRepository,
+ <a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html?is-external=true" title="class or interface in org.apache.maven.doxia.site.decoration">DecorationModel</a> decorationModel,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale,
+ boolean keepInheritedRefs)</code>
+<div class="block">Populate the modules menu part of the decoration model.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#populateParentMenu(org.apache.maven.doxia.site.decoration.DecorationModel, java.util.Locale, org.apache.maven.project.MavenProject, org.apache.maven.project.MavenProject, boolean)">populateParentMenu</a></strong>(<a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html?is-external=true" title="class or interface in org.apache.maven.doxia.site.decoration">DecorationModel</a> decorationModel,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale,
+ <a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> project,
+ <a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> parentProject,
+ boolean keepInheritedRefs)</code>
+<div class="block">Populate the parent menu part of the decoration model.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#populateProjectParentMenu(org.apache.maven.doxia.site.decoration.DecorationModel, java.util.Locale, org.apache.maven.project.MavenProject, org.apache.maven.project.MavenProject, boolean)">populateProjectParentMenu</a></strong>(<a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html?is-external=true" title="class or interface in org.apache.maven.doxia.site.decoration">DecorationModel</a> decorationModel,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale,
+ <a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> project,
+ <a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> parentProject,
+ boolean keepInheritedRefs)</code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>Please use
+ <a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#populateParentMenu(org.apache.maven.doxia.site.decoration.DecorationModel, java.util.Locale, org.apache.maven.project.MavenProject, org.apache.maven.project.MavenProject, boolean)"><code>populateParentMenu(DecorationModel, Locale, MavenProject, MavenProject, boolean)</code></a> instead</i></div>
+</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#populateReportsMenu(org.apache.maven.doxia.site.decoration.DecorationModel, java.util.Locale, java.util.Map)">populateReportsMenu</a></strong>(<a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html?is-external=true" title="class or interface in org.apache.maven.doxia.site.decoration">DecorationModel</a> decorationModel,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReport</a>>> categories)</code>
+<div class="block">Populate the reports menu part of the decoration model.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ FIELD DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field_detail">
+<!-- -->
+</a>
+<h3>Field Detail</h3>
+<a name="ROLE">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>ROLE</h4>
+<pre>static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ROLE</pre>
+<div class="block">Plexus Role</div>
+</li>
+</ul>
+<a name="DEFAULT_LOCALE">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>DEFAULT_LOCALE</h4>
+<pre>static final <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> DEFAULT_LOCALE</pre>
+<div class="block">The locale by default for all default bundles</div>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true#ENGLISH" title="class or interface in java.util"><code>Locale.ENGLISH</code></a></dd></dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="getSkinArtifactFromRepository(org.apache.maven.artifact.repository.ArtifactRepository, java.util.List, org.apache.maven.doxia.site.decoration.DecorationModel)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSkinArtifactFromRepository</h4>
+<pre><a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/Artifact.html?is-external=true" title="class or interface in org.apache.maven.artifact">Artifact</a> getSkinArtifactFromRepository(<a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a> localRepository,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a>> remoteArtifactRepositories,
+ <a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html?is-external=true" title="class or interface in org.apache.maven.doxia.site.decoration">DecorationModel</a> decoration)
+ throws <a href="../../../../../org/apache/maven/doxia/tools/SiteToolException.html" title="class in org.apache.maven.doxia.tools">SiteToolException</a></pre>
+<div class="block">Get a skin artifact from one of the repositories.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>localRepository</code> - the Maven local repository, not null.</dd><dd><code>remoteArtifactRepositories</code> - the Maven remote repositories, not null.</dd><dd><code>decoration</code> - the Doxia site descriptor model, not null.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the <code>Skin</code> artifact defined in a <code>DecorationModel</code> from a given project and a
+ local repository</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../../org/apache/maven/doxia/tools/SiteToolException.html" title="class in org.apache.maven.doxia.tools">SiteToolException</a></code> - if any</dd></dl>
+</li>
+</ul>
+<a name="getDefaultSkinArtifact(org.apache.maven.artifact.repository.ArtifactRepository, java.util.List)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getDefaultSkinArtifact</h4>
+<pre><a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/Artifact.html?is-external=true" title="class or interface in org.apache.maven.artifact">Artifact</a> getDefaultSkinArtifact(<a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a> localRepository,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a>> remoteArtifactRepositories)
+ throws <a href="../../../../../org/apache/maven/doxia/tools/SiteToolException.html" title="class in org.apache.maven.doxia.tools">SiteToolException</a></pre>
+<div class="block">Get the default skin artifact for a project from one of the repositories.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>localRepository</code> - the Maven local repository, not null.</dd><dd><code>remoteArtifactRepositories</code> - the Maven remote repositories, not null.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the default <code>Skin</code> artifact from a given project and a local repository</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../../org/apache/maven/doxia/tools/SiteToolException.html" title="class in org.apache.maven.doxia.tools">SiteToolException</a></code> - if any</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/Skin.html?is-external=true#getDefaultSkin()" title="class or interface in org.apache.maven.doxia.site.decoration"><code>Skin.getDefaultSkin()</code></a>,
+<a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#getSkinArtifactFromRepository(org.apache.maven.artifact.repository.ArtifactRepository, java.util.List, org.apache.maven.doxia.site.decoration.DecorationModel)"><code>getSkinArtifactFromRepository(ArtifactRepository, List, DecorationModel)</code></a></dd></dl>
+</li>
+</ul>
+<a name="getRelativePath(java.lang.String, java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getRelativePath</h4>
+<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getRelativePath(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> to,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> from)</pre>
+<div class="block">Calculate the relative path between two URLs or between two files.
+
+ For example:
+ <dl>
+ <dt>to = "http://maven.apache.org" and from = "http://maven.apache.org"</dt>
+ <dd>return ""</dd>
+ <dt>to = "http://maven.apache.org" and from = "http://maven.apache.org/plugins/maven-site-plugin/"</dt>
+ <dd>return "../.."</dd>
+ <dt>to = "http://maven.apache.org/plugins/maven-site-plugin/" and from = "http://maven.apache.org"</dt>
+ <dd>return "plugins/maven-site-plugin"</dd>
+ <dt>to = "/myproject/myproject-module1" and from = "/myproject/myproject"</dt>
+ <dd>return "../myproject-module1"</dd>
+ </dl>
+ <b>Note</b>: The file separator depends on the system.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>to</code> - the <code>to</code> url of file as string</dd><dd><code>from</code> - the <code>from</code> url of file as string</dd>
+<dt><span class="strong">Returns:</span></dt><dd>a relative path from <code>from</code> to <code>to</code>.</dd></dl>
+</li>
+</ul>
+<a name="getSiteDescriptorFromBasedir(java.lang.String, java.io.File, java.util.Locale)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSiteDescriptorFromBasedir</h4>
+<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> getSiteDescriptorFromBasedir(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> siteDirectory,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> basedir,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</pre>
+<div class="block">Get a site descriptor from the project's base directory.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>siteDirectory</code> - The path to the directory containing the <code>site.xml</code> file, relative to the
+ project base directory. If null, using by default "src/site".</dd><dd><code>basedir</code> - not null.</dd><dd><code>locale</code> - the locale wanted for the site descriptor. If not null, searching for
+ <code>site_<i>localeLanguage</i>.xml</code>, otherwise searching for <code>site.xml</code>.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the site descriptor relative file, i.e. <code>src/site/site.xml</code>, depending on parameter values.</dd></dl>
+</li>
+</ul>
+<a name="getSiteDescriptorFromRepository(org.apache.maven.project.MavenProject, org.apache.maven.artifact.repository.ArtifactRepository, java.util.List, java.util.Locale)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSiteDescriptorFromRepository</h4>
+<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> getSiteDescriptorFromRepository(<a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> project,
+ <a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a> localRepository,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a>> repositories,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)
+ throws <a href="../../../../../org/apache/maven/doxia/tools/SiteToolException.html" title="class in org.apache.maven.doxia.tools">SiteToolException</a></pre>
+<div class="block">Get a site descriptor from one of the repositories.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>project</code> - the Maven project, not null.</dd><dd><code>localRepository</code> - the Maven local repository, not null.</dd><dd><code>repositories</code> - the Maven remote repositories, not null.</dd><dd><code>locale</code> - the locale wanted for the site descriptor. If not null, searching for
+ <code>site_<i>localeLanguage</i>.xml</code>, otherwise searching for <code>site.xml</code>.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the site descriptor into the local repository after download of it from repositories or null if not
+ found in repositories.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../../org/apache/maven/doxia/tools/SiteToolException.html" title="class in org.apache.maven.doxia.tools">SiteToolException</a></code> - if any</dd></dl>
+</li>
+</ul>
+<a name="getDecorationModel(org.apache.maven.project.MavenProject, java.util.List, org.apache.maven.artifact.repository.ArtifactRepository, java.util.List, java.lang.String, java.util.Locale)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getDecorationModel</h4>
+<pre><a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html?is-external=true" title="class or interface in org.apache.maven.doxia.site.decoration">DecorationModel</a> getDecorationModel(<a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> project,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a>> reactorProjects,
+ <a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a> localRepository,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a>> repositories,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> siteDirectory,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)
+ throws <a href="../../../../../org/apache/maven/doxia/tools/SiteToolException.html" title="class in org.apache.maven.doxia.tools">SiteToolException</a></pre>
+<div class="block">Get a decoration model for a project.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>project</code> - the Maven project, not null.</dd><dd><code>reactorProjects</code> - the Maven reactor projects, not null.</dd><dd><code>localRepository</code> - the Maven local repository, not null.</dd><dd><code>repositories</code> - the Maven remote repositories, not null.</dd><dd><code>siteDirectory</code> - The path to the directory containing the <code>site.xml</code> file, relative to the
+ project base directory. If null, using by default "src/site".</dd><dd><code>locale</code> - the locale used for the i18n in DecorationModel. If null, using the default locale in the jvm.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the <code>DecorationModel</code> object corresponding to the <code>site.xml</code> file with some
+ interpolations.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../../org/apache/maven/doxia/tools/SiteToolException.html" title="class in org.apache.maven.doxia.tools">SiteToolException</a></code> - if any</dd></dl>
+</li>
+</ul>
+<a name="populateReportsMenu(org.apache.maven.doxia.site.decoration.DecorationModel, java.util.Locale, java.util.Map)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>populateReportsMenu</h4>
+<pre>void populateReportsMenu(<a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html?is-external=true" title="class or interface in org.apache.maven.doxia.site.decoration">DecorationModel</a> decorationModel,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReport</a>>> categories)</pre>
+<div class="block">Populate the reports menu part of the decoration model.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>decorationModel</code> - the Doxia DecorationModel, not null.</dd><dd><code>locale</code> - the locale used for the i18n in DecorationModel. If null, using the default locale in the jvm.</dd><dd><code>categories</code> - a map to put on the decoration model, not null.</dd></dl>
+</li>
+</ul>
+<a name="getInterpolatedSiteDescriptorContent(java.util.Map, org.apache.maven.project.MavenProject, java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getInterpolatedSiteDescriptorContent</h4>
+<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getInterpolatedSiteDescriptorContent(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> props,
+ <a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> aProject,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> siteDescriptorContent)
+ throws <a href="../../../../../org/apache/maven/doxia/tools/SiteToolException.html" title="class in org.apache.maven.doxia.tools">SiteToolException</a></pre>
+<div class="block">Interpolating several expressions in the site descriptor content. Actually, the expressions can be in
+ the project, the environment variables and the specific properties like <code>encoding</code>.
+ <p/>
+ For instance:
+ <dl>
+ <dt>${project.name}</dt>
+ <dd>The value from the POM of:
+ <p>
+ <project><br>
+ <name>myProjectName</name><br>
+ </project>
+ </p></dd>
+ <dt>${my.value}</dt>
+ <dd>The value from the POM of:
+ <p>
+ <properties><br>
+ <my.value>hello</my.value><br>
+ </properties>
+ </p></dd>
+ <dt>${JAVA_HOME}</dt>
+ <dd>The value of JAVA_HOME in the environment variables</dd>
+ </dl></div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>props</code> - a map used for interpolation, not null.</dd><dd><code>aProject</code> - a Maven project, not null.</dd><dd><code>inputEncoding</code> - the input encoding of the site descriptor, not null.</dd><dd><code>outputEncoding</code> - the output encoding wanted, not null.</dd><dd><code>siteDescriptorContent</code> - the site descriptor file, not null.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the site descriptor content based on the <code>site.xml</code> file with interpolated strings.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../../org/apache/maven/doxia/tools/SiteToolException.html" title="class in org.apache.maven.doxia.tools">SiteToolException</a></code> - if errors happened during the interpolation.</dd></dl>
+</li>
+</ul>
+<a name="getParentProject(org.apache.maven.project.MavenProject, java.util.List, org.apache.maven.artifact.repository.ArtifactRepository)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getParentProject</h4>
+<pre><a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> getParentProject(<a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> aProject,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a>> reactorProjects,
+ <a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a> localRepository)</pre>
+<div class="block">Returns the parent POM with interpolated URLs. Attempts to source this value from the
+ <code>reactorProjects</code> parameters if available (reactor env model attributes
+ are interpolated), or if the reactor is unavailable (-N) resorts to the
+ <code>project.getParent().getUrl()</code> value which will NOT have been interpolated.
+ <p/>
+ TODO: once bug is fixed in Maven proper, remove this.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>aProject</code> - a Maven project, not null.</dd><dd><code>reactorProjects</code> - the Maven reactor projects, not null.</dd><dd><code>localRepository</code> - the Maven local repository, not null.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the parent project with interpolated URLs.</dd></dl>
+</li>
+</ul>
+<a name="populateParentMenu(org.apache.maven.doxia.site.decoration.DecorationModel, java.util.Locale, org.apache.maven.project.MavenProject, org.apache.maven.project.MavenProject, boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>populateParentMenu</h4>
+<pre>void populateParentMenu(<a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html?is-external=true" title="class or interface in org.apache.maven.doxia.site.decoration">DecorationModel</a> decorationModel,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale,
+ <a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> project,
+ <a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> parentProject,
+ boolean keepInheritedRefs)</pre>
+<div class="block">Populate the parent menu part of the decoration model.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>decorationModel</code> - the Doxia DecorationModel, not null.</dd><dd><code>locale</code> - the locale used for the i18n in DecorationModel. If null, using the default locale in the jvm.</dd><dd><code>project</code> - a Maven project, not null.</dd><dd><code>parentProject</code> - a Maven parent project, not null.</dd><dd><code>keepInheritedRefs</code> - used for inherited references.</dd></dl>
+</li>
+</ul>
+<a name="populateProjectParentMenu(org.apache.maven.doxia.site.decoration.DecorationModel, java.util.Locale, org.apache.maven.project.MavenProject, org.apache.maven.project.MavenProject, boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>populateProjectParentMenu</h4>
+<pre>void populateProjectParentMenu(<a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html?is-external=true" title="class or interface in org.apache.maven.doxia.site.decoration">DecorationModel</a> decorationModel,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale,
+ <a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> project,
+ <a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> parentProject,
+ boolean keepInheritedRefs)</pre>
+<div class="block"><span class="strong">Deprecated.</span> <i>Please use
+ <a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#populateParentMenu(org.apache.maven.doxia.site.decoration.DecorationModel, java.util.Locale, org.apache.maven.project.MavenProject, org.apache.maven.project.MavenProject, boolean)"><code>populateParentMenu(DecorationModel, Locale, MavenProject, MavenProject, boolean)</code></a> instead</i></div>
+<div class="block">Populate the parent menu part of the decoration model.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>decorationModel</code> - the Doxia DecorationModel, not null.</dd><dd><code>locale</code> - the locale used for the i18n in DecorationModel. If null, using the default locale in the jvm.</dd><dd><code>project</code> - a Maven project, not null.</dd><dd><code>parentProject</code> - a Maven parent project, not null.</dd><dd><code>keepInheritedRefs</code> - used for inherited references.</dd></dl>
+</li>
+</ul>
+<a name="populateModules(org.apache.maven.project.MavenProject, java.util.List, org.apache.maven.artifact.repository.ArtifactRepository, org.apache.maven.doxia.site.decoration.DecorationModel, java.util.Locale, boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>populateModules</h4>
+<pre>void populateModules(<a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> project,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a>> reactorProjects,
+ <a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a> localRepository,
+ <a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html?is-external=true" title="class or interface in org.apache.maven.doxia.site.decoration">DecorationModel</a> decorationModel,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale,
+ boolean keepInheritedRefs)
+ throws <a href="../../../../../org/apache/maven/doxia/tools/SiteToolException.html" title="class in org.apache.maven.doxia.tools">SiteToolException</a></pre>
+<div class="block"><span class="strong">Deprecated.</span> <i>Please use
+ <a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#populateModulesMenu(org.apache.maven.project.MavenProject, java.util.List, org.apache.maven.artifact.repository.ArtifactRepository, org.apache.maven.doxia.site.decoration.DecorationModel, java.util.Locale, boolean)"><code>populateModulesMenu(MavenProject, List, ArtifactRepository, DecorationModel, Locale, boolean)</code></a>
+ instead</i></div>
+<div class="block">Populate the modules menu part of the decoration model.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>project</code> - a Maven project, not null.</dd><dd><code>reactorProjects</code> - the Maven reactor projects, not null.</dd><dd><code>localRepository</code> - the Maven local repository, not null.</dd><dd><code>decorationModel</code> - the Doxia site descriptor model, not null.</dd><dd><code>locale</code> - the locale used for the i18n in DecorationModel. If null, using the default locale in the jvm.</dd><dd><code>keepInheritedRefs</code> - used for inherited references.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../../org/apache/maven/doxia/tools/SiteToolException.html" title="class in org.apache.maven.doxia.tools">SiteToolException</a></code> - if any</dd></dl>
+</li>
+</ul>
+<a name="populateModulesMenu(org.apache.maven.project.MavenProject, java.util.List, org.apache.maven.artifact.repository.ArtifactRepository, org.apache.maven.doxia.site.decoration.DecorationModel, java.util.Locale, boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>populateModulesMenu</h4>
+<pre>void populateModulesMenu(<a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> project,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-project/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a>> reactorProjects,
+ <a href="http://maven.apache.org/maven-artifact/apidocs/org/apache/maven/artifact/repository/ArtifactRepository.html?is-external=true" title="class or interface in org.apache.maven.artifact.repository">ArtifactRepository</a> localRepository,
+ <a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html?is-external=true" title="class or interface in org.apache.maven.doxia.site.decoration">DecorationModel</a> decorationModel,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale,
+ boolean keepInheritedRefs)
+ throws <a href="../../../../../org/apache/maven/doxia/tools/SiteToolException.html" title="class in org.apache.maven.doxia.tools">SiteToolException</a></pre>
+<div class="block">Populate the modules menu part of the decoration model.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>project</code> - a Maven project, not null.</dd><dd><code>reactorProjects</code> - the Maven reactor projects, not null.</dd><dd><code>localRepository</code> - the Maven local repository, not null.</dd><dd><code>decorationModel</code> - the Doxia site descriptor model, not null.</dd><dd><code>locale</code> - the locale used for the i18n in DecorationModel. If null, using the default locale in the jvm.</dd><dd><code>keepInheritedRefs</code> - used for inherited references.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../../org/apache/maven/doxia/tools/SiteToolException.html" title="class in org.apache.maven.doxia.tools">SiteToolException</a></code> - if any</dd></dl>
+</li>
+</ul>
+<a name="getAvailableLocales(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getAvailableLocales</h4>
+<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>> getAvailableLocales(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> locales)</pre>
+<div class="block">Init the <code>localesList</code> variable.
+ <p>If the <code>locales</code> variable is available, the first valid token will be the
+ <code>defaultLocale</code> for this instance of the Java Virtual Machine.</p></div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locales</code> - A comma separated list of locales supported by Maven. The first valid token will be the
+ default Locale for this instance of the Java Virtual Machine.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>a list of <code>Locale</code></dd></dl>
+</li>
+</ul>
+<a name="codeToLocale(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>codeToLocale</h4>
+<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> codeToLocale(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> localeCode)</pre>
+<div class="block">Converts a locale code like "en", "en_US" or "en_US_win" to a <code>java.util.Locale</code>
+ object.
+ <p>If localeCode = <code>default</code>, return the current value of the default locale for this instance
+ of the Java Virtual Machine.</p></div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>localeCode</code> - the locale code string.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>a java.util.Locale object instanced or null if errors occurred</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Locale.html">java.util.Locale#getDefault()</a></dd></dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar_bottom">
+<!-- -->
+</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../org/apache/maven/doxia/tools/package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/SiteTool.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../org/apache/maven/doxia/tools/ReportComparator.html" title="class in org.apache.maven.doxia.tools"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/maven/doxia/tools/SiteToolException.html" title="class in org.apache.maven.doxia.tools"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/maven/doxia/tools/SiteTool.html" target="_top">Frames</a></li>
+<li><a href="SiteTool.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#field_summary">Field</a> | </li>
+<li>Constr | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field_detail">Field</a> | </li>
+<li>Constr | </li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<p class="legalCopy"><small>Copyright © 2005–2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
+</body>
+</html>
\ No newline at end of file
Propchange: websites/production/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/apidocs/org/apache/maven/doxia/tools/SiteTool.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/apidocs/org/apache/maven/doxia/tools/SiteTool.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: websites/production/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/apidocs/org/apache/maven/doxia/tools/SiteToolException.html
==============================================================================
--- websites/production/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/apidocs/org/apache/maven/doxia/tools/SiteToolException.html (added)
+++ websites/production/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/apidocs/org/apache/maven/doxia/tools/SiteToolException.html Mon Jun 30 19:16:43 2014
@@ -0,0 +1,297 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="fr">
+<head>
+<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
+<title>SiteToolException (Doxia :: Integration Tools 1.6-SNAPSHOT API)</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="SiteToolException (Doxia :: Integration Tools 1.6-SNAPSHOT API)";
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar_top">
+<!-- -->
+</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../org/apache/maven/doxia/tools/package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/SiteToolException.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html" title="interface in org.apache.maven.doxia.tools"><span class="strong">Prev Class</span></a></li>
+<li>Next Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/maven/doxia/tools/SiteToolException.html" target="_top">Frames</a></li>
+<li><a href="SiteToolException.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li>Field | </li>
+<li><a href="#constructor_summary">Constr</a> | </li>
+<li><a href="#methods_inherited_from_class_java.lang.Throwable">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#constructor_detail">Constr</a> | </li>
+<li>Method</li>
+</ul>
+</div>
+<a name="skip-navbar_top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.maven.doxia.tools</div>
+<h2 title="Class SiteToolException" class="title">Class SiteToolException</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
+<li>
+<ul class="inheritance">
+<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li>
+<li>
+<ul class="inheritance">
+<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li>
+<li>
+<ul class="inheritance">
+<li>org.apache.maven.doxia.tools.SiteToolException</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="strong">SiteToolException</span>
+extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">An exception occurring during the execution of this tool.</div>
+<dl><dt><span class="strong">Version:</span></dt>
+ <dd>$Id$</dd>
+<dt><span class="strong">Author:</span></dt>
+ <dd><a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a></dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.maven.doxia.tools.SiteToolException">Serialized Form</a></dd></dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteToolException.html#SiteToolException(java.lang.String)">SiteToolException</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message)</code>
+<div class="block">Construct a new <code>SiteToolException</code> exception providing a <code>message</code>.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteToolException.html#SiteToolException(java.lang.String, java.lang.Exception)">SiteToolException</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a> cause)</code>
+<div class="block">Construct a new <code>SiteToolException</code> exception wrapping an underlying <code>Exception</code>
+ and providing a <code>message</code>.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../../../org/apache/maven/doxia/tools/SiteToolException.html#SiteToolException(java.lang.String, java.lang.Throwable)">SiteToolException</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> cause)</code>
+<div class="block">Construct a new <code>SiteToolException</code> exception wrapping an underlying <code>Throwable</code>
+ and providing a <code>message</code>.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3>
+<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed(java.lang.Throwable)" title="class or interface in java.lang">addSuppressed</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace()" title="class or interface in java.lang">fillInStackTrace</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#getCause()" title="class or interface in java.lang">getCause</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage()" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#getMessage()" title="class or interface in java.lang">getMessage</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace(
)" title="class or interface in java.lang">getStackTrace</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed()" title="class or interface in java.lang">getSuppressed</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#initCause(java.lang.Throwable)" title="class or interface in java.lang">initCause</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace()" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace(java.io.PrintStream)" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace(java.io.PrintWriter)" title="class or interface in java.lang">printStackTrace</a>, <a href="http:
//docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace(java.lang.StackTraceElement[])" title="class or interface in java.lang">setStackTrace</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
+<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/jav
ase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="SiteToolException(java.lang.String, java.lang.Exception)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>SiteToolException</h4>
+<pre>public SiteToolException(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a> cause)</pre>
+<div class="block">Construct a new <code>SiteToolException</code> exception wrapping an underlying <code>Exception</code>
+ and providing a <code>message</code>.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - could be null</dd><dd><code>cause</code> - could be null</dd></dl>
+</li>
+</ul>
+<a name="SiteToolException(java.lang.String, java.lang.Throwable)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>SiteToolException</h4>
+<pre>public SiteToolException(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message,
+ <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> cause)</pre>
+<div class="block">Construct a new <code>SiteToolException</code> exception wrapping an underlying <code>Throwable</code>
+ and providing a <code>message</code>.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - could be null</dd><dd><code>cause</code> - could be null</dd></dl>
+</li>
+</ul>
+<a name="SiteToolException(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>SiteToolException</h4>
+<pre>public SiteToolException(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message)</pre>
+<div class="block">Construct a new <code>SiteToolException</code> exception providing a <code>message</code>.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - could be null</dd></dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar_bottom">
+<!-- -->
+</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../org/apache/maven/doxia/tools/package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/SiteToolException.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html" title="interface in org.apache.maven.doxia.tools"><span class="strong">Prev Class</span></a></li>
+<li>Next Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/maven/doxia/tools/SiteToolException.html" target="_top">Frames</a></li>
+<li><a href="SiteToolException.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li>Field | </li>
+<li><a href="#constructor_summary">Constr</a> | </li>
+<li><a href="#methods_inherited_from_class_java.lang.Throwable">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#constructor_detail">Constr</a> | </li>
+<li>Method</li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<p class="legalCopy"><small>Copyright © 2005–2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
+</body>
+</html>
\ No newline at end of file
Propchange: websites/production/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/apidocs/org/apache/maven/doxia/tools/SiteToolException.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: websites/production/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/maven-doxia/content/doxia-tools-archives/doxia-integration-tools-LATEST/apidocs/org/apache/maven/doxia/tools/SiteToolException.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision