/usr/share/doc/libmaven-doxia-tools-java/api/org/apache/maven/doxia/tools/SiteTool.html is in libmaven-doxia-tools-java-doc 1.4-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SiteTool (Maven Doxia Integration Tools 1.4 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SiteTool (Maven Doxia Integration Tools 1.4 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":38,"i11":6,"i12":6,"i13":38,"i14":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="typeNameLink">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="typeNameLink">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="typeNameLabel">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="simpleTagLabel">Version:</span></dt>
<dd>$Id: SiteTool.java 1098159 2011-04-30 21:07:49Z dennisl $</dd>
<dt><span class="simpleTagLabel">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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#DEFAULT_LOCALE">DEFAULT_LOCALE</a></span></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><span class="memberNameLink"><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#ROLE">ROLE</a></span></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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" 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><span class="memberNameLink"><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#codeToLocale-java.lang.String-">codeToLocale</a></span>(<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 id="i1" 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><span class="memberNameLink"><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#getAvailableLocales-java.lang.String-">getAvailableLocales</a></span>(<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 id="i2" class="altColor">
<td class="colFirst"><code>org.apache.maven.doxia.site.decoration.DecorationModel</code></td>
<td class="colLast"><code><span class="memberNameLink"><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-java.lang.String-java.lang.String-">getDecorationModel</a></span>(org.apache.maven.project.MavenProject 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><org.apache.maven.project.MavenProject> reactorProjects,
org.apache.maven.artifact.repository.ArtifactRepository 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><org.apache.maven.artifact.repository.ArtifactRepository> 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,
<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> inputEncoding,
<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> outputEncoding)</code>
<div class="block">Get a decoration model for a project.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.apache.maven.artifact.Artifact</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#getDefaultSkinArtifact-org.apache.maven.artifact.repository.ArtifactRepository-java.util.List-">getDefaultSkinArtifact</a></span>(org.apache.maven.artifact.repository.ArtifactRepository 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><org.apache.maven.artifact.repository.ArtifactRepository> remoteArtifactRepositories)</code>
<div class="block">Get the default skin artifact for a project from one of the repositories.</div>
</td>
</tr>
<tr id="i4" 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><span class="memberNameLink"><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#getInterpolatedSiteDescriptorContent-java.util.Map-org.apache.maven.project.MavenProject-java.lang.String-java.lang.String-java.lang.String-">getInterpolatedSiteDescriptorContent</a></span>(<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,
org.apache.maven.project.MavenProject 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,
<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> inputEncoding,
<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> outputEncoding)</code>
<div class="block">Interpolating several expressions in the site descriptor content.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>org.apache.maven.project.MavenProject</code></td>
<td class="colLast"><code><span class="memberNameLink"><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></span>(org.apache.maven.project.MavenProject 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><org.apache.maven.project.MavenProject> reactorProjects,
org.apache.maven.artifact.repository.ArtifactRepository localRepository)</code>
<div class="block">Returns the parent POM with interpolated URLs.</div>
</td>
</tr>
<tr id="i6" 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><span class="memberNameLink"><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#getRelativePath-java.lang.String-java.lang.String-">getRelativePath</a></span>(<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 id="i7" 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><span class="memberNameLink"><a href="../../../../../org/apache/maven/doxia/tools/SiteTool.html#getSiteDescriptorFromBasedir-java.lang.String-java.io.File-java.util.Locale-">getSiteDescriptorFromBasedir</a></span>(<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 id="i8" 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><span class="memberNameLink"><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></span>(org.apache.maven.project.MavenProject project,
org.apache.maven.artifact.repository.ArtifactRepository 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><org.apache.maven.artifact.repository.ArtifactRepository> 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 id="i9" class="rowColor">
<td class="colFirst"><code>org.apache.maven.artifact.Artifact</code></td>
<td class="colLast"><code><span class="memberNameLink"><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></span>(org.apache.maven.artifact.repository.ArtifactRepository 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><org.apache.maven.artifact.repository.ArtifactRepository> remoteArtifactRepositories,
org.apache.maven.doxia.site.decoration.DecorationModel decoration)</code>
<div class="block">Get a skin artifact from one of the repositories.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><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></span>(org.apache.maven.project.MavenProject 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><org.apache.maven.project.MavenProject> reactorProjects,
org.apache.maven.artifact.repository.ArtifactRepository localRepository,
org.apache.maven.doxia.site.decoration.DecorationModel 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"><span class="deprecatedLabel">Deprecated.</span>
<div class="block"><span class="deprecationComment">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</span></div>
</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><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></span>(org.apache.maven.project.MavenProject 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><org.apache.maven.project.MavenProject> reactorProjects,
org.apache.maven.artifact.repository.ArtifactRepository localRepository,
org.apache.maven.doxia.site.decoration.DecorationModel 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 id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><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></span>(org.apache.maven.doxia.site.decoration.DecorationModel 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,
org.apache.maven.project.MavenProject project,
org.apache.maven.project.MavenProject parentProject,
boolean keepInheritedRefs)</code>
<div class="block">Populate the parent menu part of the decoration model.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><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></span>(org.apache.maven.doxia.site.decoration.DecorationModel 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,
org.apache.maven.project.MavenProject project,
org.apache.maven.project.MavenProject parentProject,
boolean keepInheritedRefs)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="block"><span class="deprecationComment">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</span></div>
</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><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></span>(org.apache.maven.doxia.site.decoration.DecorationModel 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><org.apache.maven.reporting.MavenReport>> 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="seeLabel">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>org.apache.maven.artifact.Artifact getSkinArtifactFromRepository(org.apache.maven.artifact.repository.ArtifactRepository 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><org.apache.maven.artifact.repository.ArtifactRepository> remoteArtifactRepositories,
org.apache.maven.doxia.site.decoration.DecorationModel 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="paramLabel">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="returnLabel">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="throwsLabel">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>org.apache.maven.artifact.Artifact getDefaultSkinArtifact(org.apache.maven.artifact.repository.ArtifactRepository 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><org.apache.maven.artifact.repository.ArtifactRepository> 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="paramLabel">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="returnLabel">Returns:</span></dt>
<dd>the default <code>Skin</code> artifact from a given project and a local repository</dd>
<dt><span class="throwsLabel">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="seeLabel">See Also:</span></dt>
<dd><code>Skin.getDefaultSkin()</code>,
<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="paramLabel">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="returnLabel">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="paramLabel">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="returnLabel">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(org.apache.maven.project.MavenProject project,
org.apache.maven.artifact.repository.ArtifactRepository 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><org.apache.maven.artifact.repository.ArtifactRepository> 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="paramLabel">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="returnLabel">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="throwsLabel">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-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDecorationModel</h4>
<pre>org.apache.maven.doxia.site.decoration.DecorationModel getDecorationModel(org.apache.maven.project.MavenProject 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><org.apache.maven.project.MavenProject> reactorProjects,
org.apache.maven.artifact.repository.ArtifactRepository 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><org.apache.maven.artifact.repository.ArtifactRepository> 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,
<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> inputEncoding,
<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> outputEncoding)
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="paramLabel">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>
<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>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>DecorationModel</code> object corresponding to the <code>site.xml</code> file with some
interpolations.</dd>
<dt><span class="throwsLabel">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(org.apache.maven.doxia.site.decoration.DecorationModel 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><org.apache.maven.reporting.MavenReport>> categories)</pre>
<div class="block">Populate the reports menu part of the decoration model.</div>
<dl>
<dt><span class="paramLabel">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-java.lang.String-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,
org.apache.maven.project.MavenProject 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,
<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> inputEncoding,
<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> outputEncoding)
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="paramLabel">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="returnLabel">Returns:</span></dt>
<dd>the site descriptor content based on the <code>site.xml</code> file with interpolated strings.</dd>
<dt><span class="throwsLabel">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>org.apache.maven.project.MavenProject getParentProject(org.apache.maven.project.MavenProject 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><org.apache.maven.project.MavenProject> reactorProjects,
org.apache.maven.artifact.repository.ArtifactRepository 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="paramLabel">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="returnLabel">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(org.apache.maven.doxia.site.decoration.DecorationModel 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,
org.apache.maven.project.MavenProject project,
org.apache.maven.project.MavenProject parentProject,
boolean keepInheritedRefs)</pre>
<div class="block">Populate the parent menu part of the decoration model.</div>
<dl>
<dt><span class="paramLabel">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(org.apache.maven.doxia.site.decoration.DecorationModel 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,
org.apache.maven.project.MavenProject project,
org.apache.maven.project.MavenProject parentProject,
boolean keepInheritedRefs)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">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</span></div>
<div class="block">Populate the parent menu part of the decoration model.</div>
<dl>
<dt><span class="paramLabel">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(org.apache.maven.project.MavenProject 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><org.apache.maven.project.MavenProject> reactorProjects,
org.apache.maven.artifact.repository.ArtifactRepository localRepository,
org.apache.maven.doxia.site.decoration.DecorationModel 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="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">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</span></div>
<div class="block">Populate the modules menu part of the decoration model.</div>
<dl>
<dt><span class="paramLabel">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="throwsLabel">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(org.apache.maven.project.MavenProject 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><org.apache.maven.project.MavenProject> reactorProjects,
org.apache.maven.artifact.repository.ArtifactRepository localRepository,
org.apache.maven.doxia.site.decoration.DecorationModel 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="paramLabel">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="throwsLabel">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="paramLabel">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="returnLabel">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="paramLabel">Parameters:</span></dt>
<dd><code>localeCode</code> - the locale code string.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a java.util.Locale object instanced or null if errors occurred</dd>
<dt><span class="seeLabel">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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="typeNameLink">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="typeNameLink">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 © 2017. All rights reserved.</small></p>
</body>
</html>
|