Modified:
maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/org/apache/maven/doxia/tools/ReportComparator.html
==============================================================================
---
maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/org/apache/maven/doxia/tools/ReportComparator.html
(original)
+++
maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/org/apache/maven/doxia/tools/ReportComparator.html
Thu Feb 17 14:02:12 2022
@@ -30,43 +30,40 @@
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong
class="jxr_keyword">import</strong> java.text.Collator;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong
class="jxr_keyword">import</strong> java.util.Comparator;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong
class="jxr_keyword">import</strong> java.util.Locale;
-<a class="jxr_linenumber" name="L25" href="#L25">25</a>
-<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReport;
-<a class="jxr_linenumber" name="L27" href="#L27">27</a>
-<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em
class="jxr_javadoccomment"> * Sorts reports.</em>
-<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em
class="jxr_javadoccomment"> * @author <a href="<a
href="mailto:[email protected]";
target="alexandria_uri">mailto:[email protected]</a>">Brett
Porter</a></em>
-<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em
class="jxr_javadoccomment"> * TODO move to reporting API?</em>
-<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em
class="jxr_javadoccomment"> * TODO allow reports to define their order in some
other way?</em>
-<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong>
<a
href="../../../../../org/apache/maven/doxia/tools/ReportComparator.html">ReportComparator</a>
-<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong
class="jxr_keyword">implements</strong> Comparator<MavenReport>
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> {
-<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em
class="jxr_javadoccomment">/** the local */</em>
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
Locale locale;
-<a class="jxr_linenumber" name="L40" href="#L40">40</a>
-<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em
class="jxr_javadoccomment"> * Default constructor.</em>
-<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em
class="jxr_javadoccomment"> * @param locale not null</em>
-<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong
class="jxr_keyword">public</strong> <a
href="../../../../../org/apache/maven/doxia/tools/ReportComparator.html">ReportComparator</a>(
Locale locale )
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> {
-<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong
class="jxr_keyword">if</strong> ( locale == <strong
class="jxr_keyword">null</strong> )
-<a class="jxr_linenumber" name="L49" href="#L49">49</a> {
-<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
IllegalArgumentException( <span class="jxr_string">"locale should be
defined"</span> );
-<a class="jxr_linenumber" name="L51" href="#L51">51</a> }
-<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong
class="jxr_keyword">this</strong>.locale = locale;
-<a class="jxr_linenumber" name="L53" href="#L53">53</a> }
-<a class="jxr_linenumber" name="L54" href="#L54">54</a>
-<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em
class="jxr_javadoccomment">/** {@inheritDoc} */</em>
-<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong>
compare( MavenReport r1, MavenReport r2 )
-<a class="jxr_linenumber" name="L57" href="#L57">57</a> {
-<a class="jxr_linenumber" name="L58" href="#L58">58</a> Collator
collator = Collator.getInstance( locale );
-<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong
class="jxr_keyword">return</strong> collator.compare( r1.getName( locale ),
r2.getName( locale ) );
-<a class="jxr_linenumber" name="L60" href="#L60">60</a> }
-<a class="jxr_linenumber" name="L61" href="#L61">61</a> }
+<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong
class="jxr_keyword">import</strong> java.util.Objects;
+<a class="jxr_linenumber" name="L26" href="#L26">26</a>
+<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.reporting.MavenReport;
+<a class="jxr_linenumber" name="L28" href="#L28">28</a>
+<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em
class="jxr_javadoccomment"> * Sorts reports.</em>
+<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em
class="jxr_javadoccomment"> * @author <a href="<a
href="mailto:[email protected]";
target="alexandria_uri">mailto:[email protected]</a>">Brett
Porter</a></em>
+<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em
class="jxr_javadoccomment"> * TODO move to reporting API?</em>
+<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em
class="jxr_javadoccomment"> * TODO allow reports to define their order in some
other way?</em>
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong>
<a
href="../../../../../org/apache/maven/doxia/tools/ReportComparator.html">ReportComparator</a>
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong
class="jxr_keyword">implements</strong> Comparator<MavenReport>
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> {
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em
class="jxr_javadoccomment">/** the local */</em>
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
Locale locale;
+<a class="jxr_linenumber" name="L41" href="#L41">41</a>
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em
class="jxr_javadoccomment"> * Default constructor.</em>
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em
class="jxr_javadoccomment"> * @param locale not null</em>
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong
class="jxr_keyword">public</strong> <a
href="../../../../../org/apache/maven/doxia/tools/ReportComparator.html">ReportComparator</a>(
Locale locale )
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> {
+<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong
class="jxr_keyword">this</strong>.locale = Objects.requireNonNull( locale,
<span class="jxr_string">"locale cannot be null"</span> );
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> }
+<a class="jxr_linenumber" name="L51" href="#L51">51</a>
+<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em
class="jxr_javadoccomment">/** {@inheritDoc} */</em>
+<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong>
compare( MavenReport r1, MavenReport r2 )
+<a class="jxr_linenumber" name="L54" href="#L54">54</a> {
+<a class="jxr_linenumber" name="L55" href="#L55">55</a> Collator
collator = Collator.getInstance( locale );
+<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong
class="jxr_keyword">return</strong> collator.compare( r1.getName( locale ),
r2.getName( locale ) );
+<a class="jxr_linenumber" name="L57" href="#L57">57</a> }
+<a class="jxr_linenumber" name="L58" href="#L58">58</a> }
</pre>
<hr/>
<div id="footer">Copyright © 2005–2022 <a
href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights
reserved.</div>
Modified:
maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/org/apache/maven/doxia/tools/SiteTool.html
==============================================================================
---
maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/org/apache/maven/doxia/tools/SiteTool.html
(original)
+++
maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/org/apache/maven/doxia/tools/SiteTool.html
Thu Feb 17 14:02:12 2022
@@ -46,172 +46,169 @@
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em
class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong
class="jxr_keyword">public</strong> <strong
class="jxr_keyword">interface</strong> <a
href="../../../../../org/apache/maven/doxia/tools/SiteTool.html">SiteTool</a>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> {
-<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em
class="jxr_javadoccomment">/** Plexus Role */</em>
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> String ROLE =
SiteTool.<strong class="jxr_keyword">class</strong>.getName();
-<a class="jxr_linenumber" name="L43" href="#L43">43</a>
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em
class="jxr_javadoccomment"> * The locale by default for a Maven Site</em>
-<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em
class="jxr_javadoccomment"> * @see Locale#ENGLISH</em>
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L48" href="#L48">48</a> Locale
DEFAULT_LOCALE = Locale.ENGLISH;
-<a class="jxr_linenumber" name="L49" href="#L49">49</a>
-<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em
class="jxr_javadoccomment"> * Get a skin artifact from one of the
repositories.</em>
-<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em
class="jxr_javadoccomment"> * @param localRepository the Maven local
repository, not null.</em>
-<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em
class="jxr_javadoccomment"> * @param remoteArtifactRepositories the Maven
remote repositories, not null.</em>
-<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em
class="jxr_javadoccomment"> * @param decoration the Doxia site descriptor
model, not null.</em>
-<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em
class="jxr_javadoccomment"> * @return the <code>Skin</code>
artifact defined in a <code>DecorationModel</code> from a given
project and a</em>
-<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em
class="jxr_javadoccomment"> * local repository</em>
-<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em
class="jxr_javadoccomment"> * @throws SiteToolException if any</em>
-<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L60" href="#L60">60</a> Artifact
getSkinArtifactFromRepository( ArtifactRepository localRepository,
-<a class="jxr_linenumber" name="L61" href="#L61">61</a>
List<ArtifactRepository> remoteArtifactRepositories,
-<a class="jxr_linenumber" name="L62" href="#L62">62</a>
<a
href="../../../../../org/apache/maven/doxia/site/decoration/DecorationModel.html">DecorationModel</a>
decoration )
-<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong
class="jxr_keyword">throws</strong> SiteToolException;
-<a class="jxr_linenumber" name="L64" href="#L64">64</a>
-<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em
class="jxr_javadoccomment"> * Get the default skin artifact for a project
from one of the repositories.</em>
-<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em
class="jxr_javadoccomment"> * @param localRepository the Maven local
repository, not null.</em>
-<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em
class="jxr_javadoccomment"> * @param remoteArtifactRepositories the Maven
remote repositories, not null.</em>
-<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em
class="jxr_javadoccomment"> * @return the default
<code>Skin</code> artifact from a given project and a local
repository</em>
-<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em
class="jxr_javadoccomment"> * @throws SiteToolException if any</em>
-<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em
class="jxr_javadoccomment"> * @see
org.apache.maven.doxia.site.decoration.Skin#getDefaultSkin()</em>
-<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em
class="jxr_javadoccomment"> * @see
#getSkinArtifactFromRepository(ArtifactRepository, List, DecorationModel)</em>
-<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L75" href="#L75">75</a> Artifact
getDefaultSkinArtifact( ArtifactRepository localRepository,
-<a class="jxr_linenumber" name="L76" href="#L76">76</a>
List<ArtifactRepository> remoteArtifactRepositories )
-<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong
class="jxr_keyword">throws</strong> SiteToolException;
-<a class="jxr_linenumber" name="L78" href="#L78">78</a>
-<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em
class="jxr_javadoccomment"> * Get a site descriptor from the project's site
directory.</em>
-<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em
class="jxr_javadoccomment"> * @param siteDirectory the site directory, not
null</em>
-<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em
class="jxr_javadoccomment"> * @param locale the locale wanted for the site
descriptor. If not null, searching for</em>
-<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em
class="jxr_javadoccomment"> *
<code>site_<i>localeLanguage</i>.xml</code>, otherwise
searching for <code>site.xml</code>.</em>
-<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em
class="jxr_javadoccomment"> * @return the site descriptor file</em>
-<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em
class="jxr_javadoccomment"> */</em> <em class="jxr_comment">// used by
maven-pdf-plugin (should not?)</em>
-<a class="jxr_linenumber" name="L87" href="#L87">87</a> File
getSiteDescriptor( File siteDirectory, Locale locale );
-<a class="jxr_linenumber" name="L88" href="#L88">88</a>
-<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em
class="jxr_javadoccomment"> * Interpolating several expressions in the site
descriptor content. Actually, the expressions can be in</em>
-<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em
class="jxr_javadoccomment"> * the project, the environment variables and
the specific properties like <code>encoding</code>.</em>
-<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em
class="jxr_javadoccomment"> * For instance:</em>
-<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em
class="jxr_javadoccomment"> * <dl></em>
-<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em
class="jxr_javadoccomment"> * <dt>${project.name}</dt></em>
-<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em
class="jxr_javadoccomment"> * <dd>The value from the POM of:</em>
-<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em
class="jxr_javadoccomment"> * &lt;project&gt;<br></em>
-<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em
class="jxr_javadoccomment"> *
&nbsp;&nbsp;&lt;name&gt;myProjectName&lt;/name&gt;<br></em>
-<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em
class="jxr_javadoccomment"> * &lt;/project&gt;</em>
-<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em
class="jxr_javadoccomment"> * </p></dd></em>
-<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em
class="jxr_javadoccomment"> * <dt>${my.value}</dt></em>
-<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em
class="jxr_javadoccomment"> * <dd>The value from the POM of:</em>
-<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em
class="jxr_javadoccomment"> * &lt;properties&gt;<br></em>
-<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em
class="jxr_javadoccomment"> *
&nbsp;&nbsp;&lt;my.value&gt;hello&lt;/my.value&gt;<br></em>
-<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em
class="jxr_javadoccomment"> * &lt;/properties&gt;</em>
-<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em
class="jxr_javadoccomment"> * </p></dd></em>
-<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em
class="jxr_javadoccomment"> * <dt>${JAVA_HOME}</dt></em>
-<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em
class="jxr_javadoccomment"> * <dd>The value of JAVA_HOME in the
environment variables</dd></em>
-<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em
class="jxr_javadoccomment"> * </dl></em>
-<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em
class="jxr_javadoccomment"> * @param props a map used for interpolation,
not null.</em>
-<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em
class="jxr_javadoccomment"> * @param aProject a Maven project, not
null.</em>
-<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em
class="jxr_javadoccomment"> * @param siteDescriptorContent the site
descriptor file, not null.</em>
-<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em
class="jxr_javadoccomment"> * @return the interpolated site descriptor
content.</em>
-<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em
class="jxr_javadoccomment"> * @throws SiteToolException if errors happened
during the interpolation.</em>
-<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em
class="jxr_javadoccomment"> */</em> <em class="jxr_comment">// used by
maven-pdf-plugin (should not?)</em>
-<a class="jxr_linenumber" name="L119" href="#L119">119</a> String
getInterpolatedSiteDescriptorContent( Map<String, String> props,
MavenProject aProject,
-<a class="jxr_linenumber" name="L120" href="#L120">120</a>
String siteDescriptorContent )
-<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong
class="jxr_keyword">throws</strong> SiteToolException;
-<a class="jxr_linenumber" name="L122" href="#L122">122</a>
-<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em
class="jxr_javadoccomment"> * Get a decoration model for a project.</em>
-<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em
class="jxr_javadoccomment"> * @param siteDirectory the site directory, may
be null if project from repository</em>
-<a class="jxr_linenumber" name="L127" href="#L127">127</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="L128" href="#L128">128</a> <em
class="jxr_javadoccomment"> * @param project the Maven project, not
null.</em>
-<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em
class="jxr_javadoccomment"> * @param reactorProjects the Maven reactor
projects, not null.</em>
-<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em
class="jxr_javadoccomment"> * @param localRepository the Maven local
repository, not null.</em>
-<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em
class="jxr_javadoccomment"> * @param repositories the Maven remote
repositories, not null.</em>
-<a class="jxr_linenumber" name="L132" href="#L132">132</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="L133" href="#L133">133</a> <em
class="jxr_javadoccomment"> * interpolations.</em>
-<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em
class="jxr_javadoccomment"> * @throws SiteToolException if any</em>
-<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em
class="jxr_javadoccomment"> * @since 1.7, was previously with other
parameter types and order</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"> * @since 1.7, was previously
getAvailableLocales(String)</em>
-<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L165" href="#L165">165</a>
List<Locale> getSiteLocales( String locales );
-<a class="jxr_linenumber" name="L166" href="#L166">166</a>
-<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em
class="jxr_javadoccomment"> * Calculate the relative path between two URLs
or between two files.</em>
-<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em
class="jxr_javadoccomment"> * For example:</em>
-<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em
class="jxr_javadoccomment"> * <dl></em>
-<a class="jxr_linenumber" name="L172" href="#L172">172</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="L173" href="#L173">173</a> <em
class="jxr_javadoccomment"> * <dd>return ""</dd></em>
-<a class="jxr_linenumber" name="L174" href="#L174">174</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="L175" href="#L175">175</a> <em
class="jxr_javadoccomment"> * <dd>return "../.."</dd></em>
-<a class="jxr_linenumber" name="L176" href="#L176">176</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="L177" href="#L177">177</a> <em
class="jxr_javadoccomment"> * <dd>return
"plugins/maven-site-plugin"</dd></em>
-<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em
class="jxr_javadoccomment"> * <dt>to = "/myproject/myproject-module1"
and from = "/myproject/myproject"</dt></em>
-<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em
class="jxr_javadoccomment"> * <dd>return
"../myproject-module1"</dd></em>
-<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em
class="jxr_javadoccomment"> * </dl></em>
-<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em
class="jxr_javadoccomment"> * <b>Note</b>: The file separator
depends on the system.</em>
-<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em
class="jxr_javadoccomment"> * Maven-specific urls are supported, like
<code>dav:https://dav.codehaus.org/</code> or</em>
-<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em
class="jxr_javadoccomment"> *
<code>scm:svn:https://svn.apache.org/repos/asf</code>.</em>
-<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em
class="jxr_javadoccomment"> * @param to the <code>to</code> url
of file as string</em>
-<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em
class="jxr_javadoccomment"> * @param from the <code>from</code>
url of file as string</em>
-<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em
class="jxr_javadoccomment"> * @return a relative path from
<code>from</code> to <code>to</code>.</em>
-<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> String
getRelativePath( String to, String from );
-<a class="jxr_linenumber" name="L190" href="#L190">190</a>
-<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em
class="jxr_javadoccomment"> * Returns the parent POM with interpolated
URLs.</em>
-<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em
class="jxr_javadoccomment"> * If called from Maven 3, just returns
<code>project.getParent()</code>, which is already</em>
-<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em
class="jxr_javadoccomment"> * interpolated. But when called from Maven 2,
attempts to source this value from the</em>
-<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em
class="jxr_javadoccomment"> * <code>reactorProjects</code>
parameters if available (reactor env model attributes</em>
-<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em
class="jxr_javadoccomment"> * are interpolated), or if the reactor is
unavailable (-N) resorts to the</em>
-<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em
class="jxr_javadoccomment"> *
<code>project.getParent().getUrl()</code> value which will NOT have
been interpolated.</em>
-<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em
class="jxr_javadoccomment"> * @param aProject a Maven project, not
null.</em>
-<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em
class="jxr_javadoccomment"> * @param reactorProjects the Maven reactor
projects, not null.</em>
-<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em
class="jxr_javadoccomment"> * @param localRepository the Maven local
repository, not null.</em>
-<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em
class="jxr_javadoccomment"> * @return the parent project with interpolated
URLs.</em>
-<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L204" href="#L204">204</a> MavenProject
getParentProject( MavenProject aProject, List<MavenProject>
reactorProjects,
-<a class="jxr_linenumber" name="L205" href="#L205">205</a>
ArtifactRepository localRepository );
-<a class="jxr_linenumber" name="L206" href="#L206">206</a> }
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em
class="jxr_javadoccomment"> * The locale by default for a Maven Site</em>
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em
class="jxr_javadoccomment"> * @see Locale#ENGLISH</em>
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L45" href="#L45">45</a> Locale
DEFAULT_LOCALE = Locale.ENGLISH;
+<a class="jxr_linenumber" name="L46" href="#L46">46</a>
+<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em
class="jxr_javadoccomment"> * Get a skin artifact from one of the
repositories.</em>
+<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em
class="jxr_javadoccomment"> * @param localRepository the Maven local
repository, not null.</em>
+<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em
class="jxr_javadoccomment"> * @param remoteArtifactRepositories the Maven
remote repositories, not null.</em>
+<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em
class="jxr_javadoccomment"> * @param decoration the Doxia site descriptor
model, not null.</em>
+<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em
class="jxr_javadoccomment"> * @return the <code>Skin</code>
artifact defined in a <code>DecorationModel</code> from a given
project and a</em>
+<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em
class="jxr_javadoccomment"> * local repository</em>
+<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em
class="jxr_javadoccomment"> * @throws SiteToolException if any</em>
+<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L57" href="#L57">57</a> Artifact
getSkinArtifactFromRepository( ArtifactRepository localRepository,
+<a class="jxr_linenumber" name="L58" href="#L58">58</a>
List<ArtifactRepository> remoteArtifactRepositories,
+<a class="jxr_linenumber" name="L59" href="#L59">59</a>
<a
href="../../../../../org/apache/maven/doxia/site/decoration/DecorationModel.html">DecorationModel</a>
decoration )
+<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong
class="jxr_keyword">throws</strong> SiteToolException;
+<a class="jxr_linenumber" name="L61" href="#L61">61</a>
+<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em
class="jxr_javadoccomment"> * Get the default skin artifact for a project
from one of the repositories.</em>
+<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em
class="jxr_javadoccomment"> * @param localRepository the Maven local
repository, not null.</em>
+<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em
class="jxr_javadoccomment"> * @param remoteArtifactRepositories the Maven
remote repositories, not null.</em>
+<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em
class="jxr_javadoccomment"> * @return the default
<code>Skin</code> artifact from a given project and a local
repository</em>
+<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em
class="jxr_javadoccomment"> * @throws SiteToolException if any</em>
+<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em
class="jxr_javadoccomment"> * @see
org.apache.maven.doxia.site.decoration.Skin#getDefaultSkin()</em>
+<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em
class="jxr_javadoccomment"> * @see
#getSkinArtifactFromRepository(ArtifactRepository, List, DecorationModel)</em>
+<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L72" href="#L72">72</a> Artifact
getDefaultSkinArtifact( ArtifactRepository localRepository,
+<a class="jxr_linenumber" name="L73" href="#L73">73</a>
List<ArtifactRepository> remoteArtifactRepositories )
+<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong
class="jxr_keyword">throws</strong> SiteToolException;
+<a class="jxr_linenumber" name="L75" href="#L75">75</a>
+<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em
class="jxr_javadoccomment"> * Get a site descriptor from the project's site
directory.</em>
+<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em
class="jxr_javadoccomment"> * @param siteDirectory the site directory, not
null</em>
+<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em
class="jxr_javadoccomment"> * @param locale the locale wanted for the site
descriptor. If not null, searching for</em>
+<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em
class="jxr_javadoccomment"> *
<code>site_<i>localeLanguage</i>.xml</code>, otherwise
searching for <code>site.xml</code>.</em>
+<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em
class="jxr_javadoccomment"> * @return the site descriptor file</em>
+<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em
class="jxr_javadoccomment"> */</em> <em class="jxr_comment">// used by
maven-pdf-plugin (should not?)</em>
+<a class="jxr_linenumber" name="L84" href="#L84">84</a> File
getSiteDescriptor( File siteDirectory, Locale locale );
+<a class="jxr_linenumber" name="L85" href="#L85">85</a>
+<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em
class="jxr_javadoccomment"> * Interpolating several expressions in the site
descriptor content. Actually, the expressions can be in</em>
+<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em
class="jxr_javadoccomment"> * the project, the environment variables and
the specific properties like <code>encoding</code>.</em>
+<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em
class="jxr_javadoccomment"> * For instance:</em>
+<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em
class="jxr_javadoccomment"> * <dl></em>
+<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em
class="jxr_javadoccomment"> * <dt>${project.name}</dt></em>
+<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em
class="jxr_javadoccomment"> * <dd>The value from the POM of:</em>
+<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em
class="jxr_javadoccomment"> * &lt;project&gt;<br></em>
+<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em
class="jxr_javadoccomment"> *
&nbsp;&nbsp;&lt;name&gt;myProjectName&lt;/name&gt;<br></em>
+<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em
class="jxr_javadoccomment"> * &lt;/project&gt;</em>
+<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em
class="jxr_javadoccomment"> * </p></dd></em>
+<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em
class="jxr_javadoccomment"> * <dt>${my.value}</dt></em>
+<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em
class="jxr_javadoccomment"> * <dd>The value from the POM of:</em>
+<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em
class="jxr_javadoccomment"> * &lt;properties&gt;<br></em>
+<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em
class="jxr_javadoccomment"> *
&nbsp;&nbsp;&lt;my.value&gt;hello&lt;/my.value&gt;<br></em>
+<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em
class="jxr_javadoccomment"> * &lt;/properties&gt;</em>
+<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em
class="jxr_javadoccomment"> * </p></dd></em>
+<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em
class="jxr_javadoccomment"> * <dt>${JAVA_HOME}</dt></em>
+<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em
class="jxr_javadoccomment"> * <dd>The value of JAVA_HOME in the
environment variables</dd></em>
+<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em
class="jxr_javadoccomment"> * </dl></em>
+<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em
class="jxr_javadoccomment"> * @param props a map used for interpolation,
not null.</em>
+<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em
class="jxr_javadoccomment"> * @param aProject a Maven project, not
null.</em>
+<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em
class="jxr_javadoccomment"> * @param siteDescriptorContent the site
descriptor file, not null.</em>
+<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em
class="jxr_javadoccomment"> * @return the interpolated site descriptor
content.</em>
+<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em
class="jxr_javadoccomment"> * @throws SiteToolException if errors happened
during the interpolation.</em>
+<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em
class="jxr_javadoccomment"> */</em> <em class="jxr_comment">// used by
maven-pdf-plugin (should not?)</em>
+<a class="jxr_linenumber" name="L116" href="#L116">116</a> String
getInterpolatedSiteDescriptorContent( Map<String, String> props,
MavenProject aProject,
+<a class="jxr_linenumber" name="L117" href="#L117">117</a>
String siteDescriptorContent )
+<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong
class="jxr_keyword">throws</strong> SiteToolException;
+<a class="jxr_linenumber" name="L119" href="#L119">119</a>
+<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em
class="jxr_javadoccomment"> * Get a decoration model for a project.</em>
+<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em
class="jxr_javadoccomment"> * @param siteDirectory the site directory, may
be null if project from repository</em>
+<a class="jxr_linenumber" name="L124" href="#L124">124</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="L125" href="#L125">125</a> <em
class="jxr_javadoccomment"> * @param project the Maven project, not
null.</em>
+<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em
class="jxr_javadoccomment"> * @param reactorProjects the Maven reactor
projects, not null.</em>
+<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em
class="jxr_javadoccomment"> * @param localRepository the Maven local
repository, not null.</em>
+<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em
class="jxr_javadoccomment"> * @param repositories the Maven remote
repositories, not null.</em>
+<a class="jxr_linenumber" name="L129" href="#L129">129</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="L130" href="#L130">130</a> <em
class="jxr_javadoccomment"> * interpolations.</em>
+<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em
class="jxr_javadoccomment"> * @throws SiteToolException if any</em>
+<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em
class="jxr_javadoccomment"> * @since 1.7, was previously with other
parameter types and order</em>
+<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L134" href="#L134">134</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="L135" href="#L135">135</a>
List<MavenProject> reactorProjects,
ArtifactRepository localRepository,
+<a class="jxr_linenumber" name="L136" href="#L136">136</a>
List<ArtifactRepository> repositories )
+<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong
class="jxr_keyword">throws</strong> SiteToolException;
+<a class="jxr_linenumber" name="L138" href="#L138">138</a>
+<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em
class="jxr_javadoccomment"> * Populate the pre-defined
<code>reports</code> menu of the decoration model,</em>
+<a class="jxr_linenumber" name="L141" href="#L141">141</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="L142" href="#L142">142</a> <em
class="jxr_javadoccomment"> * 2 separate menus: "Project Information" and
"Project Reports".</em>
+<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"> * @param decorationModel the Doxia Sitetools
DecorationModel, not null.</em>
+<a class="jxr_linenumber" name="L145" href="#L145">145</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="L146" href="#L146">146</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="L147" href="#L147">147</a> <em
class="jxr_javadoccomment"> * @see
MavenReport#CATEGORY_PROJECT_INFORMATION</em>
+<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em
class="jxr_javadoccomment"> * @see MavenReport#CATEGORY_PROJECT_REPORTS</em>
+<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong
class="jxr_keyword">void</strong> populateReportsMenu( DecorationModel
decorationModel, Locale locale,
+<a class="jxr_linenumber" name="L151" href="#L151">151</a>
Map<String, List<MavenReport>> reportsPerCategory );
+<a class="jxr_linenumber" name="L152" href="#L152">152</a>
+<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> <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="L155" href="#L155">155</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="L156" href="#L156">156</a> <em
class="jxr_javadoccomment"> * the JVM.</em>
+<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"> * @param locales A comma separated list of
locales</em>
+<a class="jxr_linenumber" name="L159" href="#L159">159</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="L160" href="#L160">160</a> <em
class="jxr_javadoccomment"> * @since 1.7, was previously
getAvailableLocales(String)</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>
List<Locale> getSiteLocales( String locales );
+<a class="jxr_linenumber" name="L163" href="#L163">163</a>
+<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em
class="jxr_javadoccomment"> * Calculate the relative path between two URLs
or between two files.</em>
+<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em
class="jxr_javadoccomment"> * For example:</em>
+<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em
class="jxr_javadoccomment"> * <dl></em>
+<a class="jxr_linenumber" name="L169" href="#L169">169</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="L170" href="#L170">170</a> <em
class="jxr_javadoccomment"> * <dd>return ""</dd></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>/plugins/maven-site-plugin/"</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/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="L174" href="#L174">174</a> <em
class="jxr_javadoccomment"> * <dd>return
"plugins/maven-site-plugin"</dd></em>
+<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em
class="jxr_javadoccomment"> * <dt>to = "/myproject/myproject-module1"
and from = "/myproject/myproject"</dt></em>
+<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em
class="jxr_javadoccomment"> * <dd>return
"../myproject-module1"</dd></em>
+<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em
class="jxr_javadoccomment"> * </dl></em>
+<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em
class="jxr_javadoccomment"> * <b>Note</b>: The file separator
depends on the system.</em>
+<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em
class="jxr_javadoccomment"> * Maven-specific urls are supported, like
<code>dav:https://dav.codehaus.org/</code> or</em>
+<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em
class="jxr_javadoccomment"> *
<code>scm:svn:https://svn.apache.org/repos/asf</code>.</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.</em>
+<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em
class="jxr_javadoccomment"> * If called from Maven 3, just returns
<code>project.getParent()</code>, which is already</em>
+<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em
class="jxr_javadoccomment"> * interpolated. But when called from Maven 2,
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"> *</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> }
</pre>
<hr/>
<div id="footer">Copyright © 2005–2022 <a
href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights
reserved.</div>
Modified:
maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/org/apache/maven/doxia/tools/package-frame.html
==============================================================================
---
maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/org/apache/maven/doxia/tools/package-frame.html
(original)
+++
maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/org/apache/maven/doxia/tools/package-frame.html
Thu Feb 17 14:02:12 2022
@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html;
charset=UTF-8" />
- <title>Doxia Sitetools 2.0.0-M1 Reference Package
org.apache.maven.doxia.tools</title>
+ <title>Doxia Sitetools 2.0.0-M2 Reference Package
org.apache.maven.doxia.tools</title>
<link rel="stylesheet" type="text/css"
href="../../../../../stylesheet.css" title="style" />
</head>
<body>
Modified:
maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/org/apache/maven/doxia/tools/package-summary.html
==============================================================================
---
maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/org/apache/maven/doxia/tools/package-summary.html
(original)
+++
maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/org/apache/maven/doxia/tools/package-summary.html
Thu Feb 17 14:02:12 2022
@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html;
charset=UTF-8" />
- <title>Doxia Sitetools 2.0.0-M1 Reference Package
org.apache.maven.doxia.tools</title>
+ <title>Doxia Sitetools 2.0.0-M2 Reference Package
org.apache.maven.doxia.tools</title>
<link rel="stylesheet" type="text/css"
href="../../../../../stylesheet.css" title="style" />
</head>
<body>
Modified:
maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/overview-frame.html
==============================================================================
---
maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/overview-frame.html
(original)
+++
maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/overview-frame.html
Thu Feb 17 14:02:12 2022
@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html;
charset=UTF-8" />
- <title>Doxia Sitetools 2.0.0-M1 Reference</title>
+ <title>Doxia Sitetools 2.0.0-M2 Reference</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css"
title="style" />
</head>
<body>
Modified:
maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/overview-summary.html
==============================================================================
---
maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/overview-summary.html
(original)
+++
maven/doxia/website/components/doxia-sitetools-archives/doxia-sitetools-LATEST/xref/overview-summary.html
Thu Feb 17 14:02:12 2022
@@ -3,7 +3,7 @@
<html xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html;
charset=UTF-8" />
- <title>Doxia Sitetools 2.0.0-M1 Reference</title>
+ <title>Doxia Sitetools 2.0.0-M2 Reference</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css"
title="style" />
</head>
<body>
@@ -24,7 +24,7 @@
</ul>
</div>
- <h2>Doxia Sitetools 2.0.0-M1 Reference</h2>
+ <h2>Doxia Sitetools 2.0.0-M2 Reference</h2>
<table class="summary">
<thead>
