Modified: maven/website/components/plugins-archives/maven-pdf-plugin-LATEST/apidocs/org/apache/maven/plugins/pdf/DocumentModelBuilder.html ============================================================================== --- maven/website/components/plugins-archives/maven-pdf-plugin-LATEST/apidocs/org/apache/maven/plugins/pdf/DocumentModelBuilder.html (original) +++ maven/website/components/plugins-archives/maven-pdf-plugin-LATEST/apidocs/org/apache/maven/plugins/pdf/DocumentModelBuilder.html Sun Feb 23 12:55:13 2025 @@ -1,333 +1,372 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>DocumentModelBuilder (Apache Maven PDF Plugin 1.6.1 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="DocumentModelBuilder (Apache Maven PDF Plugin 1.6.1 API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":10,"i1":10}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/plugins/pdf/package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/DocumentModelBuilder.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/plugins/pdf/DocumentDescriptorReader.html" title="class in org.apache.maven.plugins.pdf"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/maven/plugins/pdf/HelpMojo.html" title="class in org.apache.maven.plugins.pdf"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../../index.html?org/apache/maven/plugins/pdf/DocumentModelBuilder.html" target="_top">Frames</a></li> -<li><a href="DocumentModelBuilder.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </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.plugins.pdf</div> -<h2 title="Class DocumentModelBuilder" class="title">Class DocumentModelBuilder</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> -<li> -<ul class="inheritance"> -<li>org.apache.maven.plugins.pdf.DocumentModelBuilder</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public class <span class="typeNameLabel">DocumentModelBuilder</span> -extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> -<div class="block">Construct a DocumentModel from a MavenProject and related information.</div> -<dl> -<dt><span class="simpleTagLabel">Author:</span></dt> -<dd>ltheussl</dd> -</dl> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.summary"> -<!-- --> -</a> -<h3>Constructor Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> -<caption><span>Constructors</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Constructor and Description</th> -</tr> -<tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/pdf/DocumentModelBuilder.html#DocumentModelBuilder-org.apache.maven.project.MavenProject-">DocumentModelBuilder</a></span>(<a href="https://maven.apache.org/ref/3.2.5/maven-core/apidocs/org/apache/maven/project/MavenProject.html?is-external=true"; title="class or interface in org.apache.maven.project">MavenProject</a> project)</code> -<div class="block">Constructor.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/pdf/DocumentModelBuilder.html#DocumentModelBuilder-org.apache.maven.project.MavenProject-org.apache.maven.doxia.site.decoration.DecorationModel-">DocumentModelBuilder</a></span>(<a href="https://maven.apache.org/ref/3.2.5/maven-core/apidocs/org/apache/maven/project/MavenProject.html?is-external=true"; title="class or interface in org.apache.maven.project">MavenProject</a> project, - <a href="https://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html?is-external=true"; title="class or interface in org.apache.maven.doxia.site.decoration">DecorationModel</a> decorationModel)</code> -<div class="block">Constructor.</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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="https://maven.apache.org/doxia/doxia/doxia-core/apidocs/org/apache/maven/doxia/document.DocumentModel.html?is-external=true"; title="class or interface in org.apache.maven.doxia">org.apache.maven.doxia.document.DocumentModel</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/pdf/DocumentModelBuilder.html#getDocumentModel--">getDocumentModel</a></span>()</code> -<div class="block">Get a DocumentModel.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code><a href="https://maven.apache.org/doxia/doxia/doxia-core/apidocs/org/apache/maven/doxia/document.DocumentModel.html?is-external=true"; title="class or interface in org.apache.maven.doxia">org.apache.maven.doxia.document.DocumentModel</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/pdf/DocumentModelBuilder.html#getDocumentModel-java.util.Date-">getDocumentModel</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true"; title="class or interface in java.util">Date</a> date)</code> -<div class="block">Get a DocumentModel.</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> -<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/ja va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.detail"> -<!-- --> -</a> -<h3>Constructor Detail</h3> -<a name="DocumentModelBuilder-org.apache.maven.project.MavenProject-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>DocumentModelBuilder</h4> -<pre>public DocumentModelBuilder(<a href="https://maven.apache.org/ref/3.2.5/maven-core/apidocs/org/apache/maven/project/MavenProject.html?is-external=true"; title="class or interface in org.apache.maven.project">MavenProject</a> project)</pre> -<div class="block">Constructor. Initialize a MavenProject to extract information from.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>project</code> - a MavenProject. May be null.</dd> -</dl> -</li> -</ul> -<a name="DocumentModelBuilder-org.apache.maven.project.MavenProject-org.apache.maven.doxia.site.decoration.DecorationModel-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>DocumentModelBuilder</h4> -<pre>public DocumentModelBuilder(<a href="https://maven.apache.org/ref/3.2.5/maven-core/apidocs/org/apache/maven/project/MavenProject.html?is-external=true"; title="class or interface in org.apache.maven.project">MavenProject</a> project, - <a href="https://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/apidocs/org/apache/maven/doxia/site/decoration/DecorationModel.html?is-external=true"; title="class or interface in org.apache.maven.doxia.site.decoration">DecorationModel</a> decorationModel)</pre> -<div class="block">Constructor. Initialize a MavenProject and a DecorationModel to extract information from.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>project</code> - a MavenProject. May be null.</dd> -<dd><code>decorationModel</code> - a DecorationModel. May be null.</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="getDocumentModel--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getDocumentModel</h4> -<pre>public <a href="https://maven.apache.org/doxia/doxia/doxia-core/apidocs/org/apache/maven/doxia/document.DocumentModel.html?is-external=true"; title="class or interface in org.apache.maven.doxia">org.apache.maven.doxia.document.DocumentModel</a> getDocumentModel()</pre> -<div class="block">Get a DocumentModel.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a DocumentModel. Always non-null.</dd> -</dl> -</li> -</ul> -<a name="getDocumentModel-java.util.Date-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>getDocumentModel</h4> -<pre>public <a href="https://maven.apache.org/doxia/doxia/doxia-core/apidocs/org/apache/maven/doxia/document.DocumentModel.html?is-external=true"; title="class or interface in org.apache.maven.doxia">org.apache.maven.doxia.document.DocumentModel</a> getDocumentModel(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true"; title="class or interface in java.util">Date</a> date)</pre> -<div class="block">Get a DocumentModel.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>date</code> - overrides the default date in meta- and cover information.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a DocumentModel. Always non-null.</dd> -</dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<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/plugins/pdf/package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/DocumentModelBuilder.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/plugins/pdf/DocumentDescriptorReader.html" title="class in org.apache.maven.plugins.pdf"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/maven/plugins/pdf/HelpMojo.html" title="class in org.apache.maven.plugins.pdf"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../../index.html?org/apache/maven/plugins/pdf/DocumentModelBuilder.html" target="_top">Frames</a></li> -<li><a href="DocumentModelBuilder.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </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 © 2002–2022 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> -</body> +<!DOCTYPE HTML> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<title>DocumentModelBuilder (Apache Maven PDF Plugin 1.6.2-SNAPSHOT API)</title> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> +<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> +<!--[if IE]> +<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> +<![endif]--> +<script type="text/javascript" src="../../../../../jquery/jquery-3.6.1.min.js"></script> +<script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="DocumentModelBuilder (Apache Maven PDF Plugin 1.6.2-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var data = {"i0":10,"i1":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +var pathtoroot = "../../../../../"; +var useModuleDirectories = true; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<header role="banner"> +<nav role="navigation"> +<div class="fixedNav"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a id="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a id="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/DocumentModelBuilder.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" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses.html">All Classes</a></li> +</ul> +<ul class="navListSearch"> +<li><label for="search">SEARCH:</label> +<input type="text" id="search" value="search" disabled="disabled"> +<input type="reset" id="reset" value="reset" disabled="disabled"> +</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> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a id="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +</div> +<div class="navPadding"> </div> +<script type="text/javascript"><!-- +$('.navPadding').css('padding-top', $('.fixedNav').css("height")); +//--> +</script> +</nav> +</header> +<!-- ======== START OF CLASS DATA ======== --> +<main role="main"> +<div class="header"> +<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.maven.plugins.pdf</a></div> +<h2 title="Class DocumentModelBuilder" class="title">Class DocumentModelBuilder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.maven.plugins.pdf.DocumentModelBuilder</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<pre>public class <span class="typeNameLabel">DocumentModelBuilder</span> +extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang" class="externalLink">Object</a></pre> +<div class="block">Construct a DocumentModel from a MavenProject and related information.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>ltheussl</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<section> +<ul class="blockList"> +<li class="blockList"><a id="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Constructor</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr class="altColor"> +<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.maven.project.MavenProject)">DocumentModelBuilder</a></span>​(org.apache.maven.project.MavenProject project)</code></th> +<td class="colLast"> +<div class="block">Constructor.</div> +</td> +</tr> +<tr class="rowColor"> +<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.maven.project.MavenProject,org.apache.maven.doxia.site.decoration.DecorationModel)">DocumentModelBuilder</a></span>​(org.apache.maven.project.MavenProject project, + org.apache.maven.doxia.site.decoration.DecorationModel decorationModel)</code></th> +<td class="colLast"> +<div class="block">Constructor.</div> +</td> +</tr> +</table> +</li> +</ul> +</section> +<!-- ========== METHOD SUMMARY =========== --> +<section> +<ul class="blockList"> +<li class="blockList"><a id="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary"> +<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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colSecond" scope="col">Method</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>org.apache.maven.doxia.document.DocumentModel</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDocumentModel()">getDocumentModel</a></span>()</code></th> +<td class="colLast"> +<div class="block">Get a DocumentModel.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>org.apache.maven.doxia.document.DocumentModel</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDocumentModel(java.util.Date)">getDocumentModel</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true"; title="class or interface in java.util" class="externalLink">Date</a> date)</code></th> +<td class="colLast"> +<div class="block">Get a DocumentModel.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang" class="externalLink">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> +</ul> +</li> +</ul> +</section> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<section> +<ul class="blockList"> +<li class="blockList"><a id="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a id="<init>(org.apache.maven.project.MavenProject)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DocumentModelBuilder</h4> +<pre>public DocumentModelBuilder​(org.apache.maven.project.MavenProject project)</pre> +<div class="block">Constructor. Initialize a MavenProject to extract information from.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>project</code> - a MavenProject. May be null.</dd> +</dl> +</li> +</ul> +<a id="<init>(org.apache.maven.project.MavenProject,org.apache.maven.doxia.site.decoration.DecorationModel)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DocumentModelBuilder</h4> +<pre>public DocumentModelBuilder​(org.apache.maven.project.MavenProject project, + org.apache.maven.doxia.site.decoration.DecorationModel decorationModel)</pre> +<div class="block">Constructor. Initialize a MavenProject and a DecorationModel to extract information from.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>project</code> - a MavenProject. May be null.</dd> +<dd><code>decorationModel</code> - a DecorationModel. May be null.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</section> +<!-- ============ METHOD DETAIL ========== --> +<section> +<ul class="blockList"> +<li class="blockList"><a id="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a id="getDocumentModel()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDocumentModel</h4> +<pre class="methodSignature">public org.apache.maven.doxia.document.DocumentModel getDocumentModel()</pre> +<div class="block">Get a DocumentModel.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a DocumentModel. Always non-null.</dd> +</dl> +</li> +</ul> +<a id="getDocumentModel(java.util.Date)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getDocumentModel</h4> +<pre class="methodSignature">public org.apache.maven.doxia.document.DocumentModel getDocumentModel​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true"; title="class or interface in java.util" class="externalLink">Date</a> date)</pre> +<div class="block">Get a DocumentModel.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>date</code> - overrides the default date in meta- and cover information.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a DocumentModel. Always non-null.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</section> +</li> +</ul> +</div> +</div> +</main> +<!-- ========= END OF CLASS DATA ========= --> +<footer role="contentinfo"> +<nav role="navigation"> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a id="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a id="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/DocumentModelBuilder.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" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses.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> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a id="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</nav> +<p class="legalCopy"><small>Copyright © 2002–2022 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</body> </html> \ No newline at end of file
Modified: maven/website/components/plugins-archives/maven-pdf-plugin-LATEST/apidocs/org/apache/maven/plugins/pdf/PdfAggregateMojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-pdf-plugin-LATEST/apidocs/org/apache/maven/plugins/pdf/PdfAggregateMojo.html (original) +++ maven/website/components/plugins-archives/maven-pdf-plugin-LATEST/apidocs/org/apache/maven/plugins/pdf/PdfAggregateMojo.html Sun Feb 23 12:55:13 2025 @@ -1,444 +1,487 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>PdfAggregateMojo (Apache Maven PDF Plugin 1.6.1 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="PdfAggregateMojo (Apache Maven PDF Plugin 1.6.1 API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/plugins/pdf/package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/PdfAggregateMojo.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/plugins/pdf/HelpMojo.html" title="class in org.apache.maven.plugins.pdf"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html" title="class in org.apache.maven.plugins.pdf"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../../index.html?org/apache/maven/plugins/pdf/PdfAggregateMojo.html" target="_top">Frames</a></li> -<li><a href="PdfAggregateMojo.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="#fields.inherited.from.class.org.apache.maven.plugins.pdf.PdfMojo">Field</a> | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </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.plugins.pdf</div> -<h2 title="Class PdfAggregateMojo" class="title">Class PdfAggregateMojo</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> -<li> -<ul class="inheritance"> -<li><a href="https://maven.apache.org/ref/3.2.5/maven-core/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true"; title="class or interface in org.apache.maven.plugin">org.apache.maven.plugin.AbstractMojo</a></li> -<li> -<ul class="inheritance"> -<li><a href="../../../../../org/apache/maven/plugins/pdf/AbstractPdfMojo.html" title="class in org.apache.maven.plugins.pdf">org.apache.maven.plugins.pdf.AbstractPdfMojo</a></li> -<li> -<ul class="inheritance"> -<li><a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html" title="class in org.apache.maven.plugins.pdf">org.apache.maven.plugins.pdf.PdfMojo</a></li> -<li> -<ul class="inheritance"> -<li>org.apache.maven.plugins.pdf.PdfAggregateMojo</li> -</ul> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Implemented Interfaces:</dt> -<dd><a href="https://maven.apache.org/ref/3.2.5/maven-core/apidocs/org/apache/maven/plugin/ContextEnabled.html?is-external=true"; title="class or interface in org.apache.maven.plugin">ContextEnabled</a>, <a href="https://maven.apache.org/ref/3.2.5/maven-core/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true"; title="class or interface in org.apache.maven.plugin">Mojo</a>, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable</dd> -</dl> -<hr> -<br> -<pre><a href="https://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Mojo.html?is-external=true"; title="class or interface in org.apache.maven.plugins.annotations">@Mojo</a>(<a href="https://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Mojo.html?is-external=true#name--"; title="class or interface in org.apache.maven.plugins.annotations">name</a>="aggregate", - <a href="https://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Mojo.html?is-external=true#aggregator--"; title="class or interface in org.apache.maven.plugins.annotations">aggregator</a>=true, - <a href="https://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Mojo.html?is-external=true#requiresDependencyResolution--"; title="class or interface in org.apache.maven.plugins.annotations">requiresDependencyResolution</a>=<a href="https://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/ResolutionScope.html?is-external=true#TEST"; title="class or interface in org.apache.maven.plugins.annotations">TEST</a>, - <a href="https://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Mojo.html?is-external=true#threadSafe--"; title="class or interface in org.apache.maven.plugins.annotations">threadSafe</a>=true) - <a href="https://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Execute.html?is-external=true"; title="class or interface in org.apache.maven.plugins.annotations">@Execute</a>(<a href="https://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Execute.html?is-external=true#goal--"; title="class or interface in org.apache.maven.plugins.annotations">goal</a>="pdf") -public class <span class="typeNameLabel">PdfAggregateMojo</span> -extends <a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html" title="class in org.apache.maven.plugins.pdf">PdfMojo</a></pre> -<div class="block">Forks <code>pdf</code> goal then aggregates PDF content from all modules in the reactor.</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>1.5</dd> -<dt><span class="simpleTagLabel">Author:</span></dt> -<dd>anthony-beurive</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> -<ul class="blockList"> -<li class="blockList"><a name="fields.inherited.from.class.org.apache.maven.plugins.pdf.PdfMojo"> -<!-- --> -</a> -<h3>Fields inherited from class org.apache.maven.plugins.pdf.<a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html" title="class in org.apache.maven.plugins.pdf">PdfMojo</a></h3> -<code><a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html#project">project</a></code></li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="fields.inherited.from.class.org.apache.maven.plugin.Mojo"> -<!-- --> -</a> -<h3>Fields inherited from interface org.apache.maven.plugin.<a href="https://maven.apache.org/ref/3.2.5/maven-core/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true"; title="class or interface in org.apache.maven.plugin">Mojo</a></h3> -<code><a href="https://maven.apache.org/ref/3.2.5/maven-core/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true#ROLE"; title="class or interface in org.apache.maven.plugin">ROLE</a></code></li> -</ul> -</li> -</ul> -<!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.summary"> -<!-- --> -</a> -<h3>Constructor Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> -<caption><span>Constructors</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Constructor and Description</th> -</tr> -<tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/pdf/PdfAggregateMojo.html#PdfAggregateMojo--">PdfAggregateMojo</a></span>()</code> </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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>protected void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/pdf/PdfAggregateMojo.html#appendGeneratedReports-org.apache.maven.doxia.document.DocumentModel-java.util.Locale-">appendGeneratedReports</a></span>(<a href="https://maven.apache.org/doxia/doxia/doxia-core/apidocs/org/apache/maven/doxia/document.DocumentModel.html?is-external=true"; title="class or interface in org.apache.maven.doxia">org.apache.maven.doxia.document.DocumentModel</a> model, - <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a> locale)</code> -<div class="block">Append generated reports to the toc only if <code>generateReports</code> is enabled, for instance:</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/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/plugins/pdf/PdfAggregateMojo.html#getOutputDirectory--">getOutputDirectory</a></span>()</code> </td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/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/plugins/pdf/PdfAggregateMojo.html#getWorkingDirectory--">getWorkingDirectory</a></span>()</code> </td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code>protected boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/pdf/PdfAggregateMojo.html#isIncludeReports--">isIncludeReports</a></span>()</code> </td> -</tr> -<tr id="i4" class="altColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/maven/plugins/pdf/PdfAggregateMojo.html#prepareTempSiteDirectory-java.io.File-">prepareTempSiteDirectory</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> tmpSiteDir)</code> -<div class="block">Copy all site and generated-site files in the tmpSiteDirectory.</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.org.apache.maven.plugins.pdf.PdfMojo"> -<!-- --> -</a> -<h3>Methods inherited from class org.apache.maven.plugins.pdf.<a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html" title="class in org.apache.maven.plugins.pdf">PdfMojo</a></h3> -<code><a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html#contextualize-org.codehaus.plexus.context.Context-">contextualize</a>, <a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html#execute--">execute</a>, <a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html#getReports--">getReports</a></code></li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.org.apache.maven.plugins.pdf.AbstractPdfMojo"> -<!-- --> -</a> -<h3>Methods inherited from class org.apache.maven.plugins.pdf.<a href="../../../../../org/apache/maven/plugins/pdf/AbstractPdfMojo.html" title="class in org.apache.maven.plugins.pdf">AbstractPdfMojo</a></h3> -<code><a href="../../../../../org/apache/maven/plugins/pdf/AbstractPdfMojo.html#getSiteDirectoryTmp--">getSiteDirectoryTmp</a></code></li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.org.apache.maven.plugin.AbstractMojo"> -<!-- --> -</a> -<h3>Methods inherited from class org.apache.maven.plugin.<a href="https://maven.apache.org/ref/3.2.5/maven-core/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true"; title="class or interface in org.apache.maven.plugin">AbstractMojo</a></h3> -<code><a href="https://maven.apache.org/ref/3.2.5/maven-core/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#getLog--"; title="class or interface in org.apache.maven.plugin">getLog</a>, <a href="https://maven.apache.org/ref/3.2.5/maven-core/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#getPluginContext--"; title="class or interface in org.apache.maven.plugin">getPluginContext</a>, <a href="https://maven.apache.org/ref/3.2.5/maven-core/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#setLog-org.apache.maven.plugin.logging.Log-"; title="class or interface in org.apache.maven.plugin">setLog</a>, <a href="https://maven.apache.org/ref/3.2.5/maven-core/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#setPluginContext-java.util.Map-"; title="class or interface in org.apache.maven.plugin">setPluginContext</a></code></li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> -<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/ja va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.detail"> -<!-- --> -</a> -<h3>Constructor Detail</h3> -<a name="PdfAggregateMojo--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>PdfAggregateMojo</h4> -<pre>public PdfAggregateMojo()</pre> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="getOutputDirectory--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getOutputDirectory</h4> -<pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> getOutputDirectory()</pre> -<dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> -<dd><code><a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html#getOutputDirectory--">getOutputDirectory</a></code> in class <code><a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html" title="class in org.apache.maven.plugins.pdf">PdfMojo</a></code></dd> -</dl> -</li> -</ul> -<a name="getWorkingDirectory--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getWorkingDirectory</h4> -<pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> getWorkingDirectory()</pre> -<dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> -<dd><code><a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html#getWorkingDirectory--">getWorkingDirectory</a></code> in class <code><a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html" title="class in org.apache.maven.plugins.pdf">PdfMojo</a></code></dd> -</dl> -</li> -</ul> -<a name="isIncludeReports--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>isIncludeReports</h4> -<pre>protected boolean isIncludeReports()</pre> -<dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> -<dd><code><a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html#isIncludeReports--">isIncludeReports</a></code> in class <code><a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html" title="class in org.apache.maven.plugins.pdf">PdfMojo</a></code></dd> -</dl> -</li> -</ul> -<a name="prepareTempSiteDirectory-java.io.File-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>prepareTempSiteDirectory</h4> -<pre>protected void prepareTempSiteDirectory(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> tmpSiteDir)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html#prepareTempSiteDirectory-java.io.File-">PdfMojo</a></code></span></div> -<div class="block">Copy all site and generated-site files in the tmpSiteDirectory. - <br> - <b>Note</b>: ignore copying of <code>generated-site</code> files if they already exist in the - <code>site</code> dir.</div> -<dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> -<dd><code><a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html#prepareTempSiteDirectory-java.io.File-">prepareTempSiteDirectory</a></code> in class <code><a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html" title="class in org.apache.maven.plugins.pdf">PdfMojo</a></code></dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>tmpSiteDir</code> - not null</dd> -</dl> -</li> -</ul> -<a name="appendGeneratedReports-org.apache.maven.doxia.document.DocumentModel-java.util.Locale-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>appendGeneratedReports</h4> -<pre>protected void appendGeneratedReports(<a href="https://maven.apache.org/doxia/doxia/doxia-core/apidocs/org/apache/maven/doxia/document.DocumentModel.html?is-external=true"; title="class or interface in org.apache.maven.doxia">org.apache.maven.doxia.document.DocumentModel</a> model, - <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a> locale)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html#appendGeneratedReports-org.apache.maven.doxia.document.DocumentModel-java.util.Locale-">PdfMojo</a></code></span></div> -<div class="block">Append generated reports to the toc only if <code>generateReports</code> is enabled, for instance: - <pre> - <item name="Project Reports" ref="project-info"> - <item name="Project License" ref="license" /> - <item name="Project Team" ref="team-list" /> - <item name="Continuous Integration" ref="integration" /> - ... - </item> - </pre></div> -<dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> -<dd><code><a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html#appendGeneratedReports-org.apache.maven.doxia.document.DocumentModel-java.util.Locale-">appendGeneratedReports</a></code> in class <code><a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html" title="class in org.apache.maven.plugins.pdf">PdfMojo</a></code></dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>model</code> - not null</dd> -<dd><code>locale</code> - not null</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html#generateMavenReports-java.util.Locale-"><code>PdfMojo.generateMavenReports(Locale)</code></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/plugins/pdf/package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/PdfAggregateMojo.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/plugins/pdf/HelpMojo.html" title="class in org.apache.maven.plugins.pdf"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/maven/plugins/pdf/PdfMojo.html" title="class in org.apache.maven.plugins.pdf"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../../index.html?org/apache/maven/plugins/pdf/PdfAggregateMojo.html" target="_top">Frames</a></li> -<li><a href="PdfAggregateMojo.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="#fields.inherited.from.class.org.apache.maven.plugins.pdf.PdfMojo">Field</a> | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </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 © 2002–2022 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> -</body> +<!DOCTYPE HTML> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<title>PdfAggregateMojo (Apache Maven PDF Plugin 1.6.2-SNAPSHOT API)</title> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> +<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> +<!--[if IE]> +<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> +<![endif]--> +<script type="text/javascript" src="../../../../../jquery/jquery-3.6.1.min.js"></script> +<script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="PdfAggregateMojo (Apache Maven PDF Plugin 1.6.2-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +var pathtoroot = "../../../../../"; +var useModuleDirectories = true; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<header role="banner"> +<nav role="navigation"> +<div class="fixedNav"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a id="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a id="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/PdfAggregateMojo.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" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses.html">All Classes</a></li> +</ul> +<ul class="navListSearch"> +<li><label for="search">SEARCH:</label> +<input type="text" id="search" value="search" disabled="disabled"> +<input type="reset" id="reset" value="reset" disabled="disabled"> +</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> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a id="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +</div> +<div class="navPadding"> </div> +<script type="text/javascript"><!-- +$('.navPadding').css('padding-top', $('.fixedNav').css("height")); +//--> +</script> +</nav> +</header> +<!-- ======== START OF CLASS DATA ======== --> +<main role="main"> +<div class="header"> +<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.maven.plugins.pdf</a></div> +<h2 title="Class PdfAggregateMojo" class="title">Class PdfAggregateMojo</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.maven.plugin.AbstractMojo</li> +<li> +<ul class="inheritance"> +<li><a href="AbstractPdfMojo.html" title="class in org.apache.maven.plugins.pdf">org.apache.maven.plugins.pdf.AbstractPdfMojo</a></li> +<li> +<ul class="inheritance"> +<li><a href="PdfMojo.html" title="class in org.apache.maven.plugins.pdf">org.apache.maven.plugins.pdf.PdfMojo</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.maven.plugins.pdf.PdfAggregateMojo</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><code>org.apache.maven.plugin.ContextEnabled</code>, <code>org.apache.maven.plugin.Mojo</code>, <code>org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable</code></dd> +</dl> +<hr> +<pre>@Mojo(name="aggregate", + aggregator=true, + requiresDependencyResolution=TEST, + threadSafe=true) +@Execute(goal="pdf") +public class <span class="typeNameLabel">PdfAggregateMojo</span> +extends <a href="PdfMojo.html" title="class in org.apache.maven.plugins.pdf">PdfMojo</a></pre> +<div class="block">Forks <code>pdf</code> goal then aggregates PDF content from all modules in the reactor.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.5</dd> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>anthony-beurive</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<section> +<ul class="blockList"> +<li class="blockList"><a id="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a id="fields.inherited.from.class.org.apache.maven.plugins.pdf.PdfMojo"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.maven.plugins.pdf.<a href="PdfMojo.html" title="class in org.apache.maven.plugins.pdf">PdfMojo</a></h3> +<code><a href="PdfMojo.html#project">project</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a id="fields.inherited.from.class.org.apache.maven.plugin.Mojo"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.maven.plugin.Mojo</h3> +<code>ROLE</code></li> +</ul> +</li> +</ul> +</section> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<section> +<ul class="blockList"> +<li class="blockList"><a id="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Constructor</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr class="altColor"> +<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">PdfAggregateMojo</a></span>()</code></th> +<td class="colLast"> </td> +</tr> +</table> +</li> +</ul> +</section> +<!-- ========== METHOD SUMMARY =========== --> +<section> +<ul class="blockList"> +<li class="blockList"><a id="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary"> +<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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colSecond" scope="col">Method</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#appendGeneratedReports(org.apache.maven.doxia.document.DocumentModel,java.util.Locale)">appendGeneratedReports</a></span>​(org.apache.maven.doxia.document.DocumentModel model, + <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util" class="externalLink">Locale</a> locale)</code></th> +<td class="colLast"> +<div class="block">Append generated reports to the toc only if <code>generateReports</code> is enabled, for instance:</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io" class="externalLink">File</a></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOutputDirectory()">getOutputDirectory</a></span>()</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io" class="externalLink">File</a></code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWorkingDirectory()">getWorkingDirectory</a></span>()</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isIncludeReports()">isIncludeReports</a></span>()</code></th> +<td class="colLast"> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#prepareTempSiteDirectory(java.io.File)">prepareTempSiteDirectory</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io" class="externalLink">File</a> tmpSiteDir)</code></th> +<td class="colLast"> +<div class="block">Copy all site and generated-site files in the tmpSiteDirectory.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a id="methods.inherited.from.class.org.apache.maven.plugins.pdf.PdfMojo"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.maven.plugins.pdf.<a href="PdfMojo.html" title="class in org.apache.maven.plugins.pdf">PdfMojo</a></h3> +<code><a href="PdfMojo.html#contextualize(org.codehaus.plexus.context.Context)">contextualize</a>, <a href="PdfMojo.html#execute()">execute</a>, <a href="PdfMojo.html#getReports()">getReports</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a id="methods.inherited.from.class.org.apache.maven.plugins.pdf.AbstractPdfMojo"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.maven.plugins.pdf.<a href="AbstractPdfMojo.html" title="class in org.apache.maven.plugins.pdf">AbstractPdfMojo</a></h3> +<code><a href="AbstractPdfMojo.html#getSiteDirectoryTmp()">getSiteDirectoryTmp</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a id="methods.inherited.from.class.org.apache.maven.plugin.AbstractMojo"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.maven.plugin.AbstractMojo</h3> +<code>getLog, getPluginContext, setLog, setPluginContext</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang" class="externalLink">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> +</ul> +</li> +</ul> +</section> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<section> +<ul class="blockList"> +<li class="blockList"><a id="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a id="<init>()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PdfAggregateMojo</h4> +<pre>public PdfAggregateMojo()</pre> +</li> +</ul> +</li> +</ul> +</section> +<!-- ============ METHOD DETAIL ========== --> +<section> +<ul class="blockList"> +<li class="blockList"><a id="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a id="getOutputDirectory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOutputDirectory</h4> +<pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io" class="externalLink">File</a> getOutputDirectory()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="PdfMojo.html#getOutputDirectory()">getOutputDirectory</a></code> in class <code><a href="PdfMojo.html" title="class in org.apache.maven.plugins.pdf">PdfMojo</a></code></dd> +</dl> +</li> +</ul> +<a id="getWorkingDirectory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWorkingDirectory</h4> +<pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io" class="externalLink">File</a> getWorkingDirectory()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="PdfMojo.html#getWorkingDirectory()">getWorkingDirectory</a></code> in class <code><a href="PdfMojo.html" title="class in org.apache.maven.plugins.pdf">PdfMojo</a></code></dd> +</dl> +</li> +</ul> +<a id="isIncludeReports()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIncludeReports</h4> +<pre class="methodSignature">protected boolean isIncludeReports()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="PdfMojo.html#isIncludeReports()">isIncludeReports</a></code> in class <code><a href="PdfMojo.html" title="class in org.apache.maven.plugins.pdf">PdfMojo</a></code></dd> +</dl> +</li> +</ul> +<a id="prepareTempSiteDirectory(java.io.File)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prepareTempSiteDirectory</h4> +<pre class="methodSignature">protected void prepareTempSiteDirectory​(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io" class="externalLink">File</a> tmpSiteDir)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="PdfMojo.html#prepareTempSiteDirectory(java.io.File)">PdfMojo</a></code></span></div> +<div class="block">Copy all site and generated-site files in the tmpSiteDirectory. + <br> + <b>Note</b>: ignore copying of <code>generated-site</code> files if they already exist in the + <code>site</code> dir.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="PdfMojo.html#prepareTempSiteDirectory(java.io.File)">prepareTempSiteDirectory</a></code> in class <code><a href="PdfMojo.html" title="class in org.apache.maven.plugins.pdf">PdfMojo</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>tmpSiteDir</code> - not null</dd> +</dl> +</li> +</ul> +<a id="appendGeneratedReports(org.apache.maven.doxia.document.DocumentModel,java.util.Locale)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>appendGeneratedReports</h4> +<pre class="methodSignature">protected void appendGeneratedReports​(org.apache.maven.doxia.document.DocumentModel model, + <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util" class="externalLink">Locale</a> locale)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="PdfMojo.html#appendGeneratedReports(org.apache.maven.doxia.document.DocumentModel,java.util.Locale)">PdfMojo</a></code></span></div> +<div class="block">Append generated reports to the toc only if <code>generateReports</code> is enabled, for instance: + <pre> + <item name="Project Reports" ref="project-info"> + <item name="Project License" ref="license" /> + <item name="Project Team" ref="team-list" /> + <item name="Continuous Integration" ref="integration" /> + ... + </item> + </pre></div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="PdfMojo.html#appendGeneratedReports(org.apache.maven.doxia.document.DocumentModel,java.util.Locale)">appendGeneratedReports</a></code> in class <code><a href="PdfMojo.html" title="class in org.apache.maven.plugins.pdf">PdfMojo</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>model</code> - not null</dd> +<dd><code>locale</code> - not null</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="PdfMojo.html#generateMavenReports(java.util.Locale)"><code>PdfMojo.generateMavenReports(Locale)</code></a></dd> +</dl> +</li> +</ul> +</li> +</ul> +</section> +</li> +</ul> +</div> +</div> +</main> +<!-- ========= END OF CLASS DATA ========= --> +<footer role="contentinfo"> +<nav role="navigation"> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a id="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a id="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/PdfAggregateMojo.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" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses.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> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a id="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</nav> +<p class="legalCopy"><small>Copyright © 2002–2022 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</body> </html> \ No newline at end of file
