Added: dev/commons/release-plugin/1.8.2-RC1/site/apidocs/help-doc.html ============================================================================== --- dev/commons/release-plugin/1.8.2-RC1/site/apidocs/help-doc.html (added) +++ dev/commons/release-plugin/1.8.2-RC1/site/apidocs/help-doc.html Tue Apr 16 00:57:05 2024 @@ -0,0 +1,196 @@ +<!DOCTYPE HTML> +<html lang="en"> +<head> +<!-- Generated by javadoc (17) --> +<title>API Help (Apache Commons Release Plugin 1.8.2 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<meta name="description" content="help"> +<meta name="generator" content="javadoc/HelpWriter"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="script-dir/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="script-dir/jquery-3.6.1.min.js"></script> +<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> +</head> +<body class="help-page"> +<script type="text/javascript">var pathtoroot = "./"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="index.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="overview-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li><a href="index-all.html">Index</a></li> +<li class="nav-bar-cell1-rev">Help</li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Help: </li> +<li><a href="#help-navigation">Navigation</a> | </li> +<li><a href="#help-pages">Pages</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<h1 class="title">JavaDoc Help</h1> +<ul class="help-toc"> +<li><a href="#help-navigation">Navigation</a>: +<ul class="help-subtoc"> +<li><a href="#help-search">Search</a></li> +</ul> +</li> +<li><a href="#help-pages">Kinds of Pages</a>: +<ul class="help-subtoc"> +<li><a href="#overview">Overview</a></li> +<li><a href="#package">Package</a></li> +<li><a href="#class">Class or Interface</a></li> +<li><a href="#doc-file">Other Files</a></li> +<li><a href="#use">Use</a></li> +<li><a href="#tree">Tree (Class Hierarchy)</a></li> +<li><a href="#deprecated">Deprecated API</a></li> +<li><a href="#constant-values">Constant Field Values</a></li> +<li><a href="#all-packages">All Packages</a></li> +<li><a href="#all-classes">All Classes and Interfaces</a></li> +<li><a href="#index">Index</a></li> +</ul> +</li> +</ul> +<hr> +<div class="sub-title"> +<h2 id="help-navigation">Navigation</h2> +Starting from the <a href="index.html">Overview</a> page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The <a href="index-all.html">Index</a> and Search box allow you to navigate to specific declarations and summary pages, including: <a href="allpackages-index.html">All Packages</a>, <a href="allclasses-index.html">All Classes and Interfaces</a> +<section class="help-section" id="help-search"> +<h3>Search</h3> +<p>You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API, using some or all of the name, optionally using "camelCase" abbreviations. For example:</p> +<ul class="help-section-list"> +<li><code>j.l.obj</code> will match "java.lang.Object"</li> +<li><code>InpStr</code> will match "java.io.InputStream"</li> +<li><code>HM.cK</code> will match "java.util.HashMap.containsKey(Object)"</li> +</ul> +<p>Refer to the <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/javadoc-search-spec.html";>Javadoc Search Specification</a> for a full description of search features.</p> +</section> +</div> +<hr> +<div class="sub-title"> +<h2 id="help-pages">Kinds of Pages</h2> +The following sections describe the different kinds of pages in this collection. +<section class="help-section" id="overview"> +<h3>Overview</h3> +<p>The <a href="index.html">Overview</a> page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.</p> +</section> +<section class="help-section" id="package"> +<h3>Package</h3> +<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:</p> +<ul class="help-section-list"> +<li>Interfaces</li> +<li>Classes</li> +<li>Enums</li> +<li>Exceptions</li> +<li>Errors</li> +<li>Annotation Types</li> +</ul> +</section> +<section class="help-section" id="class"> +<h3>Class or Interface</h3> +<p>Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.</p> +<ul class="help-section-list"> +<li>Class Inheritance Diagram</li> +<li>Direct Subclasses</li> +<li>All Known Subinterfaces</li> +<li>All Known Implementing Classes</li> +<li>Class or Interface Declaration</li> +<li>Class or Interface Description</li> +</ul> +<br> +<ul class="help-section-list"> +<li>Nested Class Summary</li> +<li>Enum Constant Summary</li> +<li>Field Summary</li> +<li>Property Summary</li> +<li>Constructor Summary</li> +<li>Method Summary</li> +<li>Required Element Summary</li> +<li>Optional Element Summary</li> +</ul> +<br> +<ul class="help-section-list"> +<li>Enum Constant Details</li> +<li>Field Details</li> +<li>Property Details</li> +<li>Constructor Details</li> +<li>Method Details</li> +<li>Element Details</li> +</ul> +<p><span class="help-note">Note:</span> Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.</p> +<p>The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.</p> +</section> +<section class="help-section" id="doc-file"> +<h3>Other Files</h3> +<p>Packages and modules may contain pages with additional information related to the declarations nearby.</p> +</section> +<section class="help-section" id="use"> +<h3>Use</h3> +<p>Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the USE link in the navigation bar.</p> +</section> +<section class="help-section" id="tree"> +<h3>Tree (Class Hierarchy)</h3> +<p>There is a <a href="overview-tree.html">Class Hierarchy</a> page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with <code>java.lang.Object</code>. Interfaces do not inherit from <code>java.lang.Object</code>.</p> +<ul class="help-section-list"> +<li>When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.</li> +<li>When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.</li> +</ul> +</section> +<section class="help-section" id="deprecated"> +<h3>Deprecated API</h3> +<p>The <a href="deprecated-list.html">Deprecated API</a> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to shortcomings, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</p> +</section> +<section class="help-section" id="constant-values"> +<h3>Constant Field Values</h3> +<p>The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p> +</section> +<section class="help-section" id="all-packages"> +<h3>All Packages</h3> +<p>The <a href="allpackages-index.html">All Packages</a> page contains an alphabetic index of all packages contained in the documentation.</p> +</section> +<section class="help-section" id="all-classes"> +<h3>All Classes and Interfaces</h3> +<p>The <a href="allclasses-index.html">All Classes and Interfaces</a> page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.</p> +</section> +<section class="help-section" id="index"> +<h3>Index</h3> +<p>The <a href="index-all.html">Index</a> contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as <a href="allpackages-index.html">All Packages</a>, <a href="allclasses-index.html">All Classes and Interfaces</a>.</p> +</section> +</div> +<hr> +<span class="help-footnote">This help file applies to API documentation generated by the standard doclet.</span></main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2018–2024 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html>
Added: dev/commons/release-plugin/1.8.2-RC1/site/apidocs/index-all.html ============================================================================== --- dev/commons/release-plugin/1.8.2-RC1/site/apidocs/index-all.html (added) +++ dev/commons/release-plugin/1.8.2-RC1/site/apidocs/index-all.html Tue Apr 16 00:57:05 2024 @@ -0,0 +1,584 @@ +<!DOCTYPE HTML> +<html lang="en"> +<head> +<!-- Generated by javadoc (17) --> +<title>Index (Apache Commons Release Plugin 1.8.2 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<meta name="description" content="index"> +<meta name="generator" content="javadoc/IndexWriter"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="script-dir/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="script-dir/jquery-3.6.1.min.js"></script> +<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> +</head> +<body class="index-page"> +<script type="text/javascript">var pathtoroot = "./"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="index.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="overview-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li class="nav-bar-cell1-rev">Index</li> +<li><a href="help-doc.html#index">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1>Index</h1> +</div> +<a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:L">L</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:U">U</a> <a href="#I:V">V</a> <a href="#I:W">W</a> <br><a href="allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="constant-values.html">Constant Field Values</a> +<h2 class="title" id="I:A">A</h2> +<dl class="index"> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#addToZip(java.io.File,java.io.File,java.util.zip.ZipOutputStream)" class="member-name-link">addToZip(File, File, ZipOutputStream)</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt> +<dd> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> +<div class="block">Given the <code>directoryToZip</code> we add the <code>file</code> to the ZIP archive represented by + <code>zos</code>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#ARTIFACT_TYPES_TO_DETACH" class="member-name-link">ARTIFACT_TYPES_TO_DETACH</a> - Static variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt> +<dd> +<div class="block">A list of "artifact types" in the Maven vernacular, to + be detached from the deployment.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html#artifactId" class="member-name-link">artifactId</a> - Variable in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate</a></dt> +<dd> +<div class="block">This is supposed to represent the maven artifactId.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html#artifactId" class="member-name-link">artifactId</a> - Variable in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</a></dt> +<dd> +<div class="block">The maven artifactId to use in the <code>README.vm</code> template.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#artifactSha512s" class="member-name-link">artifactSha512s</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt> +<dd> +<div class="block">A <code>SortedProperties</code> of <code>Artifact</code> â <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html"; title="class or interface in java.lang" class="external-link"><code>String</code></a> containing the sha512 signatures + for the individual artifacts, where the <code>Artifact</code> is represented as: + <code>groupId:artifactId:version:type=sha512</code>.</div> +</dd> +</dl> +<h2 class="title" id="I:B">B</h2> +<dl class="index"> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#baseDir" class="member-name-link">baseDir</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">The <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class or interface in java.io" class="external-link"><code>File</code></a> that contains a file to the root directory of the working project.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/SharedFunctions.html#BUFFER_BYTE_SIZE" class="member-name-link">BUFFER_BYTE_SIZE</a> - Static variable in class org.apache.commons.release.plugin.<a href="org/apache/commons/release/plugin/SharedFunctions.html" title="class in org.apache.commons.release.plugin">SharedFunctions</a></dt> +<dd> +<div class="block">I want a buffer that is an array with 1024 elements of bytes.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html#build()" class="member-name-link">build()</a> - Method in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder</a></dt> +<dd> +<div class="block">Builds up the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate</code></a> from the previously set parameters.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html#build()" class="member-name-link">build()</a> - Method in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</a></dt> +<dd> +<div class="block">Builds up the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate</code></a> from the previously set parameters.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html#builder()" class="member-name-link">builder()</a> - Static method in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">HeaderHtmlVelocityDelegate</a></dt> +<dd> +<div class="block">For instantiating our <a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><code>HeaderHtmlVelocityDelegate</code></a> using the <a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity"><code>HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder</code></a>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html#builder()" class="member-name-link">builder()</a> - Static method in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate</a></dt> +<dd> +<div class="block">Gets the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</code></a> for constructing the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate</code></a>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#buildReadmeAndHeaderHtmlFiles()" class="member-name-link">buildReadmeAndHeaderHtmlFiles()</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">Builds up <code>README.html</code> and <code>HEADER.html</code> that reside in following.</div> +</dd> +</dl> +<h2 class="title" id="I:C">C</h2> +<dl class="index"> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" class="type-name-link" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a> - Class in <a href="org/apache/commons/release/plugin/mojos/package-summary.html">org.apache.commons.release.plugin.mojos</a></dt> +<dd> +<div class="block">The purpose of this Maven mojo is to detach the artifacts generated by the maven-assembly-plugin, + which for the Apache Commons Project do not get uploaded to Nexus, and putting those artifacts + in the dev distribution location for Apache projects.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#%3Cinit%3E()" class="member-name-link">CommonsDistributionDetachmentMojo()</a> - Constructor for class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt> +<dd> </dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" class="type-name-link" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a> - Class in <a href="org/apache/commons/release/plugin/mojos/package-summary.html">org.apache.commons.release.plugin.mojos</a></dt> +<dd> +<div class="block">This class checks out the dev distribution location, copies the distributions into that directory + structure under the <code>target/commons-release-plugin/scm</code> directory.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#%3Cinit%3E()" class="member-name-link">CommonsDistributionStagingMojo()</a> - Constructor for class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> </dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#commonsRcVersion" class="member-name-link">commonsRcVersion</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">The RC version of the release.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#commonsReleaseVersion" class="member-name-link">commonsReleaseVersion</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">The release version of the artifact to be built.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" class="type-name-link" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a> - Class in <a href="org/apache/commons/release/plugin/mojos/package-summary.html">org.apache.commons.release.plugin.mojos</a></dt> +<dd> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> +<div class="deprecation-comment">- as we no longer wish to compress the site, we are going to put this functionality in the + <a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><code>CommonsDistributionStagingMojo</code></a>.</div> +</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#%3Cinit%3E()" class="member-name-link">CommonsSiteCompressionMojo()</a> - Constructor for class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt> +<dd> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> + </dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html" class="type-name-link" title="class in org.apache.commons.release.plugin.mojos">CommonsStagingCleanupMojo</a> - Class in <a href="org/apache/commons/release/plugin/mojos/package-summary.html">org.apache.commons.release.plugin.mojos</a></dt> +<dd> +<div class="block">This class checks out the dev distribution location, checks whether anything exists in the + distribution location, and if it is non-empty it deletes all the resources there.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html#%3Cinit%3E()" class="member-name-link">CommonsStagingCleanupMojo()</a> - Constructor for class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsStagingCleanupMojo</a></dt> +<dd> </dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#copyDistributionsIntoScmDirectoryStructureAndAddToSvn(java.io.File,org.apache.maven.scm.provider.ScmProvider,org.apache.maven.scm.repository.ScmRepository)" class="member-name-link">copyDistributionsIntoScmDirectoryStructureAndAddToSvn(File, ScmProvider, ScmRepository)</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">Copies the list of files at the root of the <a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#workingDirectory"><code>CommonsDistributionStagingMojo.workingDirectory</code></a> into + the directory structure of the distribution staging repository.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/SharedFunctions.html#copyFile(org.apache.maven.plugin.logging.Log,java.io.File,java.io.File)" class="member-name-link">copyFile(Log, File, File)</a> - Static method in class org.apache.commons.release.plugin.<a href="org/apache/commons/release/plugin/SharedFunctions.html" title="class in org.apache.commons.release.plugin">SharedFunctions</a></dt> +<dd> +<div class="block">Copies a <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class or interface in java.io" class="external-link"><code>File</code></a> from the <code>fromFile</code> to the <code>toFile</code> and logs the failure + using the Maven <code>Log</code>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#copyHeaderAndReadmeToSubdirectories(java.io.File,java.io.File)" class="member-name-link">copyHeaderAndReadmeToSubdirectories(File, File)</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">Copies <code>README.html</code> and <code>HEADER.html</code> to the source and binaries + directories.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#copyReleaseNotesToWorkingDirectory()" class="member-name-link">copyReleaseNotesToWorkingDirectory()</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">A utility method that takes the <code>RELEASE-NOTES.txt</code> file from the base directory of the + project and copies it into <a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#workingDirectory"><code>CommonsDistributionStagingMojo.workingDirectory</code></a>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#copyRemovedArtifactsToWorkingDirectory()" class="member-name-link">copyRemovedArtifactsToWorkingDirectory()</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt> +<dd> +<div class="block">A helper method to copy the newly detached artifacts to <code>target/commons-release-plugin</code> + so that the <a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><code>CommonsDistributionStagingMojo</code></a> can find the artifacts later.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#copySignatureValidatorScriptToScmDirectory()" class="member-name-link">copySignatureValidatorScriptToScmDirectory()</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">Copies our <code>signature-validator.sh</code> script into + <code>${basedir}/target/commons-release-plugin/scm/signature-validator.sh</code>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#copySiteToScmDirectory()" class="member-name-link">copySiteToScmDirectory()</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">Copies <code>${basedir}/target/site</code> to <code>${basedir}/target/commons-release-plugin/scm/site</code>.</div> +</dd> +</dl> +<h2 class="title" id="I:D">D</h2> +<dl class="index"> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#detachedArtifacts" class="member-name-link">detachedArtifacts</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt> +<dd> +<div class="block">This list is supposed to hold the Maven references to the aforementioned artifacts so that we + can upload them to svn after they've been detached from the Maven deployment.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#distCheckoutDirectory" class="member-name-link">distCheckoutDirectory</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">The location to which to check out the dist subversion repository under our working directory, which + was given above.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html#distCleanupDirectory" class="member-name-link">distCleanupDirectory</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsStagingCleanupMojo</a></dt> +<dd> +<div class="block">The location to which to checkout the dist subversion repository under our working directory, which + was given above.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#distRcVersionDirectory" class="member-name-link">distRcVersionDirectory</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">A subdirectory of the dist directory into which we are going to stage the release candidate.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#distServer" class="member-name-link">distServer</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">The ID of the server (specified in settings.xml) which should be used for dist authentication.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html#distServer" class="member-name-link">distServer</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsStagingCleanupMojo</a></dt> +<dd> +<div class="block">The ID of the server (specified in settings.xml) which should be used for dist authentication.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#distSvnStagingUrl" class="member-name-link">distSvnStagingUrl</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt> +<dd> +<div class="block">The subversion staging url to which we upload all of our staged artifacts.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#distSvnStagingUrl" class="member-name-link">distSvnStagingUrl</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">The url of the subversion repository to which we wish the artifacts to be staged.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#distSvnStagingUrl" class="member-name-link">distSvnStagingUrl</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt> +<dd> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> +<div class="block">The url of the subversion repository to which we wish the artifacts to be staged.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html#distSvnStagingUrl" class="member-name-link">distSvnStagingUrl</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsStagingCleanupMojo</a></dt> +<dd> +<div class="block">The url of the subversion repository to which we wish the artifacts to be staged.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#dryRun" class="member-name-link">dryRun</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">A boolean that determines whether or not we actually commit the files up to the subversion repository.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html#dryRun" class="member-name-link">dryRun</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsStagingCleanupMojo</a></dt> +<dd> +<div class="block">A boolean that determines whether or not we actually commit the files up to the subversion repository.</div> +</dd> +</dl> +<h2 class="title" id="I:E">E</h2> +<dl class="index"> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#execute()" class="member-name-link">execute()</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt> +<dd> </dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#execute()" class="member-name-link">execute()</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> </dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#execute()" class="member-name-link">execute()</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt> +<dd> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> + </dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html#execute()" class="member-name-link">execute()</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsStagingCleanupMojo</a></dt> +<dd> </dd> +</dl> +<h2 class="title" id="I:F">F</h2> +<dl class="index"> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#filesToCompress" class="member-name-link">filesToCompress</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt> +<dd> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> +<div class="block">The list of files to compress into the site.zip file.</div> +</dd> +</dl> +<h2 class="title" id="I:G">G</h2> +<dl class="index"> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#getAllSiteFiles(java.io.File,java.util.List)" class="member-name-link">getAllSiteFiles(File, List<File>)</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt> +<dd> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> +<div class="block">By default this method iterates across the <code>target/site</code> directory and adds all the files + to the <a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#filesToCompress"><code>CommonsSiteCompressionMojo.filesToCompress</code></a> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html"; title="class or interface in java.util" class="external-link"><code>List</code></a>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#getArtifactKey(org.apache.maven.artifact.Artifact)" class="member-name-link">getArtifactKey(Artifact)</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt> +<dd> +<div class="block">Generates the unique artifact key for storage in our sha512 map.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#getSha512FilePath(java.io.File,java.io.File)" class="member-name-link">getSha512FilePath(File, File)</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt> +<dd> +<div class="block">A helper method to create a file path for the <code>sha512</code> signature file from a given file.</div> +</dd> +</dl> +<h2 class="title" id="I:H">H</h2> +<dl class="index"> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#hashArtifacts()" class="member-name-link">hashArtifacts()</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt> +<dd> +<div class="block">A helper method that creates sha512 signature files for our detached artifacts in the + <code>target/commons-release-plugin</code> directory for the purpose of being uploaded by + the <a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><code>CommonsDistributionStagingMojo</code></a>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#HEADER_FILE_NAME" class="member-name-link">HEADER_FILE_NAME</a> - Static variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">The name of file generated from the HEADER.vm velocity template to be checked into the dist svn repo.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html" class="type-name-link" title="class in org.apache.commons.release.plugin.velocity">HeaderHtmlVelocityDelegate</a> - Class in <a href="org/apache/commons/release/plugin/velocity/package-summary.html">org.apache.commons.release.plugin.velocity</a></dt> +<dd> +<div class="block">This class' purpose is to generate the <code>HEADER.html</code> that moves along with the + release for the sake of downloading the release from the distribution area.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html#%3Cinit%3E()" class="member-name-link">HeaderHtmlVelocityDelegate()</a> - Constructor for class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">HeaderHtmlVelocityDelegate</a></dt> +<dd> +<div class="block">The private constructor to be used by the <a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity"><code>HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder</code></a>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html" class="type-name-link" title="class in org.apache.commons.release.plugin.velocity">HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder</a> - Class in <a href="org/apache/commons/release/plugin/velocity/package-summary.html">org.apache.commons.release.plugin.velocity</a></dt> +<dd> +<div class="block">A builder class for instantiation of the <a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><code>HeaderHtmlVelocityDelegate</code></a>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html#%3Cinit%3E()" class="member-name-link">HeaderHtmlVelocityDelegateBuilder()</a> - Constructor for class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder</a></dt> +<dd> +<div class="block">Private constructor so that we can have a proper builder pattern.</div> +</dd> +</dl> +<h2 class="title" id="I:I">I</h2> +<dl class="index"> +<dt><a href="org/apache/commons/release/plugin/SharedFunctions.html#initDirectory(org.apache.maven.plugin.logging.Log,java.io.File)" class="member-name-link">initDirectory(Log, File)</a> - Static method in class org.apache.commons.release.plugin.<a href="org/apache/commons/release/plugin/SharedFunctions.html" title="class in org.apache.commons.release.plugin">SharedFunctions</a></dt> +<dd> +<div class="block">Cleans and then initializes an empty directory that is given by the <code>workingDirectory</code> + parameter.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#isDistModule" class="member-name-link">isDistModule</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt> +<dd> +<div class="block">A parameter to generally avoid running unless it is specifically turned on by the consuming module.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#isDistModule" class="member-name-link">isDistModule</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">A parameter to generally avoid running unless it is specifically turned on by the consuming module.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#isDistModule" class="member-name-link">isDistModule</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt> +<dd> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> +<div class="block">A parameter to generally avoid running unless it is specifically turned on by the consuming module.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html#isDistModule" class="member-name-link">isDistModule</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsStagingCleanupMojo</a></dt> +<dd> +<div class="block">A parameter to generally avoid running unless it is specifically turned on by the consuming module.</div> +</dd> +</dl> +<h2 class="title" id="I:L">L</h2> +<dl class="index"> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#listNotHiddenFilesAndDirectories(java.io.File,java.util.List)" class="member-name-link">listNotHiddenFilesAndDirectories(File, List<File>)</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">Lists all directories and files to a flat list.</div> +</dd> +</dl> +<h2 class="title" id="I:O">O</h2> +<dl class="index"> +<dt><a href="org/apache/commons/release/plugin/package-summary.html">org.apache.commons.release.plugin</a> - package org.apache.commons.release.plugin</dt> +<dd> +<div class="block">Base package for the commons-release-plugin.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/package-summary.html">org.apache.commons.release.plugin.mojos</a> - package org.apache.commons.release.plugin.mojos</dt> +<dd> +<div class="block">This package contains all the maven mojos for the commons-release-plugin.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/package-summary.html">org.apache.commons.release.plugin.velocity</a> - package org.apache.commons.release.plugin.velocity</dt> +<dd> +<div class="block">Contains classes that take our velocity templates and render's them to a <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html"; title="class or interface in java.io" class="external-link"><code>Writer</code></a> + class.</div> +</dd> +</dl> +<h2 class="title" id="I:P">P</h2> +<dl class="index"> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#password" class="member-name-link">password</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">The password associated with <a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#username"><code>CommonsDistributionStagingMojo.username</code></a>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html#password" class="member-name-link">password</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsStagingCleanupMojo</a></dt> +<dd> +<div class="block">The password associated with <a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#username"><code>CommonsDistributionStagingMojo.username</code></a>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#project" class="member-name-link">project</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt> +<dd> +<div class="block">The maven project context injection so that we can get a hold of the variables at hand.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#project" class="member-name-link">project</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">The <code>MavenProject</code> object is essentially the context of the maven build at + a given time.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html#project" class="member-name-link">project</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsStagingCleanupMojo</a></dt> +<dd> +<div class="block">The <code>MavenProject</code> object is essentially the context of the maven build at + a given time.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#putAttachedArtifactInSha512Map(org.apache.maven.artifact.Artifact)" class="member-name-link">putAttachedArtifactInSha512Map(Artifact)</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt> +<dd> +<div class="block">Takes an attached artifact and puts the signature in the map.</div> +</dd> +</dl> +<h2 class="title" id="I:R">R</h2> +<dl class="index"> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#README_FILE_NAME" class="member-name-link">README_FILE_NAME</a> - Static variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">The name of file generated from the README.vm velocity template to be checked into the dist svn repo.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" class="type-name-link" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate</a> - Class in <a href="org/apache/commons/release/plugin/velocity/package-summary.html">org.apache.commons.release.plugin.velocity</a></dt> +<dd> +<div class="block">This class' purpose is to generate the <code>README.html</code> that moves along with the + release for the sake of downloading the release from the distribution area.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">ReadmeHtmlVelocityDelegate(String, String, String)</a> - Constructor for class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate</a></dt> +<dd> +<div class="block">The private constructor to be used by the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</code></a>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" class="type-name-link" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</a> - Class in <a href="org/apache/commons/release/plugin/velocity/package-summary.html">org.apache.commons.release.plugin.velocity</a></dt> +<dd> +<div class="block">A builder class for instantiation of the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate</code></a>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html#%3Cinit%3E()" class="member-name-link">ReadmeHtmlVelocityDelegateBuilder()</a> - Constructor for class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</a></dt> +<dd> +<div class="block">Private constructor for using the builder through the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html#builder()"><code>ReadmeHtmlVelocityDelegate.builder()</code></a> + method.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#releaseNotesFile" class="member-name-link">releaseNotesFile</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">The location of the RELEASE-NOTES.txt file such that multi-module builds can configure it.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html#render(java.io.Writer)" class="member-name-link">render(Writer)</a> - Method in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">HeaderHtmlVelocityDelegate</a></dt> +<dd> +<div class="block">Builds the HEADER.vm velocity template to the writer passed in.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html#render(java.io.Writer)" class="member-name-link">render(Writer)</a> - Method in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate</a></dt> +<dd> +<div class="block">Renders the <code>README.vm</code> velocity template with the variables constructed with the + <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</code></a>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/SharedFunctions.html#requireNonNull(T)" class="member-name-link">requireNonNull(T)</a> - Static method in class org.apache.commons.release.plugin.<a href="org/apache/commons/release/plugin/SharedFunctions.html" title="class in org.apache.commons.release.plugin">SharedFunctions</a></dt> +<dd> +<div class="block">Checks that the specified object reference is not <code>null</code>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/SharedFunctions.html#requireNonNull(T,java.lang.String)" class="member-name-link">requireNonNull(T, String)</a> - Static method in class org.apache.commons.release.plugin.<a href="org/apache/commons/release/plugin/SharedFunctions.html" title="class in org.apache.commons.release.plugin">SharedFunctions</a></dt> +<dd> +<div class="block">Checks that the specified object reference is not <code>null</code> and throws a customized <code>MojoExecutionException</code> if it is.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/SharedFunctions.html#requireNonNull(T,java.util.function.Supplier)" class="member-name-link">requireNonNull(T, Supplier<String>)</a> - Static method in class org.apache.commons.release.plugin.<a href="org/apache/commons/release/plugin/SharedFunctions.html" title="class in org.apache.commons.release.plugin">SharedFunctions</a></dt> +<dd> +<div class="block">Checks that the specified object reference is not <code>null</code> and throws a customized <code>MojoExecutionException</code> if it is.</div> +</dd> +</dl> +<h2 class="title" id="I:S">S</h2> +<dl class="index"> +<dt><a href="org/apache/commons/release/plugin/SharedFunctions.html#setAuthentication(org.apache.maven.scm.provider.ScmProviderRepository,java.lang.String,org.apache.maven.settings.Settings,org.apache.maven.settings.crypto.SettingsDecrypter,java.lang.String,java.lang.String)" class="member-name-link">setAuthentication(ScmProviderRepository, String, Settings, SettingsDecrypter, String, String)</a> - Static method in class org.apache.commons.release.plugin.<a href="org/apache/commons/release/plugin/SharedFunctions.html" title="class in org.apache.commons.release.plugin">SharedFunctions</a></dt> +<dd> +<div class="block">Sets authentication information on the specified <code>ScmProviderRepository</code>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#setBaseDir(java.io.File)" class="member-name-link">setBaseDir(File)</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">This method is the setter for the <a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#baseDir"><code>CommonsDistributionStagingMojo.baseDir</code></a> field, specifically + for the usage in the unit tests.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#settings" class="member-name-link">settings</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">Maven <code>Settings</code>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html#settings" class="member-name-link">settings</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsStagingCleanupMojo</a></dt> +<dd> +<div class="block">Maven <code>Settings</code>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#settingsDecrypter" class="member-name-link">settingsDecrypter</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">Maven <code>SettingsDecrypter</code> component.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html#settingsDecrypter" class="member-name-link">settingsDecrypter</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsStagingCleanupMojo</a></dt> +<dd> +<div class="block">Maven <code>SettingsDecrypter</code> component.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/SharedFunctions.html" class="type-name-link" title="class in org.apache.commons.release.plugin">SharedFunctions</a> - Class in <a href="org/apache/commons/release/plugin/package-summary.html">org.apache.commons.release.plugin</a></dt> +<dd> +<div class="block">Shared static functions for all of our Mojos.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/SharedFunctions.html#%3Cinit%3E()" class="member-name-link">SharedFunctions()</a> - Constructor for class org.apache.commons.release.plugin.<a href="org/apache/commons/release/plugin/SharedFunctions.html" title="class in org.apache.commons.release.plugin">SharedFunctions</a></dt> +<dd> +<div class="block">Making the constructor private because the class only contains static methods.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#SIGNATURE_VALIDATOR_NAME" class="member-name-link">SIGNATURE_VALIDATOR_NAME</a> - Static variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">The name of the signature validation shell script to be checked into the dist svn repo.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#siteDirectory" class="member-name-link">siteDirectory</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">The location to which the site gets built during running <code>mvn site</code>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#siteDirectory" class="member-name-link">siteDirectory</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt> +<dd> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> + </dd> +<dt><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html#siteUrl" class="member-name-link">siteUrl</a> - Variable in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</a></dt> +<dd> +<div class="block">The site url to use in the <code>README.vm</code> template.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html#siteUrl" class="member-name-link">siteUrl</a> - Variable in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate</a></dt> +<dd> +<div class="block">The url of the site that gets set into the <code>README.html</code>.</div> +</dd> +</dl> +<h2 class="title" id="I:T">T</h2> +<dl class="index"> +<dt><a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html#TEMPLATE" class="member-name-link">TEMPLATE</a> - Static variable in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">HeaderHtmlVelocityDelegate</a></dt> +<dd> +<div class="block">The location of the velocity template for this class.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html#TEMPLATE" class="member-name-link">TEMPLATE</a> - Static variable in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate</a></dt> +<dd> +<div class="block">The location of the velocity template for this class.</div> +</dd> +</dl> +<h2 class="title" id="I:U">U</h2> +<dl class="index"> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#username" class="member-name-link">username</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">The username for the distribution subversion repository.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html#username" class="member-name-link">username</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsStagingCleanupMojo</a></dt> +<dd> +<div class="block">The username for the distribution subversion repository.</div> +</dd> +</dl> +<h2 class="title" id="I:V">V</h2> +<dl class="index"> +<dt><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html#version" class="member-name-link">version</a> - Variable in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</a></dt> +<dd> +<div class="block">The maven version to use in the <code>README.vm</code> template.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html#version" class="member-name-link">version</a> - Variable in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate</a></dt> +<dd> +<div class="block">This is supposed to represent the maven version of the release.</div> +</dd> +</dl> +<h2 class="title" id="I:W">W</h2> +<dl class="index"> +<dt><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html#withArtifactId(java.lang.String)" class="member-name-link">withArtifactId(String)</a> - Method in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</a></dt> +<dd> +<div class="block">Adds the artifactId to the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate</code></a>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html#withSiteUrl(java.lang.String)" class="member-name-link">withSiteUrl(String)</a> - Method in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</a></dt> +<dd> +<div class="block">Adds the siteUrl to the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate</code></a>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html#withVersion(java.lang.String)" class="member-name-link">withVersion(String)</a> - Method in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</a></dt> +<dd> +<div class="block">Adds the version to the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate</code></a>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#workingDirectory" class="member-name-link">workingDirectory</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt> +<dd> +<div class="block">The working directory in <code>target</code> that we use as a sandbox for the plugin.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#workingDirectory" class="member-name-link">workingDirectory</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt> +<dd> +<div class="block">The main working directory for the plugin, namely <code>target/commons-release-plugin</code>, but + that assumes that we're using the default maven <code>${project.build.directory}</code>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#workingDirectory" class="member-name-link">workingDirectory</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt> +<dd> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> +<div class="block">The working directory for the plugin which, assuming the maven uses the default + <code>${project.build.directory}</code>, this becomes <code>target/commons-release-plugin</code>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html#workingDirectory" class="member-name-link">workingDirectory</a> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsStagingCleanupMojo</a></dt> +<dd> +<div class="block">The main working directory for the plugin, namely <code>target/commons-release-plugin</code>, but + that assumes that we're using the default maven <code>${project.build.directory}</code>.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#writeAllArtifactsInSha512PropertiesFile()" class="member-name-link">writeAllArtifactsInSha512PropertiesFile()</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt> +<dd> +<div class="block">Writes to ./target/commons-release-plugin/sha512.properties the artifact sha512's.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#writeZipFile(java.io.File,java.io.File,java.util.List)" class="member-name-link">writeZipFile(File, File, List<File>)</a> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt> +<dd> +<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> +<div class="block">A helper method for writing all the files in our <code>fileList</code> to a <code>site.zip</code> file + in the <code>workingDirectory</code>.</div> +</dd> +</dl> +<a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:L">L</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:U">U</a> <a href="#I:V">V</a> <a href="#I:W">W</a> <br><a href="allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="constant-values.html">Constant Field Values</a></main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2018–2024 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> Added: dev/commons/release-plugin/1.8.2-RC1/site/apidocs/index.html ============================================================================== --- dev/commons/release-plugin/1.8.2-RC1/site/apidocs/index.html (added) +++ dev/commons/release-plugin/1.8.2-RC1/site/apidocs/index.html Tue Apr 16 00:57:05 2024 @@ -0,0 +1,82 @@ +<!DOCTYPE HTML> +<html lang="en"> +<head> +<!-- Generated by javadoc (17) --> +<title>Overview (Apache Commons Release Plugin 1.8.2 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<meta name="description" content="package index"> +<meta name="generator" content="javadoc/PackageIndexWriter"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="script-dir/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="script-dir/jquery-3.6.1.min.js"></script> +<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> +</head> +<body class="package-index-page"> +<script type="text/javascript">var pathtoroot = "./"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li class="nav-bar-cell1-rev">Overview</li> +<li>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="overview-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#overview">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<div class="header"> +<h1 class="title">Apache Commons Release Plugin 1.8.2 API</h1> +</div> +<div id="all-packages-table"> +<div class="caption"><span>Packages</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Package</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/commons/release/plugin/package-summary.html">org.apache.commons.release.plugin</a></div> +<div class="col-last even-row-color all-packages-table all-packages-table-tab1"> +<div class="block">Base package for the commons-release-plugin.</div> +</div> +<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/commons/release/plugin/mojos/package-summary.html">org.apache.commons.release.plugin.mojos</a></div> +<div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> +<div class="block">This package contains all the maven mojos for the commons-release-plugin.</div> +</div> +<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/commons/release/plugin/velocity/package-summary.html">org.apache.commons.release.plugin.velocity</a></div> +<div class="col-last even-row-color all-packages-table all-packages-table-tab1"> +<div class="block">Contains classes that take our velocity templates and render's them to a <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html"; title="class or interface in java.io" class="external-link"><code>Writer</code></a> + class.</div> +</div> +</div> +</div> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2018–2024 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</footer> +</div> +</div> +</body> +</html> Added: dev/commons/release-plugin/1.8.2-RC1/site/apidocs/jquery-ui.overrides.css ============================================================================== --- dev/commons/release-plugin/1.8.2-RC1/site/apidocs/jquery-ui.overrides.css (added) +++ dev/commons/release-plugin/1.8.2-RC1/site/apidocs/jquery-ui.overrides.css Tue Apr 16 00:57:05 2024 @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +.ui-state-active, +.ui-widget-content .ui-state-active, +.ui-widget-header .ui-state-active, +a.ui-button:active, +.ui-button:active, +.ui-button.ui-state-active:hover { + /* Overrides the color of selection used in jQuery UI */ + background: #F8981D; + border: 1px solid #F8981D; +} Added: dev/commons/release-plugin/1.8.2-RC1/site/apidocs/legal/ADDITIONAL_LICENSE_INFO ============================================================================== --- dev/commons/release-plugin/1.8.2-RC1/site/apidocs/legal/ADDITIONAL_LICENSE_INFO (added) +++ dev/commons/release-plugin/1.8.2-RC1/site/apidocs/legal/ADDITIONAL_LICENSE_INFO Tue Apr 16 00:57:05 2024 @@ -0,0 +1,37 @@ + ADDITIONAL INFORMATION ABOUT LICENSING + +Certain files distributed by Oracle America, Inc. and/or its affiliates are +subject to the following clarification and special exception to the GPLv2, +based on the GNU Project exception for its Classpath libraries, known as the +GNU Classpath Exception. + +Note that Oracle includes multiple, independent programs in this software +package. Some of those programs are provided under licenses deemed +incompatible with the GPLv2 by the Free Software Foundation and others. +For example, the package includes programs licensed under the Apache +License, Version 2.0 and may include FreeType. Such programs are licensed +to you under their original licenses. + +Oracle facilitates your further distribution of this package by adding the +Classpath Exception to the necessary parts of its GPLv2 code, which permits +you to use that code in combination with other independent modules not +licensed under the GPLv2. However, note that this would not permit you to +commingle code under an incompatible license with Oracle's GPLv2 licensed +code by, for example, cutting and pasting such code into a file also +containing Oracle's GPLv2 licensed code and then distributing the result. + +Additionally, if you were to remove the Classpath Exception from any of the +files to which it applies and distribute the result, you would likely be +required to license some or all of the other code in that distribution under +the GPLv2 as well, and since the GPLv2 is incompatible with the license terms +of some items included in the distribution by Oracle, removing the Classpath +Exception could therefore effectively compromise your ability to further +distribute the package. + +Failing to distribute notices associated with some files may also create +unexpected legal consequences. + +Proceed with caution and we recommend that you obtain the advice of a lawyer +skilled in open source matters before removing the Classpath Exception or +making modifications to this package which may subsequently be redistributed +and/or involve the use of third party software. Added: dev/commons/release-plugin/1.8.2-RC1/site/apidocs/legal/ASSEMBLY_EXCEPTION ============================================================================== --- dev/commons/release-plugin/1.8.2-RC1/site/apidocs/legal/ASSEMBLY_EXCEPTION (added) +++ dev/commons/release-plugin/1.8.2-RC1/site/apidocs/legal/ASSEMBLY_EXCEPTION Tue Apr 16 00:57:05 2024 @@ -0,0 +1,27 @@ + +OPENJDK ASSEMBLY EXCEPTION + +The OpenJDK source code made available by Oracle America, Inc. (Oracle) at +openjdk.java.net ("OpenJDK Code") is distributed under the terms of the GNU +General Public License <http://www.gnu.org/copyleft/gpl.html> version 2 +only ("GPL2"), with the following clarification and special exception. + + Linking this OpenJDK Code statically or dynamically with other code + is making a combined work based on this library. Thus, the terms + and conditions of GPL2 cover the whole combination. + + As a special exception, Oracle gives you permission to link this + OpenJDK Code with certain code licensed by Oracle as indicated at + http://openjdk.java.net/legal/exception-modules-2007-05-08.html + ("Designated Exception Modules") to produce an executable, + regardless of the license terms of the Designated Exception Modules, + and to copy and distribute the resulting executable under GPL2, + provided that the Designated Exception Modules continue to be + governed by the licenses under which they were offered by Oracle. + +As such, it allows licensees and sublicensees of Oracle's GPL2 OpenJDK Code +to build an executable that includes those portions of necessary code that +Oracle could not provide under GPL2 (or that Oracle has provided under GPL2 +with the Classpath exception). If you modify or add to the OpenJDK code, +that new GPL2 code may still be combined with Designated Exception Modules +if the new code is made subject to this exception by its copyright holder.
