You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@commons.apache.org by ch...@apache.org on 2018/06/19 03:50:26 UTC
svn commit: r1031439 [2/23] - in
/websites/production/commons/content/proper/commons-release-plugin: ./
apidocs/ apidocs/org/apache/commons/release/plugin/
apidocs/org/apache/commons/release/plugin/class-use/
apidocs/org/apache/commons/release/plugin/m...
Modified: websites/production/commons/content/proper/commons-release-plugin/apidocs/index-all.html
==============================================================================
--- websites/production/commons/content/proper/commons-release-plugin/apidocs/index-all.html (original)
+++ websites/production/commons/content/proper/commons-release-plugin/apidocs/index-all.html Tue Jun 19 03:50:24 2018
@@ -3,8 +3,8 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<title>Index (Apache Commons Release Plugin 1.3-SNAPSHOT API)</title>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Index (Apache Commons Release Plugin 1.3 API)</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="Index (Apache Commons Release Plugin 1.3-SNAPSHOT API)";
+ parent.document.title="Index (Apache Commons Release Plugin 1.3 API)";
}
}
catch(err) {
@@ -69,42 +69,75 @@
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
-<div class="contentContainer"><a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:I">I</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:U">U</a> <a href="#I:W">W</a> <a name="I:A">
+<div class="contentContainer"><a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:L">L</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:U">U</a> <a href="#I:V">V</a> <a href="#I:W">W</a> <a name="I:A">
<!-- -->
</a>
<h2 class="title">A</h2>
<dl>
<dt><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(File, File, ZipOutputStream)</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt>
<dd>
+<div class="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>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#ARTIFACT_TYPES_TO_DETACH">ARTIFACT_TYPES_TO_DETACH</a></span> - Static variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt>
<dd>
-<div class="block">A list of "artifact types" in the maven vernacular, to
+<div class="block">A list of "artifact types" in the Maven vernacular, to
be detached from the deployment.</div>
</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html#artifactId">artifactId</a></span> - Variable in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate</a></dt>
+<dd>
+<div class="block">This is supposed to represent the maven artifactId.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html#artifactId">artifactId</a></span> - Variable in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</a></dt>
+<dd>
+<div class="block">The maven artifactId to use in the <code>README.vm</code> template.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#artifactSha1s">artifactSha1s</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt>
+<dd>
+<div class="block">A <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> of <code>Artifact</code> â <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> containing the sha1 signatures
+ for the individual artifacts, where the <code>Artifact</code> is represented as:
+ <code>groupId:artifactId:version:type=sha1</code>.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#artifactSha256s">artifactSha256s</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt>
+<dd>
+<div class="block">A <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> of <code>Artifact</code> â <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> containing the sha256 signatures
+ for the individual artifacts, where the <code>Artifact</code> is represented as:
+ <code>groupId:artifactId:version:type=sha1</code>.</div>
+</dd>
</dl>
<a name="I:B">
<!-- -->
</a>
<h2 class="title">B</h2>
<dl>
-<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#basedir">basedir</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#baseDir">baseDir</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
<dd>
-<div class="block">The <a href="https://docs.oracle.com/javase/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>
+<div class="block">The <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> that contains a file to the root directory of the working project.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/SharedFunctions.html#BUFFER_BYTE_SIZE">BUFFER_BYTE_SIZE</a></span> - Static variable in class org.apache.commons.release.plugin.<a href="org/apache/commons/release/plugin/SharedFunctions.html" title="class in org.apache.commons.release.plugin">SharedFunctions</a></dt>
<dd>
<div class="block">I want a buffer that is an array with 1024 elements of bytes.</div>
</dd>
-<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#buildDistBinariesRoot--">buildDistBinariesRoot()</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html#build--">build()</a></span> - Method in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder</a></dt>
<dd>
-<div class="block">Build the path for the distribution binaries directory.</div>
+<div class="block">Builds up the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate</code></a> from the previously set parameters.</div>
</dd>
-<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#buildDistSourceRoot--">buildDistSourceRoot()</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html#build--">build()</a></span> - Method in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</a></dt>
<dd>
-<div class="block">Build the path for the distribution source directory.</div>
+<div class="block">Builds up the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate</code></a> from the previously set parameters.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html#builder--">builder()</a></span> - Static method in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">HeaderHtmlVelocityDelegate</a></dt>
+<dd>
+<div class="block">For instantiating our <a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><code>HeaderHtmlVelocityDelegate</code></a> using the <a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity"><code>HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder</code></a>.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html#builder--">builder()</a></span> - Static method in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate</a></dt>
+<dd>
+<div class="block">Gets the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</code></a> for constructing the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate</code></a>.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#buildReadmeAndHeaderHtmlFiles--">buildReadmeAndHeaderHtmlFiles()</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
+<dd>
+<div class="block">Builds up <code>README.html</code> and <code>HEADER.html</code> that reside in following.</div>
</dd>
</dl>
<a name="I:C">
@@ -114,9 +147,9 @@
<dl>
<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos"><span class="typeNameLink">CommonsDistributionDetachmentMojo</span></a> - Class in <a href="org/apache/commons/release/plugin/mojos/package-summary.html">org.apache.commons.release.plugin.mojos</a></dt>
<dd>
-<div class="block">The purpose of this maven mojo is to detach the artifacts generated by the maven-assembly-plugin,
+<div class="block">The purpose of this Maven mojo is to detach the artifacts generated by the maven-assembly-plugin,
which for the Apache Commons Project do not get uploaded to Nexus, and putting those artifacts
- in the dev distribution location for apache projects.</div>
+ in the dev distribution location for Apache projects.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#CommonsDistributionDetachmentMojo--">CommonsDistributionDetachmentMojo()</a></span> - Constructor for class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt>
<dd> </dd>
@@ -127,22 +160,39 @@
</dd>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#CommonsDistributionStagingMojo--">CommonsDistributionStagingMojo()</a></span> - Constructor for class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
<dd> </dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#commonsRcVersion">commonsRcVersion</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
+<dd>
+<div class="block">The RC version of the release.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#commonsReleaseVersion">commonsReleaseVersion</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
+<dd>
+<div class="block">The release version of the artifact to be built.</div>
+</dd>
<dt><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos"><span class="typeNameLink">CommonsSiteCompressionMojo</span></a> - Class in <a href="org/apache/commons/release/plugin/mojos/package-summary.html">org.apache.commons.release.plugin.mojos</a></dt>
<dd>
-<div class="block">Takes the built <code>./target/site</code> directory and compresses it to
- <code>./target/commons-release-plugin/site.zip</code>.</div>
+<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>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#CommonsSiteCompressionMojo--">CommonsSiteCompressionMojo()</a></span> - Constructor for class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt>
-<dd> </dd>
-<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#copyDistributionsIntoScmDirectoryStructure-java.io.File-">copyDistributionsIntoScmDirectoryStructure(File)</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
+<dd>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
+ </dd>
+<dt><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(File, ScmProvider, ScmRepository)</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
<dd>
<div class="block">Copies the list of files at the root of the <a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#workingDirectory"><code>CommonsDistributionStagingMojo.workingDirectory</code></a> into
the directory structure of the distribution staging repository.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/SharedFunctions.html#copyFile-org.apache.maven.plugin.logging.Log-java.io.File-java.io.File-">copyFile(Log, File, File)</a></span> - Static method in class org.apache.commons.release.plugin.<a href="org/apache/commons/release/plugin/SharedFunctions.html" title="class in org.apache.commons.release.plugin">SharedFunctions</a></dt>
<dd>
-<div class="block">Copies a <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> from the <code>fromfile</code> to the <code>tofile</code> and logs the failure
- using the maven <code>Log</code>.</div>
+<div class="block">Copies a <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> from the <code>fromFile</code> to the <code>toFile</code> and logs the failure
+ using the Maven <code>Log</code>.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#copyHeaderAndReadmeToSubdirectories-java.io.File-java.io.File-">copyHeaderAndReadmeToSubdirectories(File, File)</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
+<dd>
+<div class="block">Copies <code>README.html</code> and <code>HEADER.html</code> to the source and binaries
+ directories.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#copyReleaseNotesToWorkingDirectory--">copyReleaseNotesToWorkingDirectory()</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
<dd>
@@ -154,6 +204,10 @@
<div class="block">A helper method to copy the newly detached artifacts to <code>target/commons-release-plugin</code>
so that the <a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><code>CommonsDistributionStagingMojo</code></a> can find the artifacts later.</div>
</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#copySiteToScmDirectory--">copySiteToScmDirectory()</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
+<dd>
+<div class="block">Copies <code>${basedir}/target/site</code> to <code>${basedir}/target/commons-release-plugin/scm/site</code>.</div>
+</dd>
</dl>
<a name="I:D">
<!-- -->
@@ -162,11 +216,12 @@
<dl>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#detachedArtifacts">detachedArtifacts</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt>
<dd>
-<div class="block">This list is supposed to hold the maven references to the aformentioned artifacts so that we
- can upload them to svn after they've been detached from the maven deployment.</div>
+<div class="block">This list is supposed to hold the Maven references to the aforementioned artifacts so that we
+ can upload them to svn after they've been detached from the Maven deployment.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#dirs">dirs</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt>
<dd>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">A variable for the process of creating the site.zip file.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#distCheckoutDirectory">distCheckoutDirectory</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
@@ -184,8 +239,13 @@
</dd>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#distSvnStagingUrl">distSvnStagingUrl</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt>
<dd>
+<div class="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>
</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#distVersionRcVersionDirectory">distVersionRcVersionDirectory</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
+<dd>
+<div class="block">A subdirectory of the dist directory into which we are going to stage the release candidate.</div>
+</dd>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#dryRun">dryRun</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
<dd>
<div class="block">A boolean that determines whether or not we actually commit the files up to the subversion repository.</div>
@@ -201,7 +261,9 @@
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#execute--">execute()</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
<dd> </dd>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#execute--">execute()</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt>
-<dd> </dd>
+<dd>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
+ </dd>
</dl>
<a name="I:F">
<!-- -->
@@ -210,6 +272,7 @@
<dl>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#filesToCompress">filesToCompress</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt>
<dd>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">The list of files to compress into the site.zip file.</div>
</dd>
</dl>
@@ -220,8 +283,13 @@
<dl>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#getAllSiteFiles-java.io.File-java.util.List-">getAllSiteFiles(File, List<File>)</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt>
<dd>
+<div class="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>CommonsSiteCompressionMojo.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>
+ to the <a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#filesToCompress"><code>CommonsSiteCompressionMojo.filesToCompress</code></a> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a>.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#getArtifactKey-org.apache.maven.artifact.Artifact-">getArtifactKey(Artifact)</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt>
+<dd>
+<div class="block">Generates the unique artifact key for storage in our sha1 map and sha256 map.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#getMd5FilePath-java.io.File-java.io.File-">getMd5FilePath(File, File)</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt>
<dd>
@@ -231,6 +299,43 @@
<dd>
<div class="block">A helper method to create a file path for the <code>sha1</code> signature file from a given file.</div>
</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#getSha256FilePath-java.io.File-java.io.File-">getSha256FilePath(File, File)</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt>
+<dd>
+<div class="block">A helper method to create a file path for the <code>sha1</code> signature file from a given file.</div>
+</dd>
+</dl>
+<a name="I:H">
+<!-- -->
+</a>
+<h2 class="title">H</h2>
+<dl>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#hashArtifacts--">hashArtifacts()</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt>
+<dd>
+<div class="block">A helper method that creates md5, sha1, and sha256 signature files for our detached artifacts in the
+ <code>target/commons-release-plugin</code> directory for the purpose of being uploaded by
+ the <a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><code>CommonsDistributionStagingMojo</code></a>.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#HEADER_FILE_NAME">HEADER_FILE_NAME</a></span> - Static variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
+<dd>
+<div class="block">The name of file generated from the HEADER.vm velocity template to be checked into the dist svn repo.</div>
+</dd>
+<dt><a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><span class="typeNameLink">HeaderHtmlVelocityDelegate</span></a> - Class in <a href="org/apache/commons/release/plugin/velocity/package-summary.html">org.apache.commons.release.plugin.velocity</a></dt>
+<dd>
+<div class="block">This class' purpose is to generate the <code>HEADER.html</code> that moves along with the
+ release for the sake of downloading the release from the distribution area.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html#HeaderHtmlVelocityDelegate--">HeaderHtmlVelocityDelegate()</a></span> - Constructor for class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">HeaderHtmlVelocityDelegate</a></dt>
+<dd>
+<div class="block">The private constructor to be used by the <a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity"><code>HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder</code></a>.</div>
+</dd>
+<dt><a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity"><span class="typeNameLink">HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder</span></a> - Class in <a href="org/apache/commons/release/plugin/velocity/package-summary.html">org.apache.commons.release.plugin.velocity</a></dt>
+<dd>
+<div class="block">A builder class for instantiation of the <a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><code>HeaderHtmlVelocityDelegate</code></a>.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html#HeaderHtmlVelocityDelegateBuilder--">HeaderHtmlVelocityDelegateBuilder()</a></span> - Constructor for class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder</a></dt>
+<dd>
+<div class="block">Private constructor so that we can have a proper builder pattern.</div>
+</dd>
</dl>
<a name="I:I">
<!-- -->
@@ -252,9 +357,20 @@
</dd>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#isDistModule">isDistModule</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt>
<dd>
+<div class="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>
</dd>
</dl>
+<a name="I:L">
+<!-- -->
+</a>
+<h2 class="title">L</h2>
+<dl>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#listNotHiddenFilesAndDirectories-java.io.File-java.util.List-">listNotHiddenFilesAndDirectories(File, List<File>)</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
+<dd>
+<div class="block">Lists all directories and files to a flat list.</div>
+</dd>
+</dl>
<a name="I:O">
<!-- -->
</a>
@@ -268,6 +384,11 @@
<dd>
<div class="block">This package contains all of the maven mojos for the commons-release-plugin.</div>
</dd>
+<dt><a href="org/apache/commons/release/plugin/velocity/package-summary.html">org.apache.commons.release.plugin.velocity</a> - package org.apache.commons.release.plugin.velocity</dt>
+<dd>
+<div class="block">Contains classes that take our velocity templates and render's them to a <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io"><code>Writer</code></a>
+ class.</div>
+</dd>
</dl>
<a name="I:P">
<!-- -->
@@ -287,15 +408,54 @@
<div class="block">The <code>MavenProject</code> object is essentially the context of the maven build at
a given time.</div>
</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#putAttachedArtifactInSha1Map-org.apache.maven.artifact.Artifact-">putAttachedArtifactInSha1Map(Artifact)</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt>
+<dd>
+<div class="block">Takes an attached artifact and puts the signature in the map.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#putAttachedArtifactInSha256Map-org.apache.maven.artifact.Artifact-">putAttachedArtifactInSha256Map(Artifact)</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt>
+<dd>
+<div class="block">Takes an attached artifact and puts the signature in the map.</div>
+</dd>
</dl>
<a name="I:R">
<!-- -->
</a>
<h2 class="title">R</h2>
<dl>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#README_FILE_NAME">README_FILE_NAME</a></span> - Static variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
+<dd>
+<div class="block">The name of file generated from the README.vm velocity template to be checked into the dist svn repo.</div>
+</dd>
+<dt><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><span class="typeNameLink">ReadmeHtmlVelocityDelegate</span></a> - Class in <a href="org/apache/commons/release/plugin/velocity/package-summary.html">org.apache.commons.release.plugin.velocity</a></dt>
+<dd>
+<div class="block">This class' purpose is to generate the <code>README.html</code> that moves along with the
+ release for the sake of downloading the release from the distribution area.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html#ReadmeHtmlVelocityDelegate-java.lang.String-java.lang.String-java.lang.String-">ReadmeHtmlVelocityDelegate(String, String, String)</a></span> - Constructor for class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate</a></dt>
+<dd>
+<div class="block">The private constructor to be used by the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</code></a>.</div>
+</dd>
+<dt><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity"><span class="typeNameLink">ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</span></a> - Class in <a href="org/apache/commons/release/plugin/velocity/package-summary.html">org.apache.commons.release.plugin.velocity</a></dt>
+<dd>
+<div class="block">A builder class for instantiation of the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate</code></a>.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html#ReadmeHtmlVelocityDelegateBuilder--">ReadmeHtmlVelocityDelegateBuilder()</a></span> - Constructor for class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</a></dt>
+<dd>
+<div class="block">Private constructor for using the builder through the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html#builder--"><code>ReadmeHtmlVelocityDelegate.builder()</code></a>
+ method.</div>
+</dd>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#releaseNotesFile">releaseNotesFile</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
<dd>
-<div class="block">The location of the RELEASE-NOTES.txt file such that multimodule builds can configure it.</div>
+<div class="block">The location of the RELEASE-NOTES.txt file such that multi-module builds can configure it.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html#render-java.io.Writer-">render(Writer)</a></span> - Method in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">HeaderHtmlVelocityDelegate</a></dt>
+<dd>
+<div class="block">Builds the HEADER.vm velocity template to the writer passed in.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html#render-java.io.Writer-">render(Writer)</a></span> - Method in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate</a></dt>
+<dd>
+<div class="block">Renders the <code>README.vm</code> velocity template with the variables constructed with the
+ <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</code></a>.</div>
</dd>
</dl>
<a name="I:S">
@@ -305,19 +465,14 @@
<dl>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#scatterZipCreator">scatterZipCreator</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt>
<dd>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">A second variable for the process of creating the site.zip file.</div>
</dd>
-<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#setBasedir-java.io.File-">setBasedir(File)</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#setBaseDir-java.io.File-">setBaseDir(File)</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
<dd>
-<div class="block">This method is the setter for the <a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#basedir"><code>CommonsDistributionStagingMojo.basedir</code></a> field, specifically
+<div class="block">This method is the setter for the <a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#baseDir"><code>CommonsDistributionStagingMojo.baseDir</code></a> field, specifically
for the usage in the unit tests.</div>
</dd>
-<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#sha1AndMd5SignArtifacts--">sha1AndMd5SignArtifacts()</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt>
-<dd>
-<div class="block">A helper method that creates md5 and sha1 signature files for our detached artifacts in the
- <code>target/commons-release-plugin</code> directory for the purpose of being uploade by
- the <a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><code>CommonsDistributionStagingMojo</code></a>.</div>
-</dd>
<dt><a href="org/apache/commons/release/plugin/SharedFunctions.html" title="class in org.apache.commons.release.plugin"><span class="typeNameLink">SharedFunctions</span></a> - Class in <a href="org/apache/commons/release/plugin/package-summary.html">org.apache.commons.release.plugin</a></dt>
<dd>
<div class="block">Shared static functions for all of our Mojos.</div>
@@ -326,8 +481,36 @@
<dd>
<div class="block">Making the constructor private because the class only contains static methods.</div>
</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#siteDirectory">siteDirectory</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionStagingMojo</a></dt>
+<dd>
+<div class="block">The location to which the site gets built during running <code>mvn site</code>.</div>
+</dd>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#siteDirectory">siteDirectory</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt>
-<dd> </dd>
+<dd>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
+ </dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html#siteUrl">siteUrl</a></span> - Variable in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</a></dt>
+<dd>
+<div class="block">The site url to use in the <code>README.vm</code> template.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html#siteUrl">siteUrl</a></span> - Variable in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate</a></dt>
+<dd>
+<div class="block">The url of the site that gets set into the <code>README.html</code>.</div>
+</dd>
+</dl>
+<a name="I:T">
+<!-- -->
+</a>
+<h2 class="title">T</h2>
+<dl>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html#TEMPLATE">TEMPLATE</a></span> - Static variable in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/HeaderHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">HeaderHtmlVelocityDelegate</a></dt>
+<dd>
+<div class="block">The location of the velocity tempate for this class.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html#TEMPLATE">TEMPLATE</a></span> - Static variable in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate</a></dt>
+<dd>
+<div class="block">The location of the velocity template for this class.</div>
+</dd>
</dl>
<a name="I:U">
<!-- -->
@@ -339,11 +522,37 @@
<div class="block">The username for the distribution subversion repository.</div>
</dd>
</dl>
+<a name="I:V">
+<!-- -->
+</a>
+<h2 class="title">V</h2>
+<dl>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html#version">version</a></span> - Variable in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</a></dt>
+<dd>
+<div class="block">The maven version to use in the <code>README.vm</code> template.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html#version">version</a></span> - Variable in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate</a></dt>
+<dd>
+<div class="block">This is supposed to represent the maven version of the release.</div>
+</dd>
+</dl>
<a name="I:W">
<!-- -->
</a>
<h2 class="title">W</h2>
<dl>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html#withArtifactId-java.lang.String-">withArtifactId(String)</a></span> - Method in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</a></dt>
+<dd>
+<div class="block">Adds the artifactId to the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate</code></a>.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html#withSiteUrl-java.lang.String-">withSiteUrl(String)</a></span> - Method in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</a></dt>
+<dd>
+<div class="block">Adds the siteUrl to the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate</code></a>.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html#withVersion-java.lang.String-">withVersion(String)</a></span> - Method in class org.apache.commons.release.plugin.velocity.<a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder.html" title="class in org.apache.commons.release.plugin.velocity">ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder</a></dt>
+<dd>
+<div class="block">Adds the version to the <a href="org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html" title="class in org.apache.commons.release.plugin.velocity"><code>ReadmeHtmlVelocityDelegate</code></a>.</div>
+</dd>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#workingDirectory">workingDirectory</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt>
<dd>
<div class="block">The working directory in <code>target</code> that we use as a sandbox for the plugin.</div>
@@ -355,16 +564,26 @@
</dd>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#workingDirectory">workingDirectory</a></span> - Variable in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt>
<dd>
+<div class="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>
</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#writeAllArtifactsInSha1PropertiesFile--">writeAllArtifactsInSha1PropertiesFile()</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt>
+<dd>
+<div class="block">Writes to ./target/commons-release-plugin/sha1.properties the artifact sha1's.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#writeAllArtifactsInSha256PropertiesFile--">writeAllArtifactsInSha256PropertiesFile()</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsDistributionDetachmentMojo</a></dt>
+<dd>
+<div class="block">Writes to ./target/commons-release-plugin/sha256.properties the artifact sha256's.</div>
+</dd>
<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html#writeZipFile-java.io.File-java.io.File-java.util.List-">writeZipFile(File, File, List<File>)</a></span> - Method in class org.apache.commons.release.plugin.mojos.<a href="org/apache/commons/release/plugin/mojos/CommonsSiteCompressionMojo.html" title="class in org.apache.commons.release.plugin.mojos">CommonsSiteCompressionMojo</a></dt>
<dd>
+<div class="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>
</dd>
</dl>
-<a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:I">I</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:U">U</a> <a href="#I:W">W</a> </div>
+<a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:L">L</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:U">U</a> <a href="#I:V">V</a> <a href="#I:W">W</a> </div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
Modified: websites/production/commons/content/proper/commons-release-plugin/apidocs/index.html
==============================================================================
--- websites/production/commons/content/proper/commons-release-plugin/apidocs/index.html (original)
+++ websites/production/commons/content/proper/commons-release-plugin/apidocs/index.html Tue Jun 19 03:50:24 2018
@@ -3,8 +3,8 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<title>Apache Commons Release Plugin 1.3-SNAPSHOT API</title>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Apache Commons Release Plugin 1.3 API</title>
<script type="text/javascript">
tmpTargetPage = "" + window.location.search;
if (tmpTargetPage != "" && tmpTargetPage != "undefined")
Modified: websites/production/commons/content/proper/commons-release-plugin/apidocs/org/apache/commons/release/plugin/SharedFunctions.html
==============================================================================
--- websites/production/commons/content/proper/commons-release-plugin/apidocs/org/apache/commons/release/plugin/SharedFunctions.html (original)
+++ websites/production/commons/content/proper/commons-release-plugin/apidocs/org/apache/commons/release/plugin/SharedFunctions.html Tue Jun 19 03:50:24 2018
@@ -3,8 +3,8 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<title>SharedFunctions (Apache Commons Release Plugin 1.3-SNAPSHOT API)</title>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>SharedFunctions (Apache Commons Release Plugin 1.3 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="SharedFunctions (Apache Commons Release Plugin 1.3-SNAPSHOT API)";
+ parent.document.title="SharedFunctions (Apache Commons Release Plugin 1.3 API)";
}
}
catch(err) {
@@ -97,7 +97,7 @@ var activeTableTab = "activeTableTab";
</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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.commons.release.plugin.SharedFunctions</li>
@@ -109,8 +109,8 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<hr>
<br>
-<pre>public final class <a href="../../../../../src-html/org/apache/commons/release/plugin/SharedFunctions.html#line.34">SharedFunctions</a>
-extends <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></pre>
+<pre>public final class <a href="../../../../../src-html/org/apache/commons/release/plugin/SharedFunctions.html#line.32">SharedFunctions</a>
+extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Shared static functions for all of our Mojos.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
@@ -181,16 +181,16 @@ extends <a href="https://docs.oracle.com
<tr id="i0" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/release/plugin/SharedFunctions.html#copyFile-org.apache.maven.plugin.logging.Log-java.io.File-java.io.File-">copyFile</a></span>(org.apache.maven.plugin.logging.Log log,
- <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> fromFile,
- <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> toFile)</code>
-<div class="block">Copies 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> from the <code>fromfile</code> to the <code>tofile</code> and logs the failure
- using the maven <code>Log</code>.</div>
+ <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> fromFile,
+ <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> toFile)</code>
+<div class="block">Copies a <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> from the <code>fromFile</code> to the <code>toFile</code> and logs the failure
+ using the Maven <code>Log</code>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/release/plugin/SharedFunctions.html#initDirectory-org.apache.maven.plugin.logging.Log-java.io.File-">initDirectory</a></span>(org.apache.maven.plugin.logging.Log log,
- <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)</code>
+ <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> workingDirectory)</code>
<div class="block">Cleans and then initializes an empty directory that is given by the <code>workingDirectory</code>
parameter.</div>
</td>
@@ -200,8 +200,8 @@ extends <a href="https://docs.oracle.com
<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>
+<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
+<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/ja
va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -223,7 +223,7 @@ extends <a href="https://docs.oracle.com
<ul class="blockListLast">
<li class="blockList">
<h4>BUFFER_BYTE_SIZE</h4>
-<pre>public static final int <a href="../../../../../src-html/org/apache/commons/release/plugin/SharedFunctions.html#line.40">BUFFER_BYTE_SIZE</a></pre>
+<pre>public static final int <a href="../../../../../src-html/org/apache/commons/release/plugin/SharedFunctions.html#line.38">BUFFER_BYTE_SIZE</a></pre>
<div class="block">I want a buffer that is an array with 1024 elements of bytes. We declare
the constant here for the sake of making the code more readable.</div>
<dl>
@@ -246,7 +246,7 @@ extends <a href="https://docs.oracle.com
<ul class="blockListLast">
<li class="blockList">
<h4>SharedFunctions</h4>
-<pre>private <a href="../../../../../src-html/org/apache/commons/release/plugin/SharedFunctions.html#line.45">SharedFunctions</a>()</pre>
+<pre>private <a href="../../../../../src-html/org/apache/commons/release/plugin/SharedFunctions.html#line.43">SharedFunctions</a>()</pre>
<div class="block">Making the constructor private because the class only contains static methods.</div>
</li>
</ul>
@@ -264,18 +264,18 @@ extends <a href="https://docs.oracle.com
<ul class="blockList">
<li class="blockList">
<h4>initDirectory</h4>
-<pre>public static void <a href="../../../../../src-html/org/apache/commons/release/plugin/SharedFunctions.html#line.58">initDirectory</a>(org.apache.maven.plugin.logging.Log log,
- <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>public static void <a href="../../../../../src-html/org/apache/commons/release/plugin/SharedFunctions.html#line.56">initDirectory</a>(org.apache.maven.plugin.logging.Log log,
+ <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> workingDirectory)
throws org.apache.maven.plugin.MojoExecutionException</pre>
<div class="block">Cleans and then initializes an empty directory that is given by the <code>workingDirectory</code>
parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>log</code> - is the maven log for output logging, particularly in regards to error management.</dd>
-<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> that represents the directory to first attempt to delete then create.</dd>
+<dd><code>log</code> - is the Maven log for output logging, particularly in regards to error management.</dd>
+<dd><code>workingDirectory</code> - is a <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> that represents the directory to first attempt to delete then create.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - when 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 for the purpose of bubbling the exception
- up to maven properly.</dd>
+<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - when an <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang"><code>NullPointerException</code></a> is caught for the
+ purpose of bubbling the exception up to Maven properly.</dd>
</dl>
</li>
</ul>
@@ -286,18 +286,18 @@ extends <a href="https://docs.oracle.com
<li class="blockList">
<h4>copyFile</h4>
<pre>public static void <a href="../../../../../src-html/org/apache/commons/release/plugin/SharedFunctions.html#line.81">copyFile</a>(org.apache.maven.plugin.logging.Log log,
- <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> fromFile,
- <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> toFile)
+ <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> fromFile,
+ <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> toFile)
throws org.apache.maven.plugin.MojoExecutionException</pre>
-<div class="block">Copies 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> from the <code>fromfile</code> to the <code>tofile</code> and logs the failure
- using the maven <code>Log</code>.</div>
+<div class="block">Copies a <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> from the <code>fromFile</code> to the <code>toFile</code> and logs the failure
+ using the Maven <code>Log</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>log</code> - the <code>Log</code>, the maven logger.</dd>
-<dd><code>fromFile</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> from which to copy.</dd>
-<dd><code>toFile</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> to which to copy into.</dd>
+<dd><code>fromFile</code> - the <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> from which to copy.</dd>
+<dd><code>toFile</code> - the <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> to which to copy into.</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.</dd>
+<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if an <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> or <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang"><code>NullPointerException</code></a> is caught.</dd>
</dl>
</li>
</ul>
Modified: websites/production/commons/content/proper/commons-release-plugin/apidocs/org/apache/commons/release/plugin/class-use/SharedFunctions.html
==============================================================================
--- websites/production/commons/content/proper/commons-release-plugin/apidocs/org/apache/commons/release/plugin/class-use/SharedFunctions.html (original)
+++ websites/production/commons/content/proper/commons-release-plugin/apidocs/org/apache/commons/release/plugin/class-use/SharedFunctions.html Tue Jun 19 03:50:24 2018
@@ -3,8 +3,8 @@
<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.SharedFunctions (Apache Commons Release Plugin 1.3-SNAPSHOT API)</title>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Uses of Class org.apache.commons.release.plugin.SharedFunctions (Apache Commons Release Plugin 1.3 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
@@ -12,7 +12,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="Uses of Class org.apache.commons.release.plugin.SharedFunctions (Apache Commons Release Plugin 1.3-SNAPSHOT API)";
+ parent.document.title="Uses of Class org.apache.commons.release.plugin.SharedFunctions (Apache Commons Release Plugin 1.3 API)";
}
}
catch(err) {