Added: dev/commons/commons-release-plugin/1.4-RC1/site/apidocs/index-all.html ============================================================================== --- dev/commons/commons-release-plugin/1.4-RC1/site/apidocs/index-all.html (added) +++ dev/commons/commons-release-plugin/1.4-RC1/site/apidocs/index-all.html Sat Aug 25 01:39:02 2018 @@ -0,0 +1,632 @@ +<!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>Index (Apache Commons Release Plugin 1.4 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="Index (Apache Commons Release Plugin 1.4 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>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="overview-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</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?index-all.html" target="_top">Frames</a></li> +<li><a href="index-all.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="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 + 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#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/7/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/7/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=sha256</code>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#artifactSha512s">artifactSha512s</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/7/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/7/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=sha512</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> +<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> +</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/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">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/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">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"> +<!-- --> +</a> +<h2 class="title">C</h2> +<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, + which for the Apache Commons Project do not get uploaded to Nexus, and putting those artifacts + in the dev distribution location for Apache projects.</div> +</dd> +<dt><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> +<dt><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><span class="typeNameLink">CommonsDistributionStagingMojo</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">This class checks out the dev distribution location, copies the distributions into that directory + structure under the <code>target/commons-release-plugin/scm</code> directory.</div> +</dd> +<dt><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"><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> +<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> +</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> +<div class="block">A utility method that takes the <code>RELEASE-NOTES.txt</code> file from the base directory of the + project and copies it into <a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#workingDirectory"><code>CommonsDistributionStagingMojo.workingDirectory</code></a>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#copyRemovedArtifactsToWorkingDirectory--">copyRemovedArtifactsToWorkingDirectory()</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 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"> +<!-- --> +</a> +<h2 class="title">D</h2> +<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 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> +<dd> +<div class="block">The location to which to checkout the dist subversion repository under our working directory, which + was given above.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#distSvnStagingUrl">distSvnStagingUrl</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 subversion staging url to which we upload all of our staged artifacts.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#distSvnStagingUrl">distSvnStagingUrl</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 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/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> +</dd> +</dl> +<a name="I:E"> +<!-- --> +</a> +<h2 class="title">E</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#execute--">execute()</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> </dd> +<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> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> + </dd> +</dl> +<a name="I:F"> +<!-- --> +</a> +<h2 class="title">F</h2> +<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> +<a name="I:G"> +<!-- --> +</a> +<h2 class="title">G</h2> +<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> +</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 sha256 map and sha512 map.</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>sha256</code> signature file from a given file.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#getSha512FilePath-java.io.File-java.io.File-">getSha512FilePath(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>sha512</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 sha256 and sha512 signature files for our detached artifacts in the + <code>target/commons-release-plugin</code> directory for the purpose of being uploaded by + the <a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><code>CommonsDistributionStagingMojo</code></a>.</div> +</dd> +<dt><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"> +<!-- --> +</a> +<h2 class="title">I</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/SharedFunctions.html#initDirectory-org.apache.maven.plugin.logging.Log-java.io.File-">initDirectory(Log, 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">Cleans and then initializes an empty directory that is given by the <code>workingDirectory</code> + parameter.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#isDistModule">isDistModule</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 parameter to generally avoid running unless it is specifically turned on by the consuming module.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#isDistModule">isDistModule</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 parameter to generally avoid running unless it is specifically turned on by the consuming module.</div> +</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> +<h2 class="title">O</h2> +<dl> +<dt><a href="org/apache/commons/release/plugin/package-summary.html">org.apache.commons.release.plugin</a> - package org.apache.commons.release.plugin</dt> +<dd> +<div class="block">Base package for the commons-release-plugin.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/mojos/package-summary.html">org.apache.commons.release.plugin.mojos</a> - package org.apache.commons.release.plugin.mojos</dt> +<dd> +<div class="block">This package contains all 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/7/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"> +<!-- --> +</a> +<h2 class="title">P</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#password">password</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 password associated with <a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#username"><code>CommonsDistributionStagingMojo.username</code></a>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#project">project</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 maven project context injection so that we can get a hold of the variables at hand.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#project">project</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 <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#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> +<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#putAttachedArtifactInSha512Map-org.apache.maven.artifact.Artifact-">putAttachedArtifactInSha512Map(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 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"> +<!-- --> +</a> +<h2 class="title">S</h2> +<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> +<dd> +<div class="block">This method is the setter for the <a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#baseDir"><code>CommonsDistributionStagingMojo.baseDir</code></a> field, specifically + for the usage in the unit tests.</div> +</dd> +<dt><a href="org/apache/commons/release/plugin/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> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/SharedFunctions.html#SharedFunctions--">SharedFunctions()</a></span> - Constructor for class org.apache.commons.release.plugin.<a href="org/apache/commons/release/plugin/SharedFunctions.html" title="class in org.apache.commons.release.plugin">SharedFunctions</a></dt> +<dd> +<div class="block">Making the constructor private because the class only contains static methods.</div> +</dd> +<dt><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> +<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"> +<!-- --> +</a> +<h2 class="title">U</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#username">username</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 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> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html#workingDirectory">workingDirectory</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 main working directory for the plugin, namely <code>target/commons-release-plugin</code>, but + that assumes that we're using the default maven <code>${project.build.directory}</code>.</div> +</dd> +<dt><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#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/CommonsDistributionDetachmentMojo.html#writeAllArtifactsInSha512PropertiesFile--">writeAllArtifactsInSha512PropertiesFile()</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/sha512.properties the artifact sha512'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: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"> +<!-- --> +</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>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="overview-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</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?index-all.html" target="_top">Frames</a></li> +<li><a href="index-all.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: dev/commons/commons-release-plugin/1.4-RC1/site/apidocs/index.html ============================================================================== --- dev/commons/commons-release-plugin/1.4-RC1/site/apidocs/index.html (added) +++ dev/commons/commons-release-plugin/1.4-RC1/site/apidocs/index.html Sat Aug 25 01:39:02 2018 @@ -0,0 +1,76 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd";> +<!-- NewPage --> +<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.4 API</title> +<script type="text/javascript"> + tmpTargetPage = "" + window.location.search; + if (tmpTargetPage != "" && tmpTargetPage != "undefined") + tmpTargetPage = tmpTargetPage.substring(1); + if (tmpTargetPage.indexOf(":") != -1 || (tmpTargetPage != "" && !validURL(tmpTargetPage))) + tmpTargetPage = "undefined"; + targetPage = tmpTargetPage; + function validURL(url) { + try { + url = decodeURIComponent(url); + } + catch (error) { + return false; + } + var pos = url.indexOf(".html"); + if (pos == -1 || pos != url.length - 5) + return false; + var allowNumber = false; + var allowSep = false; + var seenDot = false; + for (var i = 0; i < url.length - 5; i++) { + var ch = url.charAt(i); + if ('a' <= ch && ch <= 'z' || + 'A' <= ch && ch <= 'Z' || + ch == '$' || + ch == '_' || + ch.charCodeAt(0) > 127) { + allowNumber = true; + allowSep = true; + } else if ('0' <= ch && ch <= '9' + || ch == '-') { + if (!allowNumber) + return false; + } else if (ch == '/' || ch == '.') { + if (!allowSep) + return false; + allowNumber = false; + allowSep = false; + if (ch == '.') + seenDot = true; + if (ch == '/' && seenDot) + return false; + } else { + return false; + } + } + return true; + } + function loadFrames() { + if (targetPage != "" && targetPage != "undefined") + top.classFrame.location = top.targetPage; + } +</script> +</head> +<frameset cols="20%,80%" title="Documentation frame" onload="top.loadFrames()"> +<frameset rows="30%,70%" title="Left frames" onload="top.loadFrames()"> +<frame src="overview-frame.html" name="packageListFrame" title="All Packages"> +<frame src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)"> +</frameset> +<frame src="overview-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes"> +<noframes> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> +</noframes> +</frameset> +</html> Added: dev/commons/commons-release-plugin/1.4-RC1/site/apidocs/org/apache/commons/release/plugin/SharedFunctions.html ============================================================================== --- dev/commons/commons-release-plugin/1.4-RC1/site/apidocs/org/apache/commons/release/plugin/SharedFunctions.html (added) +++ dev/commons/commons-release-plugin/1.4-RC1/site/apidocs/org/apache/commons/release/plugin/SharedFunctions.html Sat Aug 25 01:39:02 2018 @@ -0,0 +1,375 @@ +<!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>SharedFunctions (Apache Commons Release Plugin 1.4 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="SharedFunctions (Apache Commons Release Plugin 1.4 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/SharedFunctions.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>Prev Class</li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/commons/release/plugin/SharedFunctions.html" target="_top">Frames</a></li> +<li><a href="SharedFunctions.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</div> +<h2 title="Class SharedFunctions" class="title">Class SharedFunctions</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.commons.release.plugin.SharedFunctions</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">SharedFunctions</span> +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> +<div class="block">Shared static functions for all of our Mojos.</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>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/release/plugin/SharedFunctions.html#BUFFER_BYTE_SIZE">BUFFER_BYTE_SIZE</a></span></code> +<div class="block">I want a buffer that is an array with 1024 elements of bytes.</div> +</td> +</tr> +</table> +</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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>private </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/release/plugin/SharedFunctions.html#SharedFunctions--">SharedFunctions</a></span>()</code> +<div class="block">Making the constructor private because the class only contains static methods.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>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> +</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> +<div class="block">Cleans and then initializes an empty directory that is given by the <code>workingDirectory</code> + parameter.</div> +</td> +</tr> +</table> +<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="BUFFER_BYTE_SIZE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BUFFER_BYTE_SIZE</h4> +<pre>public static final int BUFFER_BYTE_SIZE</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> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.commons.release.plugin.SharedFunctions.BUFFER_BYTE_SIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="SharedFunctions--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SharedFunctions</h4> +<pre>private SharedFunctions()</pre> +<div class="block">Making the constructor private because the class only contains static methods.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="initDirectory-org.apache.maven.plugin.logging.Log-java.io.File-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initDirectory</h4> +<pre>public static void initDirectory(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) + 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> +<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> or <a href="https://docs.oracle.com/javase/7/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> +<a name="copyFile-org.apache.maven.plugin.logging.Log-java.io.File-java.io.File-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>copyFile</h4> +<pre>public static void copyFile(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) + 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> +<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> +<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> or <a href="https://docs.oracle.com/javase/7/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> +</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/SharedFunctions.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>Prev Class</li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/commons/release/plugin/SharedFunctions.html" target="_top">Frames</a></li> +<li><a href="SharedFunctions.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>
