You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ch...@apache.org on 2019/08/30 13:59:51 UTC
svn commit: r35466 [4/34] - in /dev/commons/commons-release-plugin/1.7-RC1:
./ binaries/ site/ site/apidocs/ site/apidocs/org/ site/apidocs/org/apache/
site/apidocs/org/apache/commons/ site/apidocs/org/apache/commons/release/
site/apidocs/org/apache/co...
Added: dev/commons/commons-release-plugin/1.7-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html
==============================================================================
--- dev/commons/commons-release-plugin/1.7-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html (added)
+++ dev/commons/commons-release-plugin/1.7-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html Fri Aug 30 13:59:50 2019
@@ -0,0 +1,910 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>CommonsDistributionStagingMojo (Apache Commons Release Plugin 1.7 API)</title>
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="CommonsDistributionStagingMojo (Apache Commons Release Plugin 1.7 API)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">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>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" target="_top">Frames</a></li>
+<li><a href="CommonsDistributionStagingMojo.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#field.summary">Field</a> | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field.detail">Field</a> | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.commons.release.plugin.mojos</div>
+<h2 title="Class CommonsDistributionStagingMojo" class="title">Class CommonsDistributionStagingMojo</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
+<li>
+<ul class="inheritance">
+<li>org.apache.maven.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>
+<dt>All Implemented Interfaces:</dt>
+<dd>org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo</dd>
+</dl>
+<hr>
+<br>
+<pre>@Mojo(name="stage-distributions",
+ defaultPhase=DEPLOY,
+ threadSafe=true,
+ aggregator=true)
+public class <span class="typeNameLabel">CommonsDistributionStagingMojo</span>
+extends org.apache.maven.plugin.AbstractMojo</pre>
+<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>
+<dd>1.0</dd>
+<dt><span class="simpleTagLabel">Author:</span></dt>
+<dd>chtompki</dd>
+</dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- =========== FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field.summary">
+<!-- -->
+</a>
+<h3>Field Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
+<caption><span>Fields</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Field and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#baseDir">baseDir</a></span></code>
+<div class="block">The <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#commonsRcVersion">commonsRcVersion</a></span></code>
+<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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#commonsReleaseVersion">commonsReleaseVersion</a></span></code>
+<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/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#distCheckoutDirectory">distCheckoutDirectory</a></span></code>
+<div class="block">The location to which to checkout 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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#distServer">distServer</a></span></code>
+<div class="block">The ID of the server (specified in settings.xml) which should be used for dist authentication.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#distSvnStagingUrl">distSvnStagingUrl</a></span></code>
+<div class="block">The url of the subversion repository to which we wish the artifacts to be staged.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#distVersionRcVersionDirectory">distVersionRcVersionDirectory</a></span></code>
+<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/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#dryRun">dryRun</a></span></code>
+<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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#HEADER_FILE_NAME">HEADER_FILE_NAME</a></span></code>
+<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/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#isDistModule">isDistModule</a></span></code>
+<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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#password">password</a></span></code>
+<div class="block">The password associated with <a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#username"><code>username</code></a>.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>private org.apache.maven.project.MavenProject</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#project">project</a></span></code>
+<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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#README_FILE_NAME">README_FILE_NAME</a></span></code>
+<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/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#releaseNotesFile">releaseNotesFile</a></span></code>
+<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>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#settings">settings</a></span></code>
+<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>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#settingsDecrypter">settingsDecrypter</a></span></code>
+<div class="block">Maven <code>SettingsDecrypter</code> component.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#siteDirectory">siteDirectory</a></span></code>
+<div class="block">The location to which the site gets built during running <code>mvn site</code>.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#username">username</a></span></code>
+<div class="block">The username for the distribution subversion repository.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#workingDirectory">workingDirectory</a></span></code>
+<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 name="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>
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#CommonsDistributionStagingMojo--">CommonsDistributionStagingMojo</a></span>()</code> </td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#buildReadmeAndHeaderHtmlFiles--">buildReadmeAndHeaderHtmlFiles</a></span>()</code>
+<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/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#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/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> copiedReleaseNotes,
+ org.apache.maven.scm.provider.ScmProvider provider,
+ org.apache.maven.scm.repository.ScmRepository repository)</code>
+<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>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/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#copyHeaderAndReadmeToSubdirectories-java.io.File-java.io.File-">copyHeaderAndReadmeToSubdirectories</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> headerFile,
+ <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> readmeFile)</code>
+<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/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#copyReleaseNotesToWorkingDirectory--">copyReleaseNotesToWorkingDirectory</a></span>()</code>
+<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>workingDirectory</code></a>.</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#copySiteToScmDirectory--">copySiteToScmDirectory</a></span>()</code>
+<div class="block">Copies <code>${basedir}/target/site</code> to <code>${basedir}/target/commons-release-plugin/scm/site</code>.</div>
+</td>
+</tr>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#execute--">execute</a></span>()</code> </td>
+</tr>
+<tr id="i6" class="altColor">
+<td class="colFirst"><code>private void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#listNotHiddenFilesAndDirectories-java.io.File-java.util.List-">listNotHiddenFilesAndDirectories</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directory,
+ <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>> files)</code>
+<div class="block">Lists all directories and files to a flat list.</div>
+</td>
+</tr>
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#setBaseDir-java.io.File-">setBaseDir</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> baseDir)</code>
+<div class="block">This method is the setter for the <a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#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 name="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 name="methods.inherited.from.class.java.lang.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
+<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/ja
va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ FIELD DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field.detail">
+<!-- -->
+</a>
+<h3>Field Detail</h3>
+<a name="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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> README_FILE_NAME</pre>
+<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>
+</li>
+</ul>
+<a name="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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> HEADER_FILE_NAME</pre>
+<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>
+</li>
+</ul>
+<a name="project">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>project</h4>
+<pre>@Parameter(defaultValue="${project}",
+ required=true)
+private org.apache.maven.project.MavenProject project</pre>
+<div class="block">The <code>MavenProject</code> object is essentially the context of the maven build at
+ a given time.</div>
+</li>
+</ul>
+<a name="baseDir">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>baseDir</h4>
+<pre>@Parameter(defaultValue="${basedir}")
+private <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> baseDir</pre>
+<div class="block">The <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><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>
+</li>
+</ul>
+<a name="siteDirectory">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>siteDirectory</h4>
+<pre>@Parameter(defaultValue="${project.build.directory}/site",
+ property="commons.siteOutputDirectory")
+private <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> siteDirectory</pre>
+<div class="block">The location to which the site gets built during running <code>mvn site</code>.</div>
+</li>
+</ul>
+<a name="workingDirectory">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>workingDirectory</h4>
+<pre>@Parameter(defaultValue="${project.build.directory}/commons-release-plugin",
+ property="commons.outputDirectory")
+private <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> workingDirectory</pre>
+<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>
+</li>
+</ul>
+<a name="distCheckoutDirectory">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>distCheckoutDirectory</h4>
+<pre>@Parameter(defaultValue="${project.build.directory}/commons-release-plugin/scm",
+ property="commons.distCheckoutDirectory")
+private <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> distCheckoutDirectory</pre>
+<div class="block">The location to which to checkout the dist subversion repository under our working directory, which
+ was given above.</div>
+</li>
+</ul>
+<a name="releaseNotesFile">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>releaseNotesFile</h4>
+<pre>@Parameter(defaultValue="${basedir}/RELEASE-NOTES.txt",
+ property="commons.releaseNotesLocation")
+private <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> releaseNotesFile</pre>
+<div class="block">The location of the RELEASE-NOTES.txt file such that multi-module builds can configure it.</div>
+</li>
+</ul>
+<a name="dryRun">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>dryRun</h4>
+<pre>@Parameter(property="commons.release.dryRun",
+ defaultValue="false")
+private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> dryRun</pre>
+<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>
+</li>
+</ul>
+<a name="distSvnStagingUrl">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>distSvnStagingUrl</h4>
+<pre>@Parameter(defaultValue="",
+ property="commons.distSvnStagingUrl")
+private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> distSvnStagingUrl</pre>
+<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>
+</li>
+</ul>
+<a name="isDistModule">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isDistModule</h4>
+<pre>@Parameter(defaultValue="false",
+ property="commons.release.isDistModule")
+private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> isDistModule</pre>
+<div class="block">A parameter to generally avoid running unless it is specifically turned on by the consuming module.</div>
+</li>
+</ul>
+<a name="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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> commonsReleaseVersion</pre>
+<div class="block">The release version of the artifact to be built.</div>
+</li>
+</ul>
+<a name="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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> commonsRcVersion</pre>
+<div class="block">The RC version of the release. For example the first voted on candidate would be "RC1".</div>
+</li>
+</ul>
+<a name="distServer">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>distServer</h4>
+<pre>@Parameter(property="commons.distServer")
+private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> distServer</pre>
+<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="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#username"><code>username</code></a>/<a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#password"><code>password</code></a>.</div>
+</li>
+</ul>
+<a name="username">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>username</h4>
+<pre>@Parameter(property="user.name")
+private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> username</pre>
+<div class="block">The username for the distribution subversion repository. This is typically your Apache id.</div>
+</li>
+</ul>
+<a name="password">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>password</h4>
+<pre>@Parameter(property="user.password")
+private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password</pre>
+<div class="block">The password associated with <a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#username"><code>username</code></a>.</div>
+</li>
+</ul>
+<a name="settings">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>settings</h4>
+<pre>@Parameter(defaultValue="${settings}",
+ readonly=true,
+ required=true)
+private org.apache.maven.settings.Settings settings</pre>
+<div class="block">Maven <code>Settings</code>.</div>
+</li>
+</ul>
+<a name="settingsDecrypter">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>settingsDecrypter</h4>
+<pre>@Component
+private org.apache.maven.settings.crypto.SettingsDecrypter settingsDecrypter</pre>
+<div class="block">Maven <code>SettingsDecrypter</code> component.</div>
+</li>
+</ul>
+<a name="distVersionRcVersionDirectory">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>distVersionRcVersionDirectory</h4>
+<pre>private <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> distVersionRcVersionDirectory</pre>
+<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="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#execute--"><code>execute()</code></a> method. And, for example,
+ the directory should look like <code>https://https://dist.apache.org/repos/dist/dev/commons/text/1.4-RC1</code>.</div>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="CommonsDistributionStagingMojo--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>CommonsDistributionStagingMojo</h4>
+<pre>public CommonsDistributionStagingMojo()</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="execute--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>execute</h4>
+<pre>public void execute()
+ throws org.apache.maven.plugin.MojoExecutionException,
+ org.apache.maven.plugin.MojoFailureException</pre>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
+<dd><code>org.apache.maven.plugin.MojoFailureException</code></dd>
+</dl>
+</li>
+</ul>
+<a name="listNotHiddenFilesAndDirectories-java.io.File-java.util.List-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>listNotHiddenFilesAndDirectories</h4>
+<pre>private void listNotHiddenFilesAndDirectories(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directory,
+ <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>> files)</pre>
+<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/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> containing directory to list</dd>
+<dd><code>files</code> - a <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a> of <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> to which to append the files.</dd>
+</dl>
+</li>
+</ul>
+<a name="copyReleaseNotesToWorkingDirectory--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>copyReleaseNotesToWorkingDirectory</h4>
+<pre>private <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> copyReleaseNotesToWorkingDirectory()
+ throws org.apache.maven.plugin.MojoExecutionException</pre>
+<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>workingDirectory</code></a>.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></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="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#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/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> occurs as a wrapper so that maven
+ can properly handle the exception.</dd>
+</dl>
+</li>
+</ul>
+<a name="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>private <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>> copyDistributionsIntoScmDirectoryStructureAndAddToSvn(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> copiedReleaseNotes,
+ org.apache.maven.scm.provider.ScmProvider provider,
+ org.apache.maven.scm.repository.ScmRepository repository)
+ throws org.apache.maven.plugin.MojoExecutionException</pre>
+<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>workingDirectory</code></a> into
+ the directory structure of the distribution staging repository. Specifically:
+ <ul>
+ <li>root:
+ <ul>
+ <li>site</li>
+ <li>site.zip</li>
+ <li>RELEASE-NOTES.txt</li>
+ <li>source:
+ <ul>
+ <li>-src artifacts....</li>
+ </ul>
+ </li>
+ <li>binaries:
+ <ul>
+ <li>-bin artifacts....</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ </ul></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>copiedReleaseNotes</code> - is the RELEASE-NOTES.txt file that exists in the
+ <code>target/commons-release-plugin/scm</code> directory.</dd>
+<dd><code>provider</code> - is the <code>ScmProvider</code> that we will use for adding the files we wish to commit.</dd>
+<dd><code>repository</code> - is the <code>ScmRepository</code> that we will use for adding the files that we wish to commit.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a> of <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a>'s in the directory for the purpose of adding them to the maven
+ <code>ScmFileSet</code>.</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/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> occurs so that Maven can handle it properly.</dd>
+</dl>
+</li>
+</ul>
+<a name="copySiteToScmDirectory--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>copySiteToScmDirectory</h4>
+<pre>private <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>> copySiteToScmDirectory()
+ throws org.apache.maven.plugin.MojoExecutionException</pre>
+<div class="block">Copies <code>${basedir}/target/site</code> to <code>${basedir}/target/commons-release-plugin/scm/site</code>.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a> of <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a>'s contained in
+ <code>${basedir}/target/commons-release-plugin/scm/site</code>, after the copy is complete.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if the site copying fails for some reason.</dd>
+</dl>
+</li>
+</ul>
+<a name="buildReadmeAndHeaderHtmlFiles--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>buildReadmeAndHeaderHtmlFiles</h4>
+<pre>private <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>> buildReadmeAndHeaderHtmlFiles()
+ throws org.apache.maven.plugin.MojoExecutionException</pre>
+<div class="block">Builds up <code>README.html</code> and <code>HEADER.html</code> that reside in following.
+ <ul>
+ <li>distRoot
+ <ul>
+ <li>binaries/HEADER.html (symlink)</li>
+ <li>binaries/README.html (symlink)</li>
+ <li>source/HEADER.html (symlink)</li>
+ <li>source/README.html (symlink)</li>
+ <li>HEADER.html</li>
+ <li>README.html</li>
+ </ul>
+ </li>
+ </ul></div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a> of created files above</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/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> occurs in the creation of these
+ files fails.</dd>
+</dl>
+</li>
+</ul>
+<a name="copyHeaderAndReadmeToSubdirectories-java.io.File-java.io.File-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>copyHeaderAndReadmeToSubdirectories</h4>
+<pre>private <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>> copyHeaderAndReadmeToSubdirectories(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> headerFile,
+ <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> readmeFile)
+ throws org.apache.maven.plugin.MojoExecutionException</pre>
+<div class="block">Copies <code>README.html</code> and <code>HEADER.html</code> to the source and binaries
+ directories.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>headerFile</code> - The originally created <code>HEADER.html</code> file.</dd>
+<dd><code>readmeFile</code> - The originally created <code>README.html</code> file.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a> of created files.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if the <a href="../../../../../../org/apache/commons/release/plugin/SharedFunctions.html#copyFile-org.apache.maven.plugin.logging.Log-java.io.File-java.io.File-"><code>SharedFunctions.copyFile(Log, File, File)</code></a>
+ fails.</dd>
+</dl>
+</li>
+</ul>
+<a name="setBaseDir-java.io.File-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>setBaseDir</h4>
+<pre>protected void setBaseDir(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> baseDir)</pre>
+<div class="block">This method is the setter for the <a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#baseDir"><code>baseDir</code></a> field, specifically
+ for the usage in the unit tests.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>baseDir</code> - is the <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> to be used as the project's root directory when this mojo
+ is invoked.</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">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>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" target="_top">Frames</a></li>
+<li><a href="CommonsDistributionStagingMojo.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#field.summary">Field</a> | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field.detail">Field</a> | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<p class="legalCopy"><small>Copyright © 2018–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
+</body>
+</html>
Added: dev/commons/commons-release-plugin/1.7-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html
==============================================================================
--- dev/commons/commons-release-plugin/1.7-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html (added)
+++ dev/commons/commons-release-plugin/1.7-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html Fri Aug 30 13:59:50 2019
@@ -0,0 +1,545 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>CommonsSiteCompressionMojo (Apache Commons Release Plugin 1.7 API)</title>
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
+<script type="text/javascript" src="../../../../../../script.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+ try {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="CommonsSiteCompressionMojo (Apache Commons Release Plugin 1.7 API)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":42,"i1":42,"i2":42,"i3":42};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/CommonsSiteCompressionMojo.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html" title="class in org.apache.commons.release.plugin.mojos"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" target="_top">Frames</a></li>
+<li><a href="CommonsSiteCompressionMojo.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#field.summary">Field</a> | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field.detail">Field</a> | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.commons.release.plugin.mojos</div>
+<h2 title="Class CommonsSiteCompressionMojo" class="title">Class CommonsSiteCompressionMojo</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
+<li>
+<ul class="inheritance">
+<li>org.apache.maven.plugin.AbstractMojo</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd>org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo</dd>
+</dl>
+<hr>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>
+<div class="block"><span class="deprecationComment">- 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>.</span></div>
+</div>
+<br>
+<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
+ @Mojo(name="compress-site",
+ defaultPhase=POST_SITE,
+ threadSafe=true,
+ aggregator=true)
+public class <span class="typeNameLabel">CommonsSiteCompressionMojo</span>
+extends org.apache.maven.plugin.AbstractMojo</pre>
+<div class="block">Takes the built <code>./target/site</code> directory and compresses it to
+ <code>./target/commons-release-plugin/site.zip</code>.</div>
+<dl>
+<dt><span class="simpleTagLabel">Since:</span></dt>
+<dd>1.0</dd>
+<dt><span class="simpleTagLabel">Author:</span></dt>
+<dd>chtompki</dd>
+</dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- =========== FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field.summary">
+<!-- -->
+</a>
+<h3>Field Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
+<caption><span>Fields</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Field and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#distSvnStagingUrl">distSvnStagingUrl</a></span></code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<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/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#filesToCompress">filesToCompress</a></span></code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<div class="block">The list of files to compress into the site.zip file.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#isDistModule">isDistModule</a></span></code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<div class="block">A parameter to generally avoid running unless it is specifically turned on by the consuming module.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#siteDirectory">siteDirectory</a></span></code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+ </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#workingDirectory">workingDirectory</a></span></code>
+<div class="block"><span class="deprecatedLabel">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>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="fields.inherited.from.class.org.apache.maven.plugin.Mojo">
+<!-- -->
+</a>
+<h3>Fields inherited from interface org.apache.maven.plugin.Mojo</h3>
+<code>ROLE</code></li>
+</ul>
+</li>
+</ul>
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#CommonsSiteCompressionMojo--">CommonsSiteCompressionMojo</a></span>()</code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+ </td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>private void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#addToZip-java.io.File-java.io.File-java.util.zip.ZipOutputStream-">addToZip</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directoryToZip,
+ <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file,
+ <a href="https://docs.oracle.com/javase/7/docs/api/java/util/zip/ZipOutputStream.html?is-external=true" title="class or interface in java.util.zip">ZipOutputStream</a> zos)</code>
+<div class="block"><span class="deprecatedLabel">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>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#execute--">execute</a></span>()</code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+ </td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>private void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#getAllSiteFiles-java.io.File-java.util.List-">getAllSiteFiles</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> siteDirectory,
+ <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>> filesToCompress)</code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<div class="block">By default this method iterates across the <code>target/site</code> directory and adds all of the files
+ to the <a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#filesToCompress"><code>filesToCompress</code></a> <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a>.</div>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>private void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#writeZipFile-java.io.File-java.io.File-java.util.List-">writeZipFile</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> outputDirectory,
+ <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directoryToZip,
+ <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>> fileList)</code>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<div class="block">A helper method for writing all of the files in our <code>fileList</code> to a <code>site.zip</code> file
+ in the <code>workingDirectory</code>.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.org.apache.maven.plugin.AbstractMojo">
+<!-- -->
+</a>
+<h3>Methods inherited from class org.apache.maven.plugin.AbstractMojo</h3>
+<code>getLog, getPluginContext, setLog, setPluginContext</code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
+<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/ja
va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ FIELD DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field.detail">
+<!-- -->
+</a>
+<h3>Field Detail</h3>
+<a name="workingDirectory">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>workingDirectory</h4>
+<pre>@Parameter(defaultValue="${project.build.directory}/commons-release-plugin",
+ property="commons.outputDirectory")
+private <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> workingDirectory</pre>
+<div class="block"><span class="deprecatedLabel">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>
+</li>
+</ul>
+<a name="siteDirectory">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>siteDirectory</h4>
+<pre>@Parameter(defaultValue="${project.build.directory}/site",
+ property="commons.siteOutputDirectory")
+private <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> siteDirectory</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+</li>
+</ul>
+<a name="distSvnStagingUrl">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>distSvnStagingUrl</h4>
+<pre>@Parameter(defaultValue="",
+ property="commons.distSvnStagingUrl")
+private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> distSvnStagingUrl</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<div class="block">The url of the subversion repository to which we wish the artifacts to be staged. Typicallly
+ this would need to be of the form:
+ <code>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo</code>. Note. that the prefix to the
+ substring <code>https</code> is a requirement.</div>
+</li>
+</ul>
+<a name="isDistModule">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isDistModule</h4>
+<pre>@Parameter(defaultValue="false",
+ property="commons.release.isDistModule")
+private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> isDistModule</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<div class="block">A parameter to generally avoid running unless it is specifically turned on by the consuming module.</div>
+</li>
+</ul>
+<a name="filesToCompress">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>filesToCompress</h4>
+<pre>private <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>> filesToCompress</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<div class="block">The list of files to compress into the site.zip file.</div>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="CommonsSiteCompressionMojo--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>CommonsSiteCompressionMojo</h4>
+<pre>public CommonsSiteCompressionMojo()</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="execute--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>execute</h4>
+<pre>public void execute()
+ throws org.apache.maven.plugin.MojoExecutionException,
+ org.apache.maven.plugin.MojoFailureException</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
+<dd><code>org.apache.maven.plugin.MojoFailureException</code></dd>
+</dl>
+</li>
+</ul>
+<a name="getAllSiteFiles-java.io.File-java.util.List-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getAllSiteFiles</h4>
+<pre>private void getAllSiteFiles(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> siteDirectory,
+ <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>> filesToCompress)</pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<div class="block">By default this method iterates across the <code>target/site</code> directory and adds all of the files
+ to the <a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#filesToCompress"><code>filesToCompress</code></a> <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a>.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>siteDirectory</code> - the <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> that represents the <code>target/site</code> directory.</dd>
+<dd><code>filesToCompress</code> - the <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a> to which to add all the files.</dd>
+</dl>
+</li>
+</ul>
+<a name="writeZipFile-java.io.File-java.io.File-java.util.List-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>writeZipFile</h4>
+<pre>private void writeZipFile(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> outputDirectory,
+ <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directoryToZip,
+ <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>> fileList)
+ throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
+<div class="block">A helper method for writing all of the files in our <code>fileList</code> to a <code>site.zip</code> file
+ in the <code>workingDirectory</code>.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>outputDirectory</code> - is a <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> representing the place to put the site.zip file.</dd>
+<dd><code>directoryToZip</code> - is a <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> representing the directory of the site (normally
+ <code>target/site</code>).</dd>
+<dd><code>fileList</code> - the list of files to be zipped up, generally generated by
+ <a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#getAllSiteFiles-java.io.File-java.util.List-"><code>getAllSiteFiles(File, List)</code></a>.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - when the copying of the files goes incorrectly.</dd>
+</dl>
+</li>
+</ul>
+<a name="addToZip-java.io.File-java.io.File-java.util.zip.ZipOutputStream-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>addToZip</h4>
+<pre>private void addToZip(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directoryToZip,
+ <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file,
+ <a href="https://docs.oracle.com/javase/7/docs/api/java/util/zip/ZipOutputStream.html?is-external=true" title="class or interface in java.util.zip">ZipOutputStream</a> zos)
+ throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block"><span class="deprecatedLabel">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>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>directoryToZip</code> - a <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> representing the directory from which the file exists that we are
+ compressing. Generally this is <code>target/site</code>.</dd>
+<dd><code>file</code> - a <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> to add to the <a href="https://docs.oracle.com/javase/7/docs/api/java/util/zip/ZipOutputStream.html?is-external=true" title="class or interface in java.util.zip"><code>ZipOutputStream</code></a> <code>zos</code>.</dd>
+<dd><code>zos</code> - the <a href="https://docs.oracle.com/javase/7/docs/api/java/util/zip/ZipOutputStream.html?is-external=true" title="class or interface in java.util.zip"><code>ZipOutputStream</code></a> to which to add our <code>file</code>.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if adding the <code>file</code> doesn't work out properly.</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/CommonsSiteCompressionMojo.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../../../index-all.html">Index</a></li>
+<li><a href="../../../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><span class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsStagingCleanupMojo.html" title="class in org.apache.commons.release.plugin.mojos"><span class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../../index.html?org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" target="_top">Frames</a></li>
+<li><a href="CommonsSiteCompressionMojo.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#field.summary">Field</a> | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field.detail">Field</a> | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<p class="legalCopy"><small>Copyright © 2018–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
+</body>
+</html>