Added: websites/production/commons/content/proper/commons-release-plugin/javadocs/api-1.2/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html ============================================================================== --- websites/production/commons/content/proper/commons-release-plugin/javadocs/api-1.2/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html (added) +++ websites/production/commons/content/proper/commons-release-plugin/javadocs/api-1.2/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html Tue Jun 19 03:57:05 2018 @@ -0,0 +1,657 @@ +<!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.1 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="CommonsDistributionStagingMojo (Apache Commons Release Plugin 1.1 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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 <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.57">CommonsDistributionStagingMojo</a> +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/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#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="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 <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="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#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="altColor"> +<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="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 multimodule builds can configure it.</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#username">username</a></span></code> +<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/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/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#buildDistBinariesRoot--">buildDistBinariesRoot</a></span>()</code> +<div class="block">Build the path for the distribution binaries directory.</div> +</td> +</tr> +<tr id="i1" 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#buildDistSourceRoot--">buildDistSourceRoot</a></span>()</code> +<div class="block">Build the path for the distribution source directory.</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#copyDistributionsIntoScmDirectoryStructure--">copyDistributionsIntoScmDirectoryStructure</a></span>()</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="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/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>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="i5" 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="project"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>project</h4> +<pre>@Parameter(defaultValue="${project}", + required=true) +private org.apache.maven.project.MavenProject <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.64">project</a></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> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.71">basedir</a></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="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> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.78">workingDirectory</a></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> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.86">distCheckoutDirectory</a></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> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.92">releaseNotesFile</a></pre> +<div class="block">The location of the RELEASE-NOTES.txt file such that multimodule 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> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.100">dryRun</a></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> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.109">distSvnStagingUrl</a></pre> +<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> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.115">isDistModule</a></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="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> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.121">username</a></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="blockListLast"> +<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> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.127">password</a></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> +</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 <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.57">CommonsDistributionStagingMojo</a>()</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 <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.130">execute</a>() + 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="copyReleaseNotesToWorkingDirectory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyReleaseNotesToWorkingDirectory</h4> +<pre>private void <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.202">copyReleaseNotesToWorkingDirectory</a>() + 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="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> occurrs as a wrapper so that maven + can properly handle the exception.</dd> +</dl> +</li> +</ul> +<a name="copyDistributionsIntoScmDirectoryStructure--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyDistributionsIntoScmDirectoryStructure</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>> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.235">copyDistributionsIntoScmDirectoryStructure</a>() + 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:</li> + <li><ul> + <li>site.zip</li> + <li>RELEASE-NOTES.txt</li> + <li>source:</li> + <li><ul> + <li>-src artifacts....</li> + </ul></li> + <li>binaries:</li> + <li><ul> + <li>-bin artifacts....</li> + </ul></li> + </ul></li> + </ul></div> +<dl> +<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> occurrs so that Maven can handle it properly.</dd> +</dl> +</li> +</ul> +<a name="buildDistBinariesRoot--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>buildDistBinariesRoot</h4> +<pre>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> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.271">buildDistBinariesRoot</a>()</pre> +<div class="block">Build the path for the distribution binaries directory.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the local absolute path into the checkedout subversion repository that is where + the binaries distributions are to be copied.</dd> +</dl> +</li> +</ul> +<a name="buildDistSourceRoot--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>buildDistSourceRoot</h4> +<pre>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> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.283">buildDistSourceRoot</a>()</pre> +<div class="block">Build the path for the distribution source directory.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the local absolute path into the checkedout subversion repository that is where + the source distributions are to be copied.</dd> +</dl> +</li> +</ul> +<a name="setBasedir-java.io.File-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setBasedir</h4> +<pre>protected void <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#line.296">setBasedir</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> 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 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
Added: websites/production/commons/content/proper/commons-release-plugin/javadocs/api-1.2/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html ============================================================================== --- websites/production/commons/content/proper/commons-release-plugin/javadocs/api-1.2/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html (added) +++ websites/production/commons/content/proper/commons-release-plugin/javadocs/api-1.2/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html Tue Jun 19 03:57:05 2018 @@ -0,0 +1,549 @@ +<!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.1 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="CommonsSiteCompressionMojo (Apache Commons Release Plugin 1.1 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":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/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>Next Class</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> +<br> +<pre>@Mojo(name="compress-site", + defaultPhase=POST_SITE, + threadSafe=true, + aggregator=true) +public class <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.50">CommonsSiteCompressionMojo</a> +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 org.apache.commons.compress.archivers.zip.ScatterZipOutputStream</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#dirs">dirs</a></span></code> +<div class="block">A variable for the process of creating the site.zip file.</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/CommonsSiteCompressionMojo.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/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">The list of files to compress into the site.zip file.</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/CommonsSiteCompressionMojo.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 org.apache.commons.compress.archivers.zip.ParallelScatterZipCreator</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#scatterZipCreator">scatterZipCreator</a></span></code> +<div class="block">A second variable for the process of creating the site.zip file.</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> </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">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> </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 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">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> </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">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> workingDirectory, + <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">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> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.58">workingDirectory</a></pre> +<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> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.63">siteDirectory</a></pre> +</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> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.72">distSvnStagingUrl</a></pre> +<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> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.78">isDistModule</a></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="dirs"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>dirs</h4> +<pre>private org.apache.commons.compress.archivers.zip.ScatterZipOutputStream <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.83">dirs</a></pre> +<div class="block">A variable for the process of creating the site.zip file.</div> +</li> +</ul> +<a name="scatterZipCreator"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>scatterZipCreator</h4> +<pre>private org.apache.commons.compress.archivers.zip.ParallelScatterZipCreator <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.88">scatterZipCreator</a></pre> +<div class="block">A second variable for the process of creating the site.zip file.</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>> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.93">filesToCompress</a></pre> +<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 <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.50">CommonsSiteCompressionMojo</a>()</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 <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.96">execute</a>() + 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="getAllSiteFiles-java.io.File-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllSiteFiles</h4> +<pre>private void <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.136">getAllSiteFiles</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> 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">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 <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.157">writeZipFile</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> workingDirectory, + <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">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>workingDirectory</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 <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#line.179">addToZip</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> 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">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>Next Class</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 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Added: websites/production/commons/content/proper/commons-release-plugin/javadocs/api-1.2/org/apache/commons/release/plugin/mojos/class-use/CommonsDistributionDetachmentMojo.html ============================================================================== --- websites/production/commons/content/proper/commons-release-plugin/javadocs/api-1.2/org/apache/commons/release/plugin/mojos/class-use/CommonsDistributionDetachmentMojo.html (added) +++ websites/production/commons/content/proper/commons-release-plugin/javadocs/api-1.2/org/apache/commons/release/plugin/mojos/class-use/CommonsDistributionDetachmentMojo.html Tue Jun 19 03:57:05 2018 @@ -0,0 +1,125 @@ +<!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>Uses of Class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo (Apache Commons Release Plugin 1.1 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo (Apache Commons Release Plugin 1.1 API)"; + } + } + catch(err) { + } +//--> +</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><a href="../../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/commons/release/plugin/mojos/class-use/CommonsDistributionDetachmentMojo.html" target="_top">Frames</a></li> +<li><a href="CommonsDistributionDetachmentMojo.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo" class="title">Uses of Class<br>org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo</h2> +</div> +<div class="classUseContainer">No usage of org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo</div> +<!-- ======= 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><a href="../../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/commons/release/plugin/mojos/class-use/CommonsDistributionDetachmentMojo.html" target="_top">Frames</a></li> +<li><a href="CommonsDistributionDetachmentMojo.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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Added: websites/production/commons/content/proper/commons-release-plugin/javadocs/api-1.2/org/apache/commons/release/plugin/mojos/class-use/CommonsDistributionStagingMojo.html ============================================================================== --- websites/production/commons/content/proper/commons-release-plugin/javadocs/api-1.2/org/apache/commons/release/plugin/mojos/class-use/CommonsDistributionStagingMojo.html (added) +++ websites/production/commons/content/proper/commons-release-plugin/javadocs/api-1.2/org/apache/commons/release/plugin/mojos/class-use/CommonsDistributionStagingMojo.html Tue Jun 19 03:57:05 2018 @@ -0,0 +1,125 @@ +<!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>Uses of Class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo (Apache Commons Release Plugin 1.1 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo (Apache Commons Release Plugin 1.1 API)"; + } + } + catch(err) { + } +//--> +</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><a href="../../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/commons/release/plugin/mojos/class-use/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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo" class="title">Uses of Class<br>org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo</h2> +</div> +<div class="classUseContainer">No usage of org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo</div> +<!-- ======= 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><a href="../../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/commons/release/plugin/mojos/class-use/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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> Added: websites/production/commons/content/proper/commons-release-plugin/javadocs/api-1.2/org/apache/commons/release/plugin/mojos/class-use/CommonsSiteCompressionMojo.html ============================================================================== --- websites/production/commons/content/proper/commons-release-plugin/javadocs/api-1.2/org/apache/commons/release/plugin/mojos/class-use/CommonsSiteCompressionMojo.html (added) +++ websites/production/commons/content/proper/commons-release-plugin/javadocs/api-1.2/org/apache/commons/release/plugin/mojos/class-use/CommonsSiteCompressionMojo.html Tue Jun 19 03:57:05 2018 @@ -0,0 +1,125 @@ +<!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>Uses of Class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo (Apache Commons Release Plugin 1.1 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo (Apache Commons Release Plugin 1.1 API)"; + } + } + catch(err) { + } +//--> +</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><a href="../../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/commons/release/plugin/mojos/class-use/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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo" class="title">Uses of Class<br>org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo</h2> +</div> +<div class="classUseContainer">No usage of org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo</div> +<!-- ======= 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><a href="../../../../../../../org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/commons/release/plugin/mojos/class-use/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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>