Modified:
websites/production/commons/content/proper/commons-release-plugin/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html
==============================================================================
---
websites/production/commons/content/proper/commons-release-plugin/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html
(original)
+++
websites/production/commons/content/proper/commons-release-plugin/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html
Sat Apr 20 14:51:39 2024
@@ -1,811 +1,592 @@
<!DOCTYPE HTML>
-<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc -->
-<title>CommonsDistributionStagingMojo (Apache Commons Release Plugin 1.8.1
API)</title>
+<!-- Generated by javadoc (17) -->
+<title>CommonsDistributionStagingMojo (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="declaration: package:
org.apache.commons.release.plugin.mojos, class: CommonsDistributionStagingMojo">
+<meta name="generator" content="javadoc/ClassWriterImpl">
<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="../../../../../../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="../../../../../../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>
+<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>
-<script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="CommonsDistributionStagingMojo (Apache
Commons Release Plugin 1.8.1 API)";
- }
- }
- catch(err) {
- }
-//-->
-var data =
{"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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";
+<body class="class-declaration-page">
+<script type="text/javascript">var evenRowColor = "even-row-color";
+var oddRowColor = "odd-row-color";
+var tableTab = "table-tab";
+var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../../";
-var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
-<header role="banner">
+<div class="flex-box">
+<header role="banner" class="flex-header">
<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">
+<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><a href="package-summary.html">Package</a></li>
-<li class="navBarCell1Rev">Class</li>
+<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/CommonsDistributionStagingMojo.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>
+<li><a href="../../../../../../help-doc.html#class">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 class="sub-nav">
<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">
+<ul class="sub-nav-list">
<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>
+<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">
+<ul class="sub-nav-list">
<li>Detail: </li>
-<li><a href="#field.detail">Field</a> | </li>
-<li><a href="#constructor.detail">Constr</a> | </li>
-<li><a href="#method.detail">Method</a></li>
+<li><a href="#field-detail">Field</a> | </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 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>
-<div class="navPadding"> </div>
-<script type="text/javascript"><!--
-$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
-//-->
-</script>
-</nav>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
-<!-- ======== START OF CLASS DATA ======== -->
+<div class="flex-content">
<main role="main">
+<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
-<div class="subTitle"><span class="packageLabelInType">Package</span> <a
href="package-summary.html">org.apache.commons.release.plugin.mojos</a></div>
-<h2 title="Class CommonsDistributionStagingMojo" class="title">Class
CommonsDistributionStagingMojo</h2>
+<div class="sub-title"><span
class="package-label-in-type">Package</span> <a
href="package-summary.html">org.apache.commons.release.plugin.mojos</a></div>
+<h1 title="Class CommonsDistributionStagingMojo" class="title">Class
CommonsDistributionStagingMojo</h1>
</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>org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo</li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-<div class="description">
-<ul class="blockList">
-<li class="blockList">
-<dl>
+<div class="inheritance" title="Inheritance Tree"><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html";
title="class or interface in java.lang"
class="external-link">java.lang.Object</a>
+<div class="inheritance">org.apache.maven.plugin.AbstractMojo
+<div
class="inheritance">org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo</div>
+</div>
+</div>
+<section class="class-description" id="class-description">
+<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code>org.apache.maven.plugin.ContextEnabled</code>,
<code>org.apache.maven.plugin.Mojo</code></dd>
</dl>
<hr>
-<pre>@Mojo(name="stage-distributions",
+<div class="type-signature"><span
class="annotations">@Mojo(name="stage-distributions",
defaultPhase=DEPLOY,
threadSafe=true,
aggregator=true)
-public class <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.67">CommonsDistributionStagingMojo</a>
-extends org.apache.maven.plugin.AbstractMojo</pre>
+</span><span class="modifiers">public class </span><span
class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-67">CommonsDistributionStagingMojo</a></span>
+<span class="extends-implements">extends
org.apache.maven.plugin.AbstractMojo</span></div>
<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.
Then commits the
distributions back up to SVN. Also, we include the built and zipped site as
well as the RELEASE-NOTES.txt.</div>
-<dl>
-<dt><span class="simpleTagLabel">Since:</span></dt>
+<dl class="notes">
+<dt>Since:</dt>
<dd>1.0</dd>
</dl>
-</li>
-</ul>
-</div>
-<div class="summary">
-<ul class="blockList">
-<li class="blockList">
+</section>
+<section class="summary">
+<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
-<section>
-<ul class="blockList">
-<li class="blockList"><a id="field.summary">
-<!-- -->
-</a>
-<h3>Field Summary</h3>
-<table class="memberSummary">
-<caption><span>Fields</span><span class="tabEnd"> </span></caption>
-<tr>
-<th class="colFirst" scope="col">Modifier and Type</th>
-<th class="colSecond" scope="col">Field</th>
-<th class="colLast" scope="col">Description</th>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>private <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="#baseDir">baseDir</a></span></code></th>
-<td class="colLast">
-<div class="block">The <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"><code>File</code></a> that contains a file to the root
directory of the working project.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang"
class="externalLink">String</a></code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#commonsRcVersion">commonsRcVersion</a></span></code></th>
-<td class="colLast">
+<li>
+<section class="field-summary" id="field-summary">
+<h2>Field Summary</h2>
+<div class="caption"><span>Fields</span></div>
+<div class="summary-table three-column-summary">
+<div class="table-header col-first">Modifier and Type</div>
+<div class="table-header col-second">Field</div>
+<div class="table-header col-last">Description</div>
+<div class="col-first even-row-color"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io" class="external-link">File</a></code></div>
+<div class="col-second even-row-color"><code><a href="#baseDir"
class="member-name-link">baseDir</a></code></div>
+<div class="col-last even-row-color">
+<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>
+</div>
+<div class="col-first odd-row-color"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html";
title="class or interface in java.lang"
class="external-link">String</a></code></div>
+<div class="col-second odd-row-color"><code><a href="#commonsRcVersion"
class="member-name-link">commonsRcVersion</a></code></div>
+<div class="col-last odd-row-color">
<div class="block">The RC version of the release.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang"
class="externalLink">String</a></code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#commonsReleaseVersion">commonsReleaseVersion</a></span></code></th>
-<td class="colLast">
+</div>
+<div class="col-first even-row-color"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html";
title="class or interface in java.lang"
class="external-link">String</a></code></div>
+<div class="col-second even-row-color"><code><a href="#commonsReleaseVersion"
class="member-name-link">commonsReleaseVersion</a></code></div>
+<div class="col-last even-row-color">
<div class="block">The release version of the artifact to be built.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>private <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="#distCheckoutDirectory">distCheckoutDirectory</a></span></code></th>
-<td class="colLast">
+</div>
+<div class="col-first odd-row-color"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io" class="external-link">File</a></code></div>
+<div class="col-second odd-row-color"><code><a href="#distCheckoutDirectory"
class="member-name-link">distCheckoutDirectory</a></code></div>
+<div class="col-last odd-row-color">
<div class="block">The location to which to check out the dist subversion
repository under our working directory, which
was given above.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>private <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="#distRcVersionDirectory">distRcVersionDirectory</a></span></code></th>
-<td class="colLast">
+</div>
+<div class="col-first even-row-color"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io" class="external-link">File</a></code></div>
+<div class="col-second even-row-color"><code><a href="#distRcVersionDirectory"
class="member-name-link">distRcVersionDirectory</a></code></div>
+<div class="col-last even-row-color">
<div class="block">A subdirectory of the dist directory into which we are
going to stage the release candidate.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang"
class="externalLink">String</a></code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#distServer">distServer</a></span></code></th>
-<td class="colLast">
+</div>
+<div class="col-first odd-row-color"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html";
title="class or interface in java.lang"
class="external-link">String</a></code></div>
+<div class="col-second odd-row-color"><code><a href="#distServer"
class="member-name-link">distServer</a></code></div>
+<div class="col-last odd-row-color">
<div class="block">The ID of the server (specified in settings.xml) which
should be used for dist authentication.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang"
class="externalLink">String</a></code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#distSvnStagingUrl">distSvnStagingUrl</a></span></code></th>
-<td class="colLast">
+</div>
+<div class="col-first even-row-color"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html";
title="class or interface in java.lang"
class="external-link">String</a></code></div>
+<div class="col-second even-row-color"><code><a href="#distSvnStagingUrl"
class="member-name-link">distSvnStagingUrl</a></code></div>
+<div class="col-last even-row-color">
<div class="block">The url of the subversion repository to which we wish the
artifacts to be staged.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true";
title="class or interface in java.lang"
class="externalLink">Boolean</a></code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#dryRun">dryRun</a></span></code></th>
-<td class="colLast">
+</div>
+<div class="col-first odd-row-color"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html";
title="class or interface in java.lang"
class="external-link">Boolean</a></code></div>
+<div class="col-second odd-row-color"><code><a href="#dryRun"
class="member-name-link">dryRun</a></code></div>
+<div class="col-last odd-row-color">
<div class="block">A boolean that determines whether or not we actually commit
the files up to the subversion repository.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>private static <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang"
class="externalLink">String</a></code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#HEADER_FILE_NAME">HEADER_FILE_NAME</a></span></code></th>
-<td class="colLast">
+</div>
+<div class="col-first even-row-color"><code>private static final <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html";
title="class or interface in java.lang"
class="external-link">String</a></code></div>
+<div class="col-second even-row-color"><code><a href="#HEADER_FILE_NAME"
class="member-name-link">HEADER_FILE_NAME</a></code></div>
+<div class="col-last even-row-color">
<div class="block">The name of file generated from the HEADER.vm velocity
template to be checked into the dist svn repo.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true";
title="class or interface in java.lang"
class="externalLink">Boolean</a></code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#isDistModule">isDistModule</a></span></code></th>
-<td class="colLast">
+</div>
+<div class="col-first odd-row-color"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html";
title="class or interface in java.lang"
class="external-link">Boolean</a></code></div>
+<div class="col-second odd-row-color"><code><a href="#isDistModule"
class="member-name-link">isDistModule</a></code></div>
+<div class="col-last odd-row-color">
<div class="block">A parameter to generally avoid running unless it is
specifically turned on by the consuming module.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang"
class="externalLink">String</a></code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#password">password</a></span></code></th>
-<td class="colLast">
+</div>
+<div class="col-first even-row-color"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html";
title="class or interface in java.lang"
class="external-link">String</a></code></div>
+<div class="col-second even-row-color"><code><a href="#password"
class="member-name-link">password</a></code></div>
+<div class="col-last even-row-color">
<div class="block">The password associated with <a
href="#username"><code>username</code></a>.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>private
org.apache.maven.project.MavenProject</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#project">project</a></span></code></th>
-<td class="colLast">
+</div>
+<div class="col-first odd-row-color"><code>private
org.apache.maven.project.MavenProject</code></div>
+<div class="col-second odd-row-color"><code><a href="#project"
class="member-name-link">project</a></code></div>
+<div class="col-last odd-row-color">
<div class="block">The <code>MavenProject</code> object is essentially the
context of the maven build at
a given time.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>private static <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang"
class="externalLink">String</a></code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#README_FILE_NAME">README_FILE_NAME</a></span></code></th>
-<td class="colLast">
+</div>
+<div class="col-first even-row-color"><code>private static final <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html";
title="class or interface in java.lang"
class="external-link">String</a></code></div>
+<div class="col-second even-row-color"><code><a href="#README_FILE_NAME"
class="member-name-link">README_FILE_NAME</a></code></div>
+<div class="col-last even-row-color">
<div class="block">The name of file generated from the README.vm velocity
template to be checked into the dist svn repo.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>private <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="#releaseNotesFile">releaseNotesFile</a></span></code></th>
-<td class="colLast">
+</div>
+<div class="col-first odd-row-color"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io" class="external-link">File</a></code></div>
+<div class="col-second odd-row-color"><code><a href="#releaseNotesFile"
class="member-name-link">releaseNotesFile</a></code></div>
+<div class="col-last odd-row-color">
<div class="block">The location of the RELEASE-NOTES.txt file such that
multi-module builds can configure it.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>private
org.apache.maven.settings.Settings</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#settings">settings</a></span></code></th>
-<td class="colLast">
+</div>
+<div class="col-first even-row-color"><code>private
org.apache.maven.settings.Settings</code></div>
+<div class="col-second even-row-color"><code><a href="#settings"
class="member-name-link">settings</a></code></div>
+<div class="col-last even-row-color">
<div class="block">Maven <code>Settings</code>.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>private
org.apache.maven.settings.crypto.SettingsDecrypter</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#settingsDecrypter">settingsDecrypter</a></span></code></th>
-<td class="colLast">
+</div>
+<div class="col-first odd-row-color"><code>private
org.apache.maven.settings.crypto.SettingsDecrypter</code></div>
+<div class="col-second odd-row-color"><code><a href="#settingsDecrypter"
class="member-name-link">settingsDecrypter</a></code></div>
+<div class="col-last odd-row-color">
<div class="block">Maven <code>SettingsDecrypter</code> component.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>private static <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang"
class="externalLink">String</a></code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#SIGNATURE_VALIDATOR_NAME">SIGNATURE_VALIDATOR_NAME</a></span></code></th>
-<td class="colLast">
+</div>
+<div class="col-first even-row-color"><code>private static final <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html";
title="class or interface in java.lang"
class="external-link">String</a></code></div>
+<div class="col-second even-row-color"><code><a
href="#SIGNATURE_VALIDATOR_NAME"
class="member-name-link">SIGNATURE_VALIDATOR_NAME</a></code></div>
+<div class="col-last even-row-color">
<div class="block">The name of the signature validation shell script to be
checked into the dist svn repo.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>private <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="#siteDirectory">siteDirectory</a></span></code></th>
-<td class="colLast">
+</div>
+<div class="col-first odd-row-color"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io" class="external-link">File</a></code></div>
+<div class="col-second odd-row-color"><code><a href="#siteDirectory"
class="member-name-link">siteDirectory</a></code></div>
+<div class="col-last odd-row-color">
<div class="block">The location to which the site gets built during running
<code>mvn site</code>.</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang"
class="externalLink">String</a></code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#username">username</a></span></code></th>
-<td class="colLast">
+</div>
+<div class="col-first even-row-color"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html";
title="class or interface in java.lang"
class="external-link">String</a></code></div>
+<div class="col-second even-row-color"><code><a href="#username"
class="member-name-link">username</a></code></div>
+<div class="col-last even-row-color">
<div class="block">The username for the distribution subversion
repository.</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>private <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="#workingDirectory">workingDirectory</a></span></code></th>
-<td class="colLast">
+</div>
+<div class="col-first odd-row-color"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io" class="external-link">File</a></code></div>
+<div class="col-second odd-row-color"><code><a href="#workingDirectory"
class="member-name-link">workingDirectory</a></code></div>
+<div class="col-last odd-row-color">
<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>
-</td>
-</tr>
-</table>
-<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>
+</div>
+</div>
+<div class="inherited-list">
+<h3 id="fields-inherited-from-class-org.apache.maven.plugin.Mojo">Fields
inherited from interface org.apache.maven.plugin.Mojo</h3>
+<code>ROLE</code></div>
</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()">CommonsDistributionStagingMojo</a></span>()</code></th>
-<td class="colLast"> </td>
-</tr>
-</table>
</li>
-</ul>
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<li>
+<section class="constructor-summary" id="constructor-summary">
+<h2>Constructor Summary</h2>
+<div class="caption"><span>Constructors</span></div>
+<div class="summary-table two-column-summary">
+<div class="table-header col-first">Constructor</div>
+<div class="table-header col-last">Description</div>
+<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()"
class="member-name-link">CommonsDistributionStagingMojo</a>()</code></div>
+<div class="col-last even-row-color"> </div>
+</div>
</section>
+</li>
<!-- ========== 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>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util" class="externalLink">List</a><<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="#buildReadmeAndHeaderHtmlFiles()">buildReadmeAndHeaderHtmlFiles</a></span>()</code></th>
-<td class="colLast">
+<li>
+<section class="method-summary" id="method-summary">
+<h2>Method Summary</h2>
+<div id="method-summary-table">
+<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button
id="method-summary-table-tab0" role="tab" aria-selected="true"
aria-controls="method-summary-table.tabpanel" tabindex="0"
onkeydown="switchTab(event)" onclick="show('method-summary-table',
'method-summary-table', 3)" class="active-table-tab">All
Methods</button><button id="method-summary-table-tab2" role="tab"
aria-selected="false" aria-controls="method-summary-table.tabpanel"
tabindex="-1" onkeydown="switchTab(event)"
onclick="show('method-summary-table', 'method-summary-table-tab2', 3)"
class="table-tab">Instance Methods</button><button
id="method-summary-table-tab4" role="tab" aria-selected="false"
aria-controls="method-summary-table.tabpanel" tabindex="-1"
onkeydown="switchTab(event)" onclick="show('method-summary-table',
'method-summary-table-tab4', 3)" class="table-tab">Concrete
Methods</button></div>
+<div id="method-summary-table.tabpanel" role="tabpanel">
+<div class="summary-table three-column-summary"
aria-labelledby="method-summary-table-tab0">
+<div class="table-header col-first">Modifier and Type</div>
+<div class="table-header col-second">Method</div>
+<div class="table-header col-last">Description</div>
+<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html";
title="class or interface in java.util" class="external-link">List</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">File</a>></code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#buildReadmeAndHeaderHtmlFiles()"
class="member-name-link">buildReadmeAndHeaderHtmlFiles</a>()</code></div>
+<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Builds up <code>README.html</code> and
<code>HEADER.html</code> that reside in following.</div>
-</td>
-</tr>
-<tr id="i1" class="rowColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util" class="externalLink">List</a><<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="#copyDistributionsIntoScmDirectoryStructureAndAddToSvn(java.io.File,org.apache.maven.scm.provider.ScmProvider,org.apache.maven.scm.repository.ScmRepository)">copyDistributionsIntoScmDirectoryStructureAndAddToSvn</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> copiedReleaseNotes,
-
org.apache.maven.scm.provider.ScmProvider provider,
-
org.apache.maven.scm.repository.ScmRepository repository)</code></th>
-<td class="colLast">
+</div>
+<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html";
title="class or interface in java.util" class="external-link">List</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">File</a>></code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#copyDistributionsIntoScmDirectoryStructureAndAddToSvn(java.io.File,org.apache.maven.scm.provider.ScmProvider,org.apache.maven.scm.repository.ScmRepository)"
class="member-name-link">copyDistributionsIntoScmDirectoryStructureAndAddToSvn</a><wbr>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html";
title="class or interface in java.io"
class="external-link">File</a> copiedReleaseNotes,
+ org.apache.maven.scm.provider.ScmProvider provider,
+ org.apache.maven.scm.repository.ScmRepository repository)</code></div>
+<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Copies the list of files at the root of the <a
href="#workingDirectory"><code>workingDirectory</code></a> into
the directory structure of the distribution staging repository.</div>
-</td>
-</tr>
-<tr id="i2" class="altColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util" class="externalLink">List</a><<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="#copyHeaderAndReadmeToSubdirectories(java.io.File,java.io.File)">copyHeaderAndReadmeToSubdirectories</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> headerFile,
- <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> readmeFile)</code></th>
-<td class="colLast">
+</div>
+<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html";
title="class or interface in java.util" class="external-link">List</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">File</a>></code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#copyHeaderAndReadmeToSubdirectories(java.io.File,java.io.File)"
class="member-name-link">copyHeaderAndReadmeToSubdirectories</a><wbr>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io" class="external-link">File</a> headerFile,
+ <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html";
title="class or interface in java.io"
class="external-link">File</a> readmeFile)</code></div>
+<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Copies <code>README.html</code> and
<code>HEADER.html</code> to the source and binaries
directories.</div>
-</td>
-</tr>
-<tr id="i3" class="rowColor">
-<td class="colFirst"><code>private <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="#copyReleaseNotesToWorkingDirectory()">copyReleaseNotesToWorkingDirectory</a></span>()</code></th>
-<td class="colLast">
+</div>
+<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io" class="external-link">File</a></code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#copyReleaseNotesToWorkingDirectory()"
class="member-name-link">copyReleaseNotesToWorkingDirectory</a>()</code></div>
+<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
<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="#workingDirectory"><code>workingDirectory</code></a>.</div>
-</td>
-</tr>
-<tr id="i4" class="altColor">
-<td class="colFirst"><code>private <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="#copySignatureValidatorScriptToScmDirectory()">copySignatureValidatorScriptToScmDirectory</a></span>()</code></th>
-<td class="colLast">
+</div>
+<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io" class="external-link">File</a></code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#copySignatureValidatorScriptToScmDirectory()"
class="member-name-link">copySignatureValidatorScriptToScmDirectory</a>()</code></div>
+<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Copies our <code>signature-validator.sh</code> script into
<code>${basedir}/target/commons-release-plugin/scm/signature-validator.sh</code>.</div>
-</td>
-</tr>
-<tr id="i5" class="rowColor">
-<td class="colFirst"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util" class="externalLink">List</a><<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="#copySiteToScmDirectory()">copySiteToScmDirectory</a></span>()</code></th>
-<td class="colLast">
+</div>
+<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html";
title="class or interface in java.util" class="external-link">List</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">File</a>></code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#copySiteToScmDirectory()"
class="member-name-link">copySiteToScmDirectory</a>()</code></div>
+<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Copies <code>${basedir}/target/site</code> to
<code>${basedir}/target/commons-release-plugin/scm/site</code>.</div>
-</td>
-</tr>
-<tr id="i6" class="altColor">
-<td class="colFirst"><code>void</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#execute()">execute</a></span>()</code></th>
-<td class="colLast"> </td>
-</tr>
-<tr id="i7" class="rowColor">
-<td class="colFirst"><code>private void</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#listNotHiddenFilesAndDirectories(java.io.File,java.util.List)">listNotHiddenFilesAndDirectories</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> directory,
- <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util" class="externalLink">List</a><<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>> files)</code></th>
-<td class="colLast">
+</div>
+<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute()"
class="member-name-link">execute</a>()</code></div>
+<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"> </div>
+<div class="col-first odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>private
void</code></div>
+<div class="col-second odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#listNotHiddenFilesAndDirectories(java.io.File,java.util.List)"
class="member-name-link">listNotHiddenFilesAndDirectories</a><wbr>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io" class="external-link">File</a> directory,
+ <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html";
title="class or interface in java.util" class="external-link">List</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">File</a>> files)</code></div>
+<div class="col-last odd-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Lists all directories and files to a flat list.</div>
-</td>
-</tr>
-<tr id="i8" class="altColor">
-<td class="colFirst"><code>protected void</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a
href="#setBaseDir(java.io.File)">setBaseDir</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> baseDir)</code></th>
-<td class="colLast">
+</div>
+<div class="col-first even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code>protected
void</code></div>
+<div class="col-second even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4"><code><a
href="#setBaseDir(java.io.File)"
class="member-name-link">setBaseDir</a><wbr>(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io"
class="external-link">File</a> baseDir)</code></div>
+<div class="col-last even-row-color method-summary-table
method-summary-table-tab2 method-summary-table-tab4">
<div class="block">This method is the setter for the <a
href="#baseDir"><code>baseDir</code></a> field, specifically
for the usage in the unit tests.</div>
-</td>
-</tr>
-</table>
-<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>
+</div>
+</div>
+</div>
+</div>
+<div class="inherited-list">
+<h3
id="methods-inherited-from-class-org.apache.maven.plugin.AbstractMojo">Methods
inherited from class org.apache.maven.plugin.AbstractMojo</h3>
+<code>getLog, getPluginContext, setLog, setPluginContext</code></div>
+<div class="inherited-list">
+<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from
class java.lang.<a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html";
title="class or interface in java.lang" class="external-link">Object</a></h3>
+<code><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--";
title="class or interface in java.lang" class="external-link">clone</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-";
title="class or interface in java.lang" class="external-link">equals</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--";
title="class or interface in java.lang" class="external-link">finalize</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--";
title="class or interface in java.lang" class="external-link">getClass</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--";
title="class or interface in java.lang" class="external-link">hashCode</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--";
title="class or interface in java.lang" class="external-link">notify</a>, <a
href="https://docs.o
racle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or
interface in java.lang" class="external-link">notifyAll</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--";
title="class or interface in java.lang" class="external-link">toString</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--";
title="class or interface in java.lang" class="external-link">wait</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-";
title="class or interface in java.lang" class="external-link">wait</a>, <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-";
title="class or interface in java.lang"
class="external-link">wait</a></code></div>
</section>
</li>
</ul>
-</div>
-<div class="details">
-<ul class="blockList">
-<li class="blockList">
+</section>
+<section class="details">
+<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
-<section>
-<ul class="blockList">
-<li class="blockList"><a id="field.detail">
-<!-- -->
-</a>
-<h3>Field Detail</h3>
-<a id="README_FILE_NAME">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>README_FILE_NAME</h4>
-<pre>private static final <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang" class="externalLink">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.74">README_FILE_NAME</a></pre>
+<li>
+<section class="field-details" id="field-detail">
+<h2>Field Details</h2>
+<ul class="member-list">
+<li>
+<section class="detail" id="README_FILE_NAME">
+<h3>README_FILE_NAME</h3>
+<div class="member-signature"><span class="modifiers">private static
final</span> <span class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html";
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-74">README_FILE_NAME</a></span></div>
<div class="block">The name of file generated from the README.vm velocity
template to be checked into the dist svn repo.</div>
-<dl>
-<dt><span class="seeLabel">See Also:</span></dt>
-<dd><a
href="../../../../../../constant-values.html#org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo.README_FILE_NAME">Constant
Field Values</a></dd>
+<dl class="notes">
+<dt>See Also:</dt>
+<dd>
+<ul class="see-list">
+<li><a
href="../../../../../../constant-values.html#org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo.README_FILE_NAME">Constant
Field Values</a></li>
+</ul>
+</dd>
</dl>
+</section>
</li>
-</ul>
-<a id="HEADER_FILE_NAME">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>HEADER_FILE_NAME</h4>
-<pre>private static final <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang" class="externalLink">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.77">HEADER_FILE_NAME</a></pre>
+<li>
+<section class="detail" id="HEADER_FILE_NAME">
+<h3>HEADER_FILE_NAME</h3>
+<div class="member-signature"><span class="modifiers">private static
final</span> <span class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html";
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-77">HEADER_FILE_NAME</a></span></div>
<div class="block">The name of file generated from the HEADER.vm velocity
template to be checked into the dist svn repo.</div>
-<dl>
-<dt><span class="seeLabel">See Also:</span></dt>
-<dd><a
href="../../../../../../constant-values.html#org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo.HEADER_FILE_NAME">Constant
Field Values</a></dd>
+<dl class="notes">
+<dt>See Also:</dt>
+<dd>
+<ul class="see-list">
+<li><a
href="../../../../../../constant-values.html#org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo.HEADER_FILE_NAME">Constant
Field Values</a></li>
+</ul>
+</dd>
</dl>
+</section>
</li>
-</ul>
-<a id="SIGNATURE_VALIDATOR_NAME">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>SIGNATURE_VALIDATOR_NAME</h4>
-<pre>private static final <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang" class="externalLink">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.80">SIGNATURE_VALIDATOR_NAME</a></pre>
+<li>
+<section class="detail" id="SIGNATURE_VALIDATOR_NAME">
+<h3>SIGNATURE_VALIDATOR_NAME</h3>
+<div class="member-signature"><span class="modifiers">private static
final</span> <span class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html";
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-80">SIGNATURE_VALIDATOR_NAME</a></span></div>
<div class="block">The name of the signature validation shell script to be
checked into the dist svn repo.</div>
-<dl>
-<dt><span class="seeLabel">See Also:</span></dt>
-<dd><a
href="../../../../../../constant-values.html#org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo.SIGNATURE_VALIDATOR_NAME">Constant
Field Values</a></dd>
+<dl class="notes">
+<dt>See Also:</dt>
+<dd>
+<ul class="see-list">
+<li><a
href="../../../../../../constant-values.html#org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo.SIGNATURE_VALIDATOR_NAME">Constant
Field Values</a></li>
+</ul>
+</dd>
</dl>
+</section>
</li>
-</ul>
-<a id="project">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>project</h4>
-<pre>@Parameter(defaultValue="${project}",
+<li>
+<section class="detail" id="project">
+<h3>project</h3>
+<div class="member-signature"><span
class="annotations">@Parameter(defaultValue="${project}",
required=true)
-private org.apache.maven.project.MavenProject <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.85">project</a></pre>
+</span><span class="modifiers">private</span> <span
class="return-type">org.apache.maven.project.MavenProject</span> <span
class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-85">project</a></span></div>
<div class="block">The <code>MavenProject</code> object is essentially the
context of the maven build at
a given time.</div>
+</section>
</li>
-</ul>
-<a id="baseDir">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>baseDir</h4>
-<pre>@Parameter(defaultValue="${basedir}")
-private <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> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.92">baseDir</a></pre>
-<div class="block">The <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"><code>File</code></a> that contains a file to the root
directory of the working project. Typically
+<li>
+<section class="detail" id="baseDir">
+<h3>baseDir</h3>
+<div class="member-signature"><span
class="annotations">@Parameter(defaultValue="${basedir}")
+</span><span class="modifiers">private</span> <span
class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io" class="external-link">File</a></span> <span
class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-92">baseDir</a></span></div>
+<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. Typically
this directory is where the <code>pom.xml</code> resides.</div>
+</section>
</li>
-</ul>
-<a id="siteDirectory">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>siteDirectory</h4>
-<pre>@Parameter(defaultValue="${project.build.directory}/site",
+<li>
+<section class="detail" id="siteDirectory">
+<h3>siteDirectory</h3>
+<div class="member-signature"><span
class="annotations">@Parameter(defaultValue="${project.build.directory}/site",
property="commons.siteOutputDirectory")
-private <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> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.96">siteDirectory</a></pre>
+</span><span class="modifiers">private</span> <span
class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io" class="external-link">File</a></span> <span
class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-96">siteDirectory</a></span></div>
<div class="block">The location to which the site gets built during running
<code>mvn site</code>.</div>
+</section>
</li>
-</ul>
-<a id="workingDirectory">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>workingDirectory</h4>
-<pre>@Parameter(defaultValue="${project.build.directory}/commons-release-plugin",
+<li>
+<section class="detail" id="workingDirectory">
+<h3>workingDirectory</h3>
+<div class="member-signature"><span
class="annotations">@Parameter(defaultValue="${project.build.directory}/commons-release-plugin",
property="commons.outputDirectory")
-private <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> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.103">workingDirectory</a></pre>
+</span><span class="modifiers">private</span> <span
class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io" class="external-link">File</a></span> <span
class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-103">workingDirectory</a></span></div>
<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>
+</section>
</li>
-</ul>
-<a id="distCheckoutDirectory">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>distCheckoutDirectory</h4>
-<pre>@Parameter(defaultValue="${project.build.directory}/commons-release-plugin/scm",
+<li>
+<section class="detail" id="distCheckoutDirectory">
+<h3>distCheckoutDirectory</h3>
+<div class="member-signature"><span
class="annotations">@Parameter(defaultValue="${project.build.directory}/commons-release-plugin/scm",
property="commons.distCheckoutDirectory")
-private <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> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.110">distCheckoutDirectory</a></pre>
+</span><span class="modifiers">private</span> <span
class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io" class="external-link">File</a></span> <span
class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-110">distCheckoutDirectory</a></span></div>
<div class="block">The location to which to check out the dist subversion
repository under our working directory, which
was given above.</div>
+</section>
</li>
-</ul>
-<a id="releaseNotesFile">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>releaseNotesFile</h4>
-<pre>@Parameter(defaultValue="${basedir}/RELEASE-NOTES.txt",
+<li>
+<section class="detail" id="releaseNotesFile">
+<h3>releaseNotesFile</h3>
+<div class="member-signature"><span
class="annotations">@Parameter(defaultValue="${basedir}/RELEASE-NOTES.txt",
property="commons.releaseNotesLocation")
-private <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> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.117">releaseNotesFile</a></pre>
+</span><span class="modifiers">private</span> <span
class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io" class="external-link">File</a></span> <span
class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-117">releaseNotesFile</a></span></div>
<div class="block">The location of the RELEASE-NOTES.txt file such that
multi-module builds can configure it.</div>
+</section>
</li>
-</ul>
-<a id="dryRun">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>dryRun</h4>
-<pre>@Parameter(property="commons.release.dryRun",
+<li>
+<section class="detail" id="dryRun">
+<h3>dryRun</h3>
+<div class="member-signature"><span
class="annotations">@Parameter(property="commons.release.dryRun",
defaultValue="false")
-private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true";
title="class or interface in java.lang" class="externalLink">Boolean</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.125">dryRun</a></pre>
+</span><span class="modifiers">private</span> <span
class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html";
title="class or interface in java.lang"
class="external-link">Boolean</a></span> <span class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-125">dryRun</a></span></div>
<div class="block">A boolean that determines whether or not we actually commit
the files up to the subversion repository.
If this is set to <code>true</code>, we do all but make the commits. We do
checkout the repository in question
though.</div>
+</section>
</li>
-</ul>
-<a id="distSvnStagingUrl">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>distSvnStagingUrl</h4>
-<pre>@Parameter(defaultValue="",
+<li>
+<section class="detail" id="distSvnStagingUrl">
+<h3>distSvnStagingUrl</h3>
+<div class="member-signature"><span
class="annotations">@Parameter(defaultValue="",
property="commons.distSvnStagingUrl")
-private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang" class="externalLink">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.133">distSvnStagingUrl</a></pre>
+</span><span class="modifiers">private</span> <span
class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html";
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-133">distSvnStagingUrl</a></span></div>
<div class="block">The url of the subversion repository to which we wish the
artifacts to be staged. Typically this would need to
be of the form:
<code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo/version-RC#</code>.
Note. that
the prefix to the substring <code>https</code> is a requirement.</div>
+</section>
</li>
-</ul>
-<a id="isDistModule">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>isDistModule</h4>
-<pre>@Parameter(defaultValue="false",
+<li>
+<section class="detail" id="isDistModule">
+<h3>isDistModule</h3>
+<div class="member-signature"><span
class="annotations">@Parameter(defaultValue="false",
property="commons.release.isDistModule")
-private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true";
title="class or interface in java.lang" class="externalLink">Boolean</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.139">isDistModule</a></pre>
+</span><span class="modifiers">private</span> <span
class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html";
title="class or interface in java.lang"
class="external-link">Boolean</a></span> <span class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-139">isDistModule</a></span></div>
<div class="block">A parameter to generally avoid running unless it is
specifically turned on by the consuming module.</div>
+</section>
</li>
-</ul>
-<a id="commonsReleaseVersion">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>commonsReleaseVersion</h4>
-<pre>@Parameter(property="commons.release.version")
-private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang" class="externalLink">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.145">commonsReleaseVersion</a></pre>
+<li>
+<section class="detail" id="commonsReleaseVersion">
+<h3>commonsReleaseVersion</h3>
+<div class="member-signature"><span
class="annotations">@Parameter(property="commons.release.version")
+</span><span class="modifiers">private</span> <span
class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html";
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-145">commonsReleaseVersion</a></span></div>
<div class="block">The release version of the artifact to be built.</div>
+</section>
</li>
-</ul>
-<a id="commonsRcVersion">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>commonsRcVersion</h4>
-<pre>@Parameter(property="commons.rc.version")
-private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang" class="externalLink">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.151">commonsRcVersion</a></pre>
+<li>
+<section class="detail" id="commonsRcVersion">
+<h3>commonsRcVersion</h3>
+<div class="member-signature"><span
class="annotations">@Parameter(property="commons.rc.version")
+</span><span class="modifiers">private</span> <span
class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html";
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-151">commonsRcVersion</a></span></div>
<div class="block">The RC version of the release. For example the first voted
on candidate would be "RC1".</div>
+</section>
</li>
-</ul>
-<a id="distServer">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>distServer</h4>
-<pre>@Parameter(property="commons.distServer")
-private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang" class="externalLink">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.158">distServer</a></pre>
+<li>
+<section class="detail" id="distServer">
+<h3>distServer</h3>
+<div class="member-signature"><span
class="annotations">@Parameter(property="commons.distServer")
+</span><span class="modifiers">private</span> <span
class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html";
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-158">distServer</a></span></div>
<div class="block">The ID of the server (specified in settings.xml) which
should be used for dist authentication.
This will be used in preference to <a
href="#username"><code>username</code></a>/<a
href="#password"><code>password</code></a>.</div>
+</section>
</li>
-</ul>
-<a id="username">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>username</h4>
-<pre>@Parameter(property="user.name")
-private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang" class="externalLink">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.164">username</a></pre>
+<li>
+<section class="detail" id="username">
+<h3>username</h3>
+<div class="member-signature"><span
class="annotations">@Parameter(property="user.name")
+</span><span class="modifiers">private</span> <span
class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html";
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-164">username</a></span></div>
<div class="block">The username for the distribution subversion repository.
This is typically your Apache id.</div>
+</section>
</li>
-</ul>
-<a id="password">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>password</h4>
-<pre>@Parameter(property="user.password")
-private <a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang" class="externalLink">String</a> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.170">password</a></pre>
+<li>
+<section class="detail" id="password">
+<h3>password</h3>
+<div class="member-signature"><span
class="annotations">@Parameter(property="user.password")
+</span><span class="modifiers">private</span> <span
class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html";
title="class or interface in java.lang"
class="external-link">String</a></span> <span class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-170">password</a></span></div>
<div class="block">The password associated with <a
href="#username"><code>username</code></a>.</div>
+</section>
</li>
-</ul>
-<a id="settings">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>settings</h4>
-<pre>@Parameter(defaultValue="${settings}",
+<li>
+<section class="detail" id="settings">
+<h3>settings</h3>
+<div class="member-signature"><span
class="annotations">@Parameter(defaultValue="${settings}",
readonly=true,
required=true)
-private org.apache.maven.settings.Settings <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.176">settings</a></pre>
+</span><span class="modifiers">private</span> <span
class="return-type">org.apache.maven.settings.Settings</span> <span
class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-176">settings</a></span></div>
<div class="block">Maven <code>Settings</code>.</div>
+</section>
</li>
-</ul>
-<a id="settingsDecrypter">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>settingsDecrypter</h4>
-<pre>@Component
-private org.apache.maven.settings.crypto.SettingsDecrypter <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.182">settingsDecrypter</a></pre>
+<li>
+<section class="detail" id="settingsDecrypter">
+<h3>settingsDecrypter</h3>
+<div class="member-signature"><span class="annotations">@Component
+</span><span class="modifiers">private</span> <span
class="return-type">org.apache.maven.settings.crypto.SettingsDecrypter</span> <span
class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-182">settingsDecrypter</a></span></div>
<div class="block">Maven <code>SettingsDecrypter</code> component.</div>
+</section>
</li>
-</ul>
-<a id="distRcVersionDirectory">
-<!-- -->
-</a>
-<ul class="blockListLast">
-<li class="blockList">
-<h4>distRcVersionDirectory</h4>
-<pre>private <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> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.190">distRcVersionDirectory</a></pre>
+<li>
+<section class="detail" id="distRcVersionDirectory">
+<h3>distRcVersionDirectory</h3>
+<div class="member-signature"><span
class="modifiers">private</span> <span class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io" class="external-link">File</a></span> <span
class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-190">distRcVersionDirectory</a></span></div>
<div class="block">A subdirectory of the dist directory into which we are
going to stage the release candidate. We
build this up in the <a href="#execute()"><code>execute()</code></a> method.
And, for example,
the directory should look like
<code>https://dist.apache.org/repos/dist/dev/commons/text/1.4-RC1</code>.</div>
-</li>
-</ul>
+</section>
</li>
</ul>
</section>
-<!-- ========= 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>CommonsDistributionStagingMojo</h4>
-<pre>public <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.71">CommonsDistributionStagingMojo</a>()</pre>
</li>
-</ul>
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<li>
+<section class="constructor-details" id="constructor-detail">
+<h2>Constructor Details</h2>
+<ul class="member-list">
+<li>
+<section class="detail" id="<init>()">
+<h3>CommonsDistributionStagingMojo</h3>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-71">CommonsDistributionStagingMojo</a></span>()</div>
+</section>
</li>
</ul>
</section>
+</li>
<!-- ============ METHOD DETAIL ========== -->
-<section>
-<ul class="blockList">
-<li class="blockList"><a id="method.detail">
-<!-- -->
-</a>
-<h3>Method Detail</h3>
-<a id="execute()">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>execute</h4>
-<pre class="methodSignature">public void <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.192">execute</a>()
- throws org.apache.maven.plugin.MojoExecutionException,
- org.apache.maven.plugin.MojoFailureException</pre>
-<dl>
-<dt><span class="throwsLabel">Throws:</span></dt>
+<li>
+<section class="method-details" id="method-detail">
+<h2>Method Details</h2>
+<ul class="member-list">
+<li>
+<section class="detail" id="execute()">
+<h3>execute</h3>
+<div class="member-signature"><span class="modifiers">public</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-192">execute</a></span>()
+ throws <span
class="exceptions">org.apache.maven.plugin.MojoExecutionException,
+org.apache.maven.plugin.MojoFailureException</span></div>
+<dl class="notes">
+<dt>Throws:</dt>
<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
<dd><code>org.apache.maven.plugin.MojoFailureException</code></dd>
</dl>
+</section>
</li>
-</ul>
-<a id="listNotHiddenFilesAndDirectories(java.io.File,java.util.List)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>listNotHiddenFilesAndDirectories</h4>
-<pre class="methodSignature">private void <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.279">listNotHiddenFilesAndDirectories</a>​(<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> directory,
- <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util" class="externalLink">List</a><<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>> files)</pre>
+<li>
+<section class="detail"
id="listNotHiddenFilesAndDirectories(java.io.File,java.util.List)">
+<h3>listNotHiddenFilesAndDirectories</h3>
+<div class="member-signature"><span
class="modifiers">private</span> <span
class="return-type">void</span> <span class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-279">listNotHiddenFilesAndDirectories</a></span><wbr><span
class="parameters">(<a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io" class="external-link">File</a> directory,
+ <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html";
title="class or interface in java.util" class="external-link">List</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">File</a>> files)</span></div>
<div class="block">Lists all directories and files to a flat list.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>directory</code> - <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"><code>File</code></a> containing directory to list</dd>
-<dd><code>files</code> - a <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util"
class="externalLink"><code>List</code></a> of <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"><code>File</code></a> to which to append the files.</dd>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>directory</code> - <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> containing
directory to list</dd>
+<dd><code>files</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> of <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> to which
to append the files.</dd>
</dl>
+</section>
</li>
-</ul>
-<a id="copyReleaseNotesToWorkingDirectory()">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>copyReleaseNotesToWorkingDirectory</h4>
-<pre class="methodSignature">private <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> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.303">copyReleaseNotesToWorkingDirectory</a>()
- throws
org.apache.maven.plugin.MojoExecutionException</pre>
+<li>
+<section class="detail" id="copyReleaseNotesToWorkingDirectory()">
+<h3>copyReleaseNotesToWorkingDirectory</h3>
+<div class="member-signature"><span
class="modifiers">private</span> <span class="return-type"><a
href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html"; title="class
or interface in java.io" class="external-link">File</a></span> <span
class="element-name"><a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line-303">copyReleaseNotesToWorkingDirectory</a></span>()
+ throws <span
class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div>
<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="#workingDirectory"><code>workingDirectory</code></a>.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
+<dl class="notes">
+<dt>Returns:</dt>
<dd>the RELEASE-NOTES.txt file that exists in the
<code>target/commons-release-notes/scm</code>
directory for the purpose of adding it to the scm change set in the
method
- <a
href="#copyDistributionsIntoScmDirectoryStructureAndAddToSvn(java.io.File,org.apache.maven.scm.provider.ScmProvider,org.apache.maven.scm.repository.ScmRepository)"><code>copyDistributionsIntoScmDirectoryStructureAndAddToSvn(File,
- ScmProvider, ScmRepository)</code></a>.</dd>
-<dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if an <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true";
title="class or interface in java.io"
class="externalLink"><code>IOException</code></a> occurs as a wrapper so that
maven
+ <a
href="#copyDistributionsIntoScmDirectoryStructureAndAddToSvn(java.io.File,org.apache.maven.scm.provider.ScmProvider,org.apache.maven.scm.repository.ScmRepository)"><code>copyDistributionsIntoScmDirectoryStructureAndAddToSvn(File,
ScmProvider, ScmRepository)</code></a>.</dd>
+<dt>Throws:</dt>
+<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if an <a
href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html";
title="class or interface in java.io"
class="external-link"><code>IOException</code></a> occurs as a wrapper so that
maven
can properly handle the exception.</dd>
</dl>
+</section>
</li>
-</ul>
-<a
id="copyDistributionsIntoScmDirectoryStructureAndAddToSvn(java.io.File,org.apache.maven.scm.provider.ScmProvider,org.apache.maven.scm.repository.ScmRepository)">
-<!-- -->
-</a>
-<ul class="blockList">
-<li class="blockList">
-<h4>copyDistributionsIntoScmDirectoryStructureAndAddToSvn</h4>
-<pre class="methodSignature">private <a
href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true";
title="class or interface in java.util" class="externalLink">List</a><<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>> <a
href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.342">copyDistributionsIntoScmDirectoryStructureAndAddToSvn</a>​(<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> copiedReleaseNotes,
-
org.apache.maven.scm.provider.ScmProvider provider,
-
org.apache.maven.scm.repository.ScmRepository repository)
- throws
org.apache.maven.plugin.MojoExecutionException</pre>
+<li>
+<section class="detail"
id="copyDistributionsIntoScmDirectoryStructureAndAddToSvn(java.io.File,org.apache.maven.scm.provider.ScmProvider,org.apache.maven.scm.repository.ScmRepository)">
+<h3>copyDistributionsIntoScmDirectoryStructureAndAddToSvn</h3>
[... 262 lines stripped ...]
