Index
All Classes and Interfaces|All Packages|Constant Field Values
B 
- 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 theHeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder
. - builder() - Static method in class org.apache.commons.release.plugin.velocity.ReadmeHtmlVelocityDelegate
-
Gets the
ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder
for constructing theReadmeHtmlVelocityDelegate
.
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
-
Constructs a new instance.
- 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
-
Constructs a new instance.
- CommonsSiteCompressionMojo - Class in org.apache.commons.release.plugin.mojos
-
Deprecated.
- CommonsSiteCompressionMojo() - Constructor for class org.apache.commons.release.plugin.mojos.CommonsSiteCompressionMojo
-
Deprecated.Constructs a new instance.
- CommonsStagingCleanupMojo - Class in org.apache.commons.release.plugin.mojos
-
This class checks out the dev distribution location, checks whether anything exists in the distribution location, and if it is non-empty it deletes all the resources there.
- CommonsStagingCleanupMojo() - Constructor for class org.apache.commons.release.plugin.mojos.CommonsStagingCleanupMojo
-
Constructs a new instance.
- copyFile(Log, File, File) - Static method in class org.apache.commons.release.plugin.SharedFunctions
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
H 
- 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.HeaderHtmlVelocityDelegateBuilder - Class in org.apache.commons.release.plugin.velocity
-
A builder class for instantiation of the
HeaderHtmlVelocityDelegate
.
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.
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 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.
R 
- 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.ReadmeHtmlVelocityDelegateBuilder - Class in org.apache.commons.release.plugin.velocity
-
A builder class for instantiation of the
ReadmeHtmlVelocityDelegate
. - 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 theReadmeHtmlVelocityDelegate.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 customizedMojoExecutionException
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 customizedMojoExecutionException
if it is.
S 
- setAuthentication(ScmProviderRepository, String, Settings, SettingsDecrypter, String, String) - Static method in class org.apache.commons.release.plugin.SharedFunctions
-
Sets 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. - SharedFunctions - Class in org.apache.commons.release.plugin
-
Shared static functions for all of our Mojos.
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
.
All Classes and Interfaces|All Packages|Constant Field Values
CommonsDistributionStagingMojo
.