A B C D E F G H I L O P R S T U V W

## A

addToZip(File, File, ZipOutputStream) - Method in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo
  Deprecated.
  Given the `directoryToZip` we add the `file` to the zip archive represented by `zos`.
ARTIFACT_TYPES_TO_DETACH - Static variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo
  A list of "artifact types" in the Maven vernacular, to be detached from the deployment.
artifactId - Variable in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate
  This is supposed to represent the maven artifactId.
artifactId - Variable in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
  The maven artifactId to use in the `README.vm` template.
artifactSha512s - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo
  A `SortedProperties` of `Artifact` → `String` containing the sha512 signatures for the individual artifacts, where the `Artifact` is represented as: `groupId:artifactId:version:type=sha512`.

## B

baseDir - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  The `File` that contains a file to the root directory of the working project.
BUFFER_BYTE_SIZE - Static variable in class org.apache.commons.release.plugin.SharedFunctions
  I want a buffer that is an array with 1024 elements of bytes.
build() - Method in class org.apache.commons.release.plugin.velocity.HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder
  Builds up the `ReadmeHtmlVelocityDelegate` from the previously set parameters.
build() - Method in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
  Builds up the `ReadmeHtmlVelocityDelegate` from the previously set parameters.
builder() - Static method in class org.apache.commons.release.plugin.velocity.HeaderHtmlVelocityDelegate
  For instantiating our `HeaderHtmlVelocityDelegate` using the `HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder`.
builder() - Static method in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate
  Gets the `ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder` for constructing the `ReadmeHtmlVelocityDelegate`.
buildReadmeAndHeaderHtmlFiles() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  Builds up `README.html` and `HEADER.html` that reside in following.

## C

CommonsDistributionDetachmentMojo - Class in org.apache.commons.release.plugin.mojos
  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.
CommonsDistributionDetachmentMojo() - Constructor for class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo
CommonsDistributionStagingMojo - Class in org.apache.commons.release.plugin.mojos
  This class checks out the dev distribution location, copies the distributions into that directory structure under the `target/commons-release-plugin/scm` directory.
CommonsDistributionStagingMojo() - Constructor for class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
commonsRcVersion - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  The RC version of the release.
commonsReleaseVersion - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  The release version of the artifact to be built.
CommonsSiteCompressionMojo - Class in org.apache.commons.release.plugin.mojos
  Deprecated.
  - as we no longer wish to compress the site, we are going to put this functionality in the `CommonsDistributionStagingMojo`.
CommonsSiteCompressionMojo() - Constructor for class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo
  Deprecated.
CommonsStagingCleanupMojo - Class in org.apache.commons.release.plugin.mojos
  This class checks out the dev distribution location, checkes whether anything exists in the distribution location, and if it is non-empty it deletes all of the resources there.
CommonsStagingCleanupMojo() - Constructor for class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo
copyDistributionsIntoScmDirectoryStructureAndAddToSvn(File, ScmProvider, ScmRepository) - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  Copies the list of files at the root of the `CommonsDistributionStagingMojo.workingDirectory` into the directory structure of the distribution staging repository.
copyFile(Log, File, File) - Static method in class org.apache.commons.release.plugin.SharedFunctions
  Copies a `File` from the `fromFile` to the `toFile` and logs the failure using the Maven `Log`.
copyHeaderAndReadmeToSubdirectories(File, File) - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  Copies `README.html` and `HEADER.html` to the source and binaries directories.
copyReleaseNotesToWorkingDirectory() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  A utility method that takes the `RELEASE-NOTES.txt` file from the base directory of the project and copies it into `CommonsDistributionStagingMojo.workingDirectory`.
copyRemovedArtifactsToWorkingDirectory() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo
  A helper method to copy the newly detached artifacts to `target/commons-release-plugin` so that the `CommonsDistributionStagingMojo` can find the artifacts later.
copySignatureValidatorScriptToScmDirectory() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  Copies our `signature-validator.sh` script into `${basedir}/target/commons-release-plugin/scm/signature-validator.sh`.
copySiteToScmDirectory() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  Copies `${basedir}/target/site` to `${basedir}/target/commons-release-plugin/scm/site`.

## D

detachedArtifacts - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo
  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.
distCheckoutDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  The location to which to checkout the dist subversion repository under our working directory, which was given above.
distCleanupDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo
  The location to which to checkout the dist subversion repository under our working directory, which was given above.
distRcVersionDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  A subdirectory of the dist directory into which we are going to stage the release candidate.
distServer - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  The ID of the server (specified in settings.xml) which should be used for dist authentication.
distServer - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo
  The ID of the server (specified in settings.xml) which should be used for dist authentication.
distSvnStagingUrl - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo
  The subversion staging url to which we upload all of our staged artifacts.
distSvnStagingUrl - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  The url of the subversion repository to which we wish the artifacts to be staged.
distSvnStagingUrl - Variable in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo
  Deprecated.
  The url of the subversion repository to which we wish the artifacts to be staged.
distSvnStagingUrl - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo
  The url of the subversion repository to which we wish the artifacts to be staged.
dryRun - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  A boolean that determines whether or not we actually commit the files up to the subversion repository.
dryRun - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo
  A boolean that determines whether or not we actually commit the files up to the subversion repository.

## E

execute() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo
execute() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
execute() - Method in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo
  Deprecated.
execute() - Method in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo

## F

filesToCompress - Variable in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo
  Deprecated.
  The list of files to compress into the site.zip file.

## G

getAllSiteFiles(File, List<File>) - Method in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo
  Deprecated.
  By default this method iterates across the `target/site` directory and adds all of the files to the `CommonsSiteCompressionMojo.filesToCompress` `List`.
getArtifactKey(Artifact) - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo
  Generates the unique artifact key for storage in our sha512 map.
getSha512FilePath(File, File) - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo
  A helper method to create a file path for the `sha512` signature file from a given file.

## H

hashArtifacts() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo
  A helper method that creates sha512 signature files for our detached artifacts in the `target/commons-release-plugin` directory for the purpose of being uploaded by the `CommonsDistributionStagingMojo`.
HEADER_FILE_NAME - Static variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  The name of file generated from the HEADER.vm velocity template to be checked into the dist svn repo.
HeaderHtmlVelocityDelegate - Class in org.apache.commons.release.plugin.velocity
  This class' purpose is to generate the `HEADER.html` that moves along with the release for the sake of downloading the release from the distribution area.
HeaderHtmlVelocityDelegate() - Constructor for class org.apache.commons.release.plugin.velocity.HeaderHtmlVelocityDelegate
  The private constructor to be used by the `HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder`.
HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder - Class in org.apache.commons.release.plugin.velocity
  A builder class for instantiation of the `HeaderHtmlVelocityDelegate`.
HeaderHtmlVelocityDelegateBuilder() - Constructor for class org.apache.commons.release.plugin.velocity.HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder
  Private constructor so that we can have a proper builder pattern.

## I

initDirectory(Log, File) - Static method in class org.apache.commons.release.plugin.SharedFunctions
  Cleans and then initializes an empty directory that is given by the `workingDirectory` parameter.
isDistModule - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo
  A parameter to generally avoid running unless it is specifically turned on by the consuming module.
isDistModule - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  A parameter to generally avoid running unless it is specifically turned on by the consuming module.
isDistModule - Variable in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo
  Deprecated.
  A parameter to generally avoid running unless it is specifically turned on by the consuming module.
isDistModule - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo
  A parameter to generally avoid running unless it is specifically turned on by the consuming module.

## L

listNotHiddenFilesAndDirectories(File, List<File>) - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  Lists all directories and files to a flat list.

## O

org.apache.commons.release.plugin - package org.apache.commons.release.plugin
  Base package for the commons-release-plugin.
org.apache.commons.release.plugin.mojos - package org.apache.commons.release.plugin.mojos
  This package contains all of the maven mojos for the commons-release-plugin.
org.apache.commons.release.plugin.velocity - package org.apache.commons.release.plugin.velocity
  Contains classes that take our velocity templates and render's them to a `Writer` class.

## P

password - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  The password associated with `CommonsDistributionStagingMojo.username`.
password - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo
  The password associated with `CommonsDistributionStagingMojo.username`.
project - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo
  The maven project context injection so that we can get a hold of the variables at hand.
project - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  The `MavenProject` object is essentially the context of the maven build at a given time.
project - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo
  The `MavenProject` object is essentially the context of the maven build at a given time.
putAttachedArtifactInSha512Map(Artifact) - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo
  Takes an attached artifact and puts the signature in the map.

## R

README_FILE_NAME - Static variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  The name of file generated from the README.vm velocity template to be checked into the dist svn repo.
ReadmeHtmlVelocityDelegate - Class in org.apache.commons.release.plugin.velocity
  This class' purpose is to generate the `README.html` that moves along with the release for the sake of downloading the release from the distribution area.
ReadmeHtmlVelocityDelegate(String, String, String) - Constructor for class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate
  The private constructor to be used by the `ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder`.
ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder - Class in org.apache.commons.release.plugin.velocity
  A builder class for instantiation of the `ReadmeHtmlVelocityDelegate`.
ReadmeHtmlVelocityDelegateBuilder() - Constructor for class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
  Private constructor for using the builder through the `ReadmeHtmlVelocityDelegate.builder()` method.
releaseNotesFile - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  The location of the RELEASE-NOTES.txt file such that multi-module builds can configure it.
render(Writer) - Method in class org.apache.commons.release.plugin.velocity.HeaderHtmlVelocityDelegate
  Builds the HEADER.vm velocity template to the writer passed in.
render(Writer) - Method in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate
  Renders the `README.vm` velocity template with the variables constructed with the `ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder`.
requireNonNull(T) - Static method in class org.apache.commons.release.plugin.SharedFunctions
  Checks that the specified object reference is not `null`.
requireNonNull(T, String) - Static method in class org.apache.commons.release.plugin.SharedFunctions
  Checks that the specified object reference is not `null` and throws a customized `MojoExecutionException` if it is.
requireNonNull(T, Supplier<String>) - Static method in class org.apache.commons.release.plugin.SharedFunctions
  Checks that the specified object reference is not `null` and throws a customized `MojoExecutionException` if it is.

## S

setAuthentication(ScmProviderRepository, String, Settings, SettingsDecrypter, String, String) - Static method in class org.apache.commons.release.plugin.SharedFunctions
  Set authentication information on the specified `ScmProviderRepository`.
setBaseDir(File) - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  This method is the setter for the `CommonsDistributionStagingMojo.baseDir` field, specifically for the usage in the unit tests.
settings - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  Maven `Settings`.
settings - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo
  Maven `Settings`.
settingsDecrypter - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  Maven `SettingsDecrypter` component.
settingsDecrypter - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo
  Maven `SettingsDecrypter` component.
SharedFunctions - Class in org.apache.commons.release.plugin
  Shared static functions for all of our Mojos.
SharedFunctions() - Constructor for class org.apache.commons.release.plugin.SharedFunctions
  Making the constructor private because the class only contains static methods.
SIGNATURE_VALIDATOR_NAME - Static variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  The name of the signature validation shell script to be checked into the dist svn repo.
siteDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  The location to which the site gets built during running `mvn site`.
siteDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo
  Deprecated.
siteUrl - Variable in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
  The site url to use in the `README.vm` template.
siteUrl - Variable in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate
  The url of the site that gets set into the `README.html`.

## T

TEMPLATE - Static variable in class org.apache.commons.release.plugin.velocity.HeaderHtmlVelocityDelegate
  The location of the velocity tempate for this class.
TEMPLATE - Static variable in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate
  The location of the velocity template for this class.

## U

username - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  The username for the distribution subversion repository.
username - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo
  The username for the distribution subversion repository.

## V

version - Variable in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
  The maven version to use in the `README.vm` template.
version - Variable in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate
  This is supposed to represent the maven version of the release.

## W

withArtifactId(String) - Method in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
  Adds the artifactId to the `ReadmeHtmlVelocityDelegate`.
withSiteUrl(String) - Method in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
  Adds the siteUrl to the `ReadmeHtmlVelocityDelegate`.
withVersion(String) - Method in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
  Adds the version to the `ReadmeHtmlVelocityDelegate`.
workingDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo
  The working directory in `target` that we use as a sandbox for the plugin.
workingDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsDistributionStagingMojo
  The main working directory for the plugin, namely `target/commons-release-plugin`, but that assumes that we're using the default maven `${project.build.directory}`.
workingDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo
  Deprecated.
  The working directory for the plugin which, assuming the maven uses the default `${project.build.directory}`, this becomes `target/commons-release-plugin`.
workingDirectory - Variable in class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo
  The main working directory for the plugin, namely `target/commons-release-plugin`, but that assumes that we're using the default maven `${project.build.directory}`.
writeAllArtifactsInSha512PropertiesFile() - Method in class org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo
  Writes to ./target/commons-release-plugin/sha512.properties the artifact sha512's.
writeZipFile(File, File, List<File>) - Method in class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo
  Deprecated.
  A helper method for writing all of the files in our `fileList` to a `site.zip` file in the `workingDirectory`.

A B C D E F G H I L O P R S T U V W

Copyright © 2018–2022 The Apache Software Foundation. All rights reserved.