You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2021/10/02 12:45:43 UTC
[maven-release] branch MRELEASE-1066 updated (9a52341 -> da71a5d)
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a change to branch MRELEASE-1066
in repository https://gitbox.apache.org/repos/asf/maven-release.git.
from 9a52341 [MRELEASE-1071] 0 to 9 don't disable Reproducible Builds
add 0ff317c Update maven.yml
new aab0aa3 [MRELEASE-1066] Use try-with-resources
new 9244fd6 [MRELEASE-1066] Upgrade Plexus Utils to 3.4.1
new da71a5d (doc) javadoc:fix (auto)
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.github/workflows/maven.yml | 21 +-
.../shared/release/config/ReleaseDescriptor.java | 83 ++++-
.../shared/release/env/ReleaseEnvironment.java | 28 ++
.../shared/release/phase/AbstractReleasePhase.java | 36 ++
.../shared/release/phase/ResourceGenerator.java | 2 +-
.../shared/release/policy/PolicyException.java | 14 +-
.../shared/release/policy/naming/NamingPolicy.java | 6 +-
.../release/policy/naming/NamingPolicyRequest.java | 36 +-
.../release/policy/naming/NamingPolicyResult.java | 12 +
.../release/policy/version/VersionPolicy.java | 16 +-
.../policy/version/VersionPolicyRequest.java | 25 +-
.../policy/version/VersionPolicyResult.java | 14 +-
.../maven/shared/release/strategy/Strategy.java | 25 +-
.../shared/release/versions/AetherVersion.java | 6 +
.../release/versions/MavenArtifactVersion.java | 25 ++
.../maven/shared/release/versions/Version.java | 78 +++-
.../VersionComparisonConflictException.java | 10 +-
.../release/versions/VersionParseException.java | 7 +-
.../shared/release/AbstractReleaseRequest.java | 15 +-
.../shared/release/DefaultReleaseManager.java | 6 +
.../release/DefaultReleaseManagerListener.java | 19 +
.../maven/shared/release/ReleaseBranchRequest.java | 21 +-
.../maven/shared/release/ReleaseCleanRequest.java | 3 +-
.../maven/shared/release/ReleaseManager.java | 34 +-
.../shared/release/ReleaseManagerListener.java | 29 ++
.../shared/release/ReleasePerformRequest.java | 15 +-
.../shared/release/ReleasePrepareRequest.java | 25 +-
.../shared/release/ReleaseRollbackRequest.java | 7 +-
.../release/ReleaseUpdateVersionsRequest.java | 17 +-
.../config/PropertiesReleaseDescriptorStore.java | 23 ++
.../release/config/ReleaseDescriptorBuilder.java | 400 ++++++++++++++++++++-
.../release/config/ReleaseDescriptorStore.java | 2 +
.../config/ReleaseDescriptorStoreException.java | 6 +
.../maven/shared/release/config/ReleaseUtils.java | 12 +
.../release/env/DefaultReleaseEnvironment.java | 37 ++
.../shared/release/exec/AbstractMavenExecutor.java | 20 ++
.../shared/release/exec/CommandLineFactory.java | 3 +-
.../shared/release/exec/ForkedMavenExecutor.java | 15 +
.../shared/release/exec/InvokerMavenExecutor.java | 19 +
.../maven/shared/release/exec/MavenExecutor.java | 2 +-
.../release/exec/MavenExecutorException.java | 17 +
.../maven/shared/release/exec/RawStreamPumper.java | 29 +-
.../maven/shared/release/exec/TeeConsumer.java | 16 +
.../maven/shared/release/exec/TeeOutputStream.java | 17 +
.../release/phase/AbstractBackupPomsPhase.java | 13 +
.../release/phase/AbstractRewritePomsPhase.java | 66 ++++
.../release/phase/AbstractScmCommitPhase.java | 59 +++
.../phase/CheckCompletedPreparePhasesPhase.java | 1 -
.../release/phase/CheckoutProjectFromScm.java | 1 -
.../shared/release/phase/InputVariablesPhase.java | 9 +
.../release/phase/RemoveReleasePomsPhase.java | 2 +-
.../release/phase/RewritePomVersionsPhase.java | 1 +
.../release/phase/RewritePomsForBranchPhase.java | 1 -
.../maven/shared/release/phase/ScmBranchPhase.java | 1 +
.../release/phase/ScmCommitDevelopmentPhase.java | 2 +-
.../release/policies/DefaultNamingPolicy.java | 1 +
.../release/policies/DefaultVersionPolicy.java | 1 +
.../shared/release/scm/ClearCaseScmTranslator.java | 12 -
.../maven/shared/release/scm/CvsScmTranslator.java | 12 -
.../scm/DefaultScmRepositoryConfigurator.java | 5 +
.../maven/shared/release/scm/GitScmTranslator.java | 1 +
.../maven/shared/release/scm/HgScmTranslator.java | 1 +
.../maven/shared/release/scm/IdentifiedScm.java | 7 +-
.../shared/release/scm/JazzScmTranslator.java | 12 -
.../release/scm/ReleaseScmCommandException.java | 6 +
.../release/scm/ReleaseScmRepositoryException.java | 6 +
.../release/scm/ScmRepositoryConfigurator.java | 12 +-
.../release/scm/SubversionScmTranslator.java | 12 -
.../shared/release/strategies/DefaultStrategy.java | 28 +-
.../shared/release/transform/MavenCoordinate.java | 26 ++
.../maven/shared/release/transform/ModelETL.java | 21 ++
.../shared/release/transform/ModelETLFactory.java | 7 +
.../shared/release/transform/ModelETLRequest.java | 33 +-
.../shared/release/transform/jdom2/JDomBuild.java | 5 +
.../release/transform/jdom2/JDomDependency.java | 5 +
.../transform/jdom2/JDomDependencyManagement.java | 5 +
.../release/transform/jdom2/JDomExtension.java | 5 +
.../transform/jdom2/JDomMavenCoordinate.java | 6 +
.../shared/release/transform/jdom2/JDomModel.java | 10 +
.../release/transform/jdom2/JDomModelBase.java | 21 ++
.../release/transform/jdom2/JDomModelETL.java | 15 +
.../transform/jdom2/JDomModelETLFactory.java | 3 +
.../shared/release/transform/jdom2/JDomParent.java | 5 +
.../shared/release/transform/jdom2/JDomPlugin.java | 5 +
.../transform/jdom2/JDomPluginManagement.java | 5 +
.../release/transform/jdom2/JDomProfile.java | 5 +
.../release/transform/jdom2/JDomProperties.java | 5 +
.../release/transform/jdom2/JDomReportPlugin.java | 5 +
.../release/transform/jdom2/JDomReporting.java | 5 +
.../shared/release/transform/jdom2/JDomUtils.java | 9 +
.../maven/shared/release/util/PomFinder.java | 2 +-
.../maven/shared/release/util/ReleaseUtil.java | 1 -
.../release/versions/DefaultVersionInfo.java | 54 ++-
.../maven/shared/release/versions/VersionInfo.java | 4 +-
.../shared/release/exec/TeeOutputStreamTest.java | 1 -
.../release/phase/AbstractBackupPomsPhaseTest.java | 23 +-
.../release/phase/RunPerformGoalsPhaseTest.java | 1 -
.../maven/scm/provider/dummy/DummyScmProvider.java | 1 -
.../provider/dummy/DummyScmProviderRepository.java | 1 -
.../maven/scm/provider/stub/StubBranchCommand.java | 1 -
.../scm/provider/stub/StubCheckInCommand.java | 1 -
.../scm/provider/stub/StubCheckOutCommand.java | 1 -
.../maven/scm/provider/stub/StubScmProvider.java | 1 -
.../provider/stub/StubScmProviderRepository.java | 1 -
.../maven/scm/provider/stub/StubStatusCommand.java | 1 -
.../maven/scm/provider/stub/StubTagCommand.java | 1 -
.../maven/plugins/release/AbstractReleaseMojo.java | 1 -
.../plugins/release/AbstractScmReleaseMojo.java | 6 +
.../maven/plugins/release/BranchReleaseMojo.java | 5 +-
.../maven/plugins/release/CleanReleaseMojo.java | 3 +-
.../maven/plugins/release/PerformReleaseMojo.java | 3 +-
.../maven/plugins/release/PrepareReleaseMojo.java | 13 +-
.../maven/plugins/release/RollbackReleaseMojo.java | 3 +-
.../maven/plugins/release/StageReleaseMojo.java | 1 -
.../maven/plugins/release/UpdateVersionsMojo.java | 5 +-
.../policy/oddeven/OddEvenVersionPolicy.java | 3 +-
.../release/policy/semver/SemVerVersionPolicy.java | 3 +-
pom.xml | 2 +-
118 files changed, 1681 insertions(+), 193 deletions(-)
[maven-release] 03/03: (doc) javadoc:fix (auto)
Posted by sl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch MRELEASE-1066
in repository https://gitbox.apache.org/repos/asf/maven-release.git
commit da71a5dcde7f444e3c8f84936667a9dd47cbb702
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Sat Oct 2 14:18:17 2021 +0200
(doc) javadoc:fix (auto)
---
.../shared/release/config/ReleaseDescriptor.java | 83 ++++-
.../shared/release/env/ReleaseEnvironment.java | 28 ++
.../shared/release/phase/AbstractReleasePhase.java | 36 ++
.../shared/release/phase/ResourceGenerator.java | 2 +-
.../shared/release/policy/PolicyException.java | 14 +-
.../shared/release/policy/naming/NamingPolicy.java | 6 +-
.../release/policy/naming/NamingPolicyRequest.java | 36 +-
.../release/policy/naming/NamingPolicyResult.java | 12 +
.../release/policy/version/VersionPolicy.java | 16 +-
.../policy/version/VersionPolicyRequest.java | 25 +-
.../policy/version/VersionPolicyResult.java | 14 +-
.../maven/shared/release/strategy/Strategy.java | 25 +-
.../shared/release/versions/AetherVersion.java | 6 +
.../release/versions/MavenArtifactVersion.java | 25 ++
.../maven/shared/release/versions/Version.java | 78 +++-
.../VersionComparisonConflictException.java | 10 +-
.../release/versions/VersionParseException.java | 7 +-
.../shared/release/AbstractReleaseRequest.java | 15 +-
.../shared/release/DefaultReleaseManager.java | 6 +
.../release/DefaultReleaseManagerListener.java | 19 +
.../maven/shared/release/ReleaseBranchRequest.java | 21 +-
.../maven/shared/release/ReleaseCleanRequest.java | 3 +-
.../maven/shared/release/ReleaseManager.java | 34 +-
.../shared/release/ReleaseManagerListener.java | 29 ++
.../shared/release/ReleasePerformRequest.java | 15 +-
.../shared/release/ReleasePrepareRequest.java | 25 +-
.../shared/release/ReleaseRollbackRequest.java | 7 +-
.../release/ReleaseUpdateVersionsRequest.java | 17 +-
.../config/PropertiesReleaseDescriptorStore.java | 23 ++
.../release/config/ReleaseDescriptorBuilder.java | 400 ++++++++++++++++++++-
.../release/config/ReleaseDescriptorStore.java | 2 +
.../config/ReleaseDescriptorStoreException.java | 6 +
.../maven/shared/release/config/ReleaseUtils.java | 12 +
.../release/env/DefaultReleaseEnvironment.java | 37 ++
.../shared/release/exec/AbstractMavenExecutor.java | 20 ++
.../shared/release/exec/CommandLineFactory.java | 3 +-
.../shared/release/exec/ForkedMavenExecutor.java | 15 +
.../shared/release/exec/InvokerMavenExecutor.java | 19 +
.../maven/shared/release/exec/MavenExecutor.java | 2 +-
.../release/exec/MavenExecutorException.java | 17 +
.../maven/shared/release/exec/RawStreamPumper.java | 29 +-
.../maven/shared/release/exec/TeeConsumer.java | 16 +
.../maven/shared/release/exec/TeeOutputStream.java | 17 +
.../release/phase/AbstractBackupPomsPhase.java | 13 +
.../release/phase/AbstractRewritePomsPhase.java | 66 ++++
.../release/phase/AbstractScmCommitPhase.java | 59 +++
.../phase/CheckCompletedPreparePhasesPhase.java | 1 -
.../release/phase/CheckoutProjectFromScm.java | 1 -
.../shared/release/phase/InputVariablesPhase.java | 9 +
.../release/phase/RemoveReleasePomsPhase.java | 2 +-
.../release/phase/RewritePomVersionsPhase.java | 1 +
.../release/phase/RewritePomsForBranchPhase.java | 1 -
.../maven/shared/release/phase/ScmBranchPhase.java | 1 +
.../release/phase/ScmCommitDevelopmentPhase.java | 2 +-
.../release/policies/DefaultNamingPolicy.java | 1 +
.../release/policies/DefaultVersionPolicy.java | 1 +
.../shared/release/scm/ClearCaseScmTranslator.java | 12 -
.../maven/shared/release/scm/CvsScmTranslator.java | 12 -
.../scm/DefaultScmRepositoryConfigurator.java | 5 +
.../maven/shared/release/scm/GitScmTranslator.java | 1 +
.../maven/shared/release/scm/HgScmTranslator.java | 1 +
.../maven/shared/release/scm/IdentifiedScm.java | 7 +-
.../shared/release/scm/JazzScmTranslator.java | 12 -
.../release/scm/ReleaseScmCommandException.java | 6 +
.../release/scm/ReleaseScmRepositoryException.java | 6 +
.../release/scm/ScmRepositoryConfigurator.java | 12 +-
.../release/scm/SubversionScmTranslator.java | 12 -
.../shared/release/strategies/DefaultStrategy.java | 28 +-
.../shared/release/transform/MavenCoordinate.java | 26 ++
.../maven/shared/release/transform/ModelETL.java | 21 ++
.../shared/release/transform/ModelETLFactory.java | 7 +
.../shared/release/transform/ModelETLRequest.java | 33 +-
.../shared/release/transform/jdom2/JDomBuild.java | 5 +
.../release/transform/jdom2/JDomDependency.java | 5 +
.../transform/jdom2/JDomDependencyManagement.java | 5 +
.../release/transform/jdom2/JDomExtension.java | 5 +
.../transform/jdom2/JDomMavenCoordinate.java | 6 +
.../shared/release/transform/jdom2/JDomModel.java | 10 +
.../release/transform/jdom2/JDomModelBase.java | 21 ++
.../release/transform/jdom2/JDomModelETL.java | 15 +
.../transform/jdom2/JDomModelETLFactory.java | 3 +
.../shared/release/transform/jdom2/JDomParent.java | 5 +
.../shared/release/transform/jdom2/JDomPlugin.java | 5 +
.../transform/jdom2/JDomPluginManagement.java | 5 +
.../release/transform/jdom2/JDomProfile.java | 5 +
.../release/transform/jdom2/JDomProperties.java | 5 +
.../release/transform/jdom2/JDomReportPlugin.java | 5 +
.../release/transform/jdom2/JDomReporting.java | 5 +
.../shared/release/transform/jdom2/JDomUtils.java | 9 +
.../maven/shared/release/util/PomFinder.java | 2 +-
.../maven/shared/release/util/ReleaseUtil.java | 1 -
.../release/versions/DefaultVersionInfo.java | 54 ++-
.../maven/shared/release/versions/VersionInfo.java | 4 +-
.../shared/release/exec/TeeOutputStreamTest.java | 1 -
.../release/phase/RunPerformGoalsPhaseTest.java | 1 -
.../maven/scm/provider/dummy/DummyScmProvider.java | 1 -
.../provider/dummy/DummyScmProviderRepository.java | 1 -
.../maven/scm/provider/stub/StubBranchCommand.java | 1 -
.../scm/provider/stub/StubCheckInCommand.java | 1 -
.../scm/provider/stub/StubCheckOutCommand.java | 1 -
.../maven/scm/provider/stub/StubScmProvider.java | 1 -
.../provider/stub/StubScmProviderRepository.java | 1 -
.../maven/scm/provider/stub/StubStatusCommand.java | 1 -
.../maven/scm/provider/stub/StubTagCommand.java | 1 -
.../maven/plugins/release/AbstractReleaseMojo.java | 1 -
.../plugins/release/AbstractScmReleaseMojo.java | 6 +
.../maven/plugins/release/BranchReleaseMojo.java | 5 +-
.../maven/plugins/release/CleanReleaseMojo.java | 3 +-
.../maven/plugins/release/PerformReleaseMojo.java | 3 +-
.../maven/plugins/release/PrepareReleaseMojo.java | 13 +-
.../maven/plugins/release/RollbackReleaseMojo.java | 3 +-
.../maven/plugins/release/StageReleaseMojo.java | 1 -
.../maven/plugins/release/UpdateVersionsMojo.java | 5 +-
.../policy/oddeven/OddEvenVersionPolicy.java | 3 +-
.../release/policy/semver/SemVerVersionPolicy.java | 3 +-
115 files changed, 1663 insertions(+), 165 deletions(-)
diff --git a/maven-release-api/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptor.java b/maven-release-api/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptor.java
index e8896cf..312584d 100644
--- a/maven-release-api/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptor.java
+++ b/maven-release-api/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptor.java
@@ -24,6 +24,7 @@ import java.util.List;
import org.apache.maven.model.Scm;
/**
+ * <p>ReleaseDescriptor interface.</p>
*
* @author Robert Scholte
*/
@@ -119,6 +120,7 @@ public interface ReleaseDescriptor
/**
* Get if the scm provider should sign the tag. NOTE: currently only implemented with git-exe.
+ *
* @return boolean true if SCM tag should be signed
*/
boolean isScmSignTags();
@@ -227,6 +229,7 @@ public interface ReleaseDescriptor
boolean isScmUseEditMode();
/**
+ * <p>getActivateProfiles.</p>
*
* @return list of profiles to activate
*/
@@ -422,57 +425,129 @@ public interface ReleaseDescriptor
String getReleaseStrategyId();
/**
- * @return {@code String} The original version for the resolved snapshot dependency.
+ * <p>getDependencyOriginalVersion.</p>
*
+ * @return {@code String} The original version for the resolved snapshot dependency.
* @param artifactKey the artifact key {@code String}
*/
String getDependencyOriginalVersion( String artifactKey );
/**
- * @return {@code String} the release version for the resolved snapshot dependency.
+ * <p>getDependencyReleaseVersion.</p>
*
+ * @return {@code String} the release version for the resolved snapshot dependency.
* @param artifactKey the artifact key {@code String}
*/
String getDependencyReleaseVersion( String artifactKey );
/**
- * @return {@code String} the release version for the resolved snapshot dependency.
+ * <p>getDependencyDevelopmentVersion.</p>
*
+ * @return {@code String} the release version for the resolved snapshot dependency.
* @param artifactKey the artifact key {@code String}
*/
String getDependencyDevelopmentVersion( String artifactKey );
+ /**
+ * <p>getProjectOriginalVersion.</p>
+ *
+ * @param projectKey a {@link java.lang.String} object
+ * @return a {@link java.lang.String} object
+ */
String getProjectOriginalVersion( String projectKey );
+ /**
+ * <p>getProjectDevelopmentVersion.</p>
+ *
+ * @param projectKey a {@link java.lang.String} object
+ * @return a {@link java.lang.String} object
+ */
String getProjectDevelopmentVersion( String projectKey );
+ /**
+ * <p>getProjectReleaseVersion.</p>
+ *
+ * @param key a {@link java.lang.String} object
+ * @return a {@link java.lang.String} object
+ */
String getProjectReleaseVersion( String key );
/**
- * @return the original {@code Scm} information.
+ * <p>getOriginalScmInfo.</p>
*
+ * @return the original {@code Scm} information.
* @param projectKey the project key {@code String}
*/
Scm getOriginalScmInfo( String projectKey );
// Modifiable
+ /**
+ * <p>addDependencyOriginalVersion.</p>
+ *
+ * @param versionlessKey a {@link java.lang.String} object
+ * @param string a {@link java.lang.String} object
+ */
void addDependencyOriginalVersion( String versionlessKey, String string );
+ /**
+ * <p>addDependencyReleaseVersion.</p>
+ *
+ * @param versionlessKey a {@link java.lang.String} object
+ * @param version a {@link java.lang.String} object
+ */
void addDependencyReleaseVersion( String versionlessKey, String version );
+ /**
+ * <p>addDependencyDevelopmentVersion.</p>
+ *
+ * @param versionlessKey a {@link java.lang.String} object
+ * @param version a {@link java.lang.String} object
+ */
void addDependencyDevelopmentVersion( String versionlessKey, String version );
+ /**
+ * <p>addReleaseVersion.</p>
+ *
+ * @param projectId a {@link java.lang.String} object
+ * @param nextVersion a {@link java.lang.String} object
+ */
void addReleaseVersion( String projectId, String nextVersion );
+ /**
+ * <p>addDevelopmentVersion.</p>
+ *
+ * @param projectId a {@link java.lang.String} object
+ * @param nextVersion a {@link java.lang.String} object
+ */
void addDevelopmentVersion( String projectId, String nextVersion );
+ /**
+ * <p>setScmReleaseLabel.</p>
+ *
+ * @param tag a {@link java.lang.String} object
+ */
void setScmReleaseLabel( String tag );
+ /**
+ * <p>setScmReleasedPomRevision.</p>
+ *
+ * @param scmRevision a {@link java.lang.String} object
+ */
void setScmReleasedPomRevision( String scmRevision );
+ /**
+ * <p>setScmRelativePathProjectDirectory.</p>
+ *
+ * @param scmRelativePathProjectDirectory a {@link java.lang.String} object
+ */
void setScmRelativePathProjectDirectory( String scmRelativePathProjectDirectory );
+ /**
+ * <p>setScmSourceUrl.</p>
+ *
+ * @param scmUrl a {@link java.lang.String} object
+ */
void setScmSourceUrl( String scmUrl );
/**
diff --git a/maven-release-api/src/main/java/org/apache/maven/shared/release/env/ReleaseEnvironment.java b/maven-release-api/src/main/java/org/apache/maven/shared/release/env/ReleaseEnvironment.java
index 88ef9e2..2614473 100644
--- a/maven-release-api/src/main/java/org/apache/maven/shared/release/env/ReleaseEnvironment.java
+++ b/maven-release-api/src/main/java/org/apache/maven/shared/release/env/ReleaseEnvironment.java
@@ -25,24 +25,52 @@ import java.util.Locale;
import org.apache.maven.settings.Settings;
/**
+ * <p>ReleaseEnvironment interface.</p>
*
*/
public interface ReleaseEnvironment
{
+ /** Constant <code>DEFAULT_MAVEN_EXECUTOR_ID="forked-path"</code> */
String DEFAULT_MAVEN_EXECUTOR_ID = "forked-path";
+ /**
+ * <p>getMavenExecutorId.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
String getMavenExecutorId();
+ /**
+ * <p>getLocalRepositoryDirectory.</p>
+ *
+ * @return a {@link java.io.File} object
+ */
File getLocalRepositoryDirectory();
+ /**
+ * <p>getSettings.</p>
+ *
+ * @return a {@link org.apache.maven.settings.Settings} object
+ */
Settings getSettings();
+ /**
+ * <p>getMavenHome.</p>
+ *
+ * @return a {@link java.io.File} object
+ */
File getMavenHome();
+ /**
+ * <p>getJavaHome.</p>
+ *
+ * @return a {@link java.io.File} object
+ */
File getJavaHome();
/**
+ * <p>getLocale.</p>
*
* @return the locale
* @since 2.4
diff --git a/maven-release-api/src/main/java/org/apache/maven/shared/release/phase/AbstractReleasePhase.java b/maven-release-api/src/main/java/org/apache/maven/shared/release/phase/AbstractReleasePhase.java
index 672c18e..2718493 100644
--- a/maven-release-api/src/main/java/org/apache/maven/shared/release/phase/AbstractReleasePhase.java
+++ b/maven-release-api/src/main/java/org/apache/maven/shared/release/phase/AbstractReleasePhase.java
@@ -31,36 +31,72 @@ public abstract class AbstractReleasePhase
extends AbstractLogEnabled
implements ReleasePhase
{
+ /**
+ * <p>logInfo.</p>
+ *
+ * @param result a {@link org.apache.maven.shared.release.ReleaseResult} object
+ * @param message a {@link java.lang.String} object
+ */
protected void logInfo( ReleaseResult result, String message )
{
result.appendInfo( message );
getLogger().info( message );
}
+ /**
+ * <p>logWarn.</p>
+ *
+ * @param result a {@link org.apache.maven.shared.release.ReleaseResult} object
+ * @param message a {@link java.lang.String} object
+ */
protected void logWarn( ReleaseResult result, String message )
{
result.appendWarn( message );
getLogger().warn( message );
}
+ /**
+ * <p>logError.</p>
+ *
+ * @param result a {@link org.apache.maven.shared.release.ReleaseResult} object
+ * @param message a {@link java.lang.String} object
+ */
protected void logError( ReleaseResult result, String message )
{
result.appendWarn( message );
getLogger().error( message );
}
+ /**
+ * <p>logDebug.</p>
+ *
+ * @param result a {@link org.apache.maven.shared.release.ReleaseResult} object
+ * @param message a {@link java.lang.String} object
+ */
protected void logDebug( ReleaseResult result, String message )
{
result.appendDebug( message );
getLogger().debug( message );
}
+ /**
+ * <p>logDebug.</p>
+ *
+ * @param result a {@link org.apache.maven.shared.release.ReleaseResult} object
+ * @param message a {@link java.lang.String} object
+ * @param e a {@link java.lang.Exception} object
+ */
protected void logDebug( ReleaseResult result, String message, Exception e )
{
result.appendDebug( message, e );
getLogger().debug( message, e );
}
+ /**
+ * <p>getReleaseResultSuccess.</p>
+ *
+ * @return a {@link org.apache.maven.shared.release.ReleaseResult} object
+ */
protected ReleaseResult getReleaseResultSuccess()
{
ReleaseResult result = new ReleaseResult();
diff --git a/maven-release-api/src/main/java/org/apache/maven/shared/release/phase/ResourceGenerator.java b/maven-release-api/src/main/java/org/apache/maven/shared/release/phase/ResourceGenerator.java
index 8f85e3e..f294022 100644
--- a/maven-release-api/src/main/java/org/apache/maven/shared/release/phase/ResourceGenerator.java
+++ b/maven-release-api/src/main/java/org/apache/maven/shared/release/phase/ResourceGenerator.java
@@ -26,7 +26,7 @@ import org.apache.maven.shared.release.ReleaseResult;
/**
* Additional interface for ReleasePhase if the phase generates resources, which should be cleaned up afterwards.
- *
+ *
* @author Robert Scholte
* @since 3.0.0
*/
diff --git a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/PolicyException.java b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/PolicyException.java
index a3d7c34..2531d7f 100644
--- a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/PolicyException.java
+++ b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/PolicyException.java
@@ -20,18 +20,30 @@ package org.apache.maven.shared.release.policy;
*/
/**
- *
+ * <p>PolicyException class.</p>
+ *
* @since 2.5.1 (MRELEASE-431)
*/
public class PolicyException
extends Exception
{
+ /**
+ * <p>Constructor for PolicyException.</p>
+ *
+ * @param message a {@link java.lang.String} object
+ */
public PolicyException( String message )
{
super( message );
}
+ /**
+ * <p>Constructor for PolicyException.</p>
+ *
+ * @param message a {@link java.lang.String} object
+ * @param exception a {@link java.lang.Exception} object
+ */
public PolicyException( String message, Exception exception )
{
super( message, exception );
diff --git a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicy.java b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicy.java
index 467f2cd..c2abbc2 100644
--- a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicy.java
+++ b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicy.java
@@ -29,11 +29,11 @@ import org.apache.maven.shared.release.policy.PolicyException;
public interface NamingPolicy
{
/**
+ * <p>getName.</p>
+ *
* @return the calculation of the name used for branching or tagging.
- *
* @param request the {@code NamingPolicyRequest}
- *
- * @throws PolicyException if exception in the policy
+ * @throws org.apache.maven.shared.release.policy.PolicyException if exception in the policy
*/
NamingPolicyResult getName( NamingPolicyRequest request )
throws PolicyException;
diff --git a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicyRequest.java b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicyRequest.java
index d618142..b7c8d4f 100644
--- a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicyRequest.java
+++ b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicyRequest.java
@@ -20,7 +20,8 @@ package org.apache.maven.shared.release.policy.naming;
*/
/**
- *
+ * <p>NamingPolicyRequest class.</p>
+ *
* @author Robert Scholte
* @since 3.0.0
*/
@@ -32,33 +33,66 @@ public class NamingPolicyRequest
private String version;
+ /**
+ * <p>Getter for the field <code>groupId</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getGroupId()
{
return groupId;
}
+ /**
+ * <p>Setter for the field <code>groupId</code>.</p>
+ *
+ * @param groupId a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.policy.naming.NamingPolicyRequest} object
+ */
public NamingPolicyRequest setGroupId( String groupId )
{
this.groupId = groupId;
return this;
}
+ /**
+ * <p>Getter for the field <code>artifactId</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getArtifactId()
{
return artifactId;
}
+ /**
+ * <p>Setter for the field <code>artifactId</code>.</p>
+ *
+ * @param artifactId a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.policy.naming.NamingPolicyRequest} object
+ */
public NamingPolicyRequest setArtifactId( String artifactId )
{
this.artifactId = artifactId;
return this;
}
+ /**
+ * <p>Getter for the field <code>version</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getVersion()
{
return version;
}
+ /**
+ * <p>Setter for the field <code>version</code>.</p>
+ *
+ * @param version a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.policy.naming.NamingPolicyRequest} object
+ */
public NamingPolicyRequest setVersion( String version )
{
this.version = version;
diff --git a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicyResult.java b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicyResult.java
index 411e8b7..8920bf3 100644
--- a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicyResult.java
+++ b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/naming/NamingPolicyResult.java
@@ -20,6 +20,7 @@ package org.apache.maven.shared.release.policy.naming;
*/
/**
+ * <p>NamingPolicyResult class.</p>
*
* @since 3.0.0 (MRELEASE-979)
*/
@@ -30,11 +31,22 @@ public class NamingPolicyResult
*/
private String name;
+ /**
+ * <p>Getter for the field <code>name</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getName()
{
return name;
}
+ /**
+ * <p>Setter for the field <code>name</code>.</p>
+ *
+ * @param name a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.policy.naming.NamingPolicyResult} object
+ */
public NamingPolicyResult setName( String name )
{
this.name = name;
diff --git a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicy.java b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicy.java
index 6070802..e9fd5fc 100644
--- a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicy.java
+++ b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicy.java
@@ -30,23 +30,23 @@ import org.apache.maven.shared.release.versions.VersionParseException;
public interface VersionPolicy
{
/**
+ * <p>getReleaseVersion.</p>
+ *
* @return the calculation of the release version from development state.
- *
* @param request the {@code VersionPolicyRequest}
- *
- * @throws PolicyException if exception in the policy
- * @throws VersionParseException if exception parsing the version
+ * @throws org.apache.maven.shared.release.policy.PolicyException if exception in the policy
+ * @throws org.apache.maven.shared.release.versions.VersionParseException if exception parsing the version
*/
VersionPolicyResult getReleaseVersion( VersionPolicyRequest request )
throws PolicyException, VersionParseException;
/**
- * @return the calculation of the next development version from release state.
+ * <p>getDevelopmentVersion.</p>
*
+ * @return the calculation of the next development version from release state.
* @param request the {@code VersionPolicyRequest}
- *
- * @throws PolicyException if exception in the policy
- * @throws VersionParseException if exception parsing the version
+ * @throws org.apache.maven.shared.release.policy.PolicyException if exception in the policy
+ * @throws org.apache.maven.shared.release.versions.VersionParseException if exception parsing the version
*/
VersionPolicyResult getDevelopmentVersion( VersionPolicyRequest request )
throws PolicyException, VersionParseException;
diff --git a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicyRequest.java b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicyRequest.java
index 36bd1a1..4001b87 100644
--- a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicyRequest.java
+++ b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicyRequest.java
@@ -22,7 +22,8 @@ package org.apache.maven.shared.release.policy.version;
import org.apache.maven.artifact.repository.metadata.Metadata;
/**
- *
+ * <p>VersionPolicyRequest class.</p>
+ *
* @since 2.5.1 (MRELEASE-431)
*/
public class VersionPolicyRequest
@@ -32,22 +33,44 @@ public class VersionPolicyRequest
private Metadata metaData;
+ /**
+ * <p>Getter for the field <code>version</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getVersion()
{
return version;
}
+ /**
+ * <p>Setter for the field <code>version</code>.</p>
+ *
+ * @param version a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.policy.version.VersionPolicyRequest} object
+ */
public VersionPolicyRequest setVersion( String version )
{
this.version = version;
return this;
}
+ /**
+ * <p>Getter for the field <code>metaData</code>.</p>
+ *
+ * @return a {@link org.apache.maven.artifact.repository.metadata.Metadata} object
+ */
public Metadata getMetaData()
{
return metaData;
}
+ /**
+ * <p>Setter for the field <code>metaData</code>.</p>
+ *
+ * @param metaData a {@link org.apache.maven.artifact.repository.metadata.Metadata} object
+ * @return a {@link org.apache.maven.shared.release.policy.version.VersionPolicyRequest} object
+ */
public VersionPolicyRequest setMetaData( Metadata metaData )
{
this.metaData = metaData;
diff --git a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicyResult.java b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicyResult.java
index de7fb58..f1ccbf9 100644
--- a/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicyResult.java
+++ b/maven-release-api/src/main/java/org/apache/maven/shared/release/policy/version/VersionPolicyResult.java
@@ -20,18 +20,30 @@ package org.apache.maven.shared.release.policy.version;
*/
/**
- *
+ * <p>VersionPolicyResult class.</p>
+ *
* @since 2.5.1 (MRELEASE-431)
*/
public class VersionPolicyResult
{
private String version;
+ /**
+ * <p>Getter for the field <code>version</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getVersion()
{
return version;
}
+ /**
+ * <p>Setter for the field <code>version</code>.</p>
+ *
+ * @param version a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.policy.version.VersionPolicyResult} object
+ */
public VersionPolicyResult setVersion( String version )
{
this.version = version;
diff --git a/maven-release-api/src/main/java/org/apache/maven/shared/release/strategy/Strategy.java b/maven-release-api/src/main/java/org/apache/maven/shared/release/strategy/Strategy.java
index 43300b0..b02b02b 100644
--- a/maven-release-api/src/main/java/org/apache/maven/shared/release/strategy/Strategy.java
+++ b/maven-release-api/src/main/java/org/apache/maven/shared/release/strategy/Strategy.java
@@ -23,36 +23,45 @@ import java.util.List;
/**
* Interface to override default strategy.
- *
- * If a method returns {@code null}, the default will be used, otherwise the provided collection of phaseIds
- *
+ *
+ * If a method returns {@code null}, the default will be used, otherwise the provided collection of phaseIds
+ *
* @author Robert Scholte
- * @since 3.0.0
*/
public interface Strategy
{
/**
+ * <p>getPreparePhases.</p>
+ *
* @return The release phases to execute the calling the prepare goal
*/
List<String> getPreparePhases();
/**
- * @return The release phases to execute the calling the perform goal
+ * <p>getPerformPhases.</p>
+ *
+ * @return The release phases to execute the calling the perform goal
*/
List<String> getPerformPhases();
/**
- * @return The release phases to execute the calling the branch goal
+ * <p>getBranchPhases.</p>
+ *
+ * @return The release phases to execute the calling the branch goal
*/
List<String> getBranchPhases();
/**
- * @return The release phases to execute the calling the rollback goal
+ * <p>getRollbackPhases.</p>
+ *
+ * @return The release phases to execute the calling the rollback goal
*/
List<String> getRollbackPhases();
/**
- * @return The release phases to execute the calling the update-versions goal
+ * <p>getUpdateVersionsPhases.</p>
+ *
+ * @return The release phases to execute the calling the update-versions goal
*/
List<String> getUpdateVersionsPhases();
}
diff --git a/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/AetherVersion.java b/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/AetherVersion.java
index 55a014c..7b3dd48 100644
--- a/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/AetherVersion.java
+++ b/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/AetherVersion.java
@@ -46,6 +46,12 @@ class AetherVersion
return this.version.toString();
}
+ /**
+ * <p>compareTo.</p>
+ *
+ * @param other a {@link org.eclipse.aether.version.Version} object
+ * @return a int
+ */
public int compareTo( org.eclipse.aether.version.Version other )
{
return this.version.compareTo( other );
diff --git a/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/MavenArtifactVersion.java b/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/MavenArtifactVersion.java
index 25a2acb..fe579cc 100644
--- a/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/MavenArtifactVersion.java
+++ b/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/MavenArtifactVersion.java
@@ -44,26 +44,51 @@ class MavenArtifactVersion
}
}
+ /**
+ * <p>getMajorVersion.</p>
+ *
+ * @return a int
+ */
public int getMajorVersion()
{
return version.getMajorVersion();
}
+ /**
+ * <p>getMinorVersion.</p>
+ *
+ * @return a int
+ */
public int getMinorVersion()
{
return version.getMinorVersion();
}
+ /**
+ * <p>getIncrementalVersion.</p>
+ *
+ * @return a int
+ */
public int getIncrementalVersion()
{
return version.getIncrementalVersion();
}
+ /**
+ * <p>getBuildNumber.</p>
+ *
+ * @return a int
+ */
public int getBuildNumber()
{
return version.getBuildNumber();
}
+ /**
+ * <p>getQualifier.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getQualifier()
{
return version.getQualifier();
diff --git a/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/Version.java b/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/Version.java
index 7d4fbcd..6548e55 100644
--- a/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/Version.java
+++ b/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/Version.java
@@ -29,7 +29,7 @@ import org.apache.maven.artifact.ArtifactUtils;
import org.codehaus.plexus.util.StringUtils;
/**
- *
+ * <p>Version class.</p>
*/
public class Version
implements Comparable<Version>, Cloneable
@@ -76,6 +76,7 @@ public class Version
private static final String DEFAULT_BUILD_SEPARATOR = "-";
+ /** Constant <code>STANDARD_PATTERN</code> */
public static final Pattern STANDARD_PATTERN = Pattern.compile( "^((?:\\d+\\.)*\\d+)" // digit(s) and '.' repeated -
// followed by digit (version
// digits 1.22.0, etc)
@@ -90,6 +91,7 @@ public class Version
* supports version numbers like: trunk-SNAPSHOT branchName-SNAPSHOT SNAPSHOT
*/
// for SNAPSHOT releases only (possible versions include: trunk-SNAPSHOT or SNAPSHOT)
+ /** Constant <code>ALTERNATE_PATTERN</code> */
public static final Pattern ALTERNATE_PATTERN = Pattern.compile( "^(SNAPSHOT|[a-zA-Z]+[_-]SNAPSHOT)" );
private Version( List<String> digits, String annotation, String annotationRevision, String buildSpecifier,
@@ -109,6 +111,12 @@ public class Version
this.mavenArtifactVersion = null;
}
+ /**
+ * <p>Constructor for Version.</p>
+ *
+ * @param version a {@link java.lang.String} object
+ * @throws org.apache.maven.shared.release.versions.VersionParseException if any.
+ */
public Version( String version )
throws VersionParseException
{
@@ -166,16 +174,34 @@ public class Version
}
}
+ /**
+ * <p>isSnapshot.</p>
+ *
+ * @return a boolean
+ */
public boolean isSnapshot()
{
return ArtifactUtils.isSnapshot( strVersion );
}
+ /**
+ * <p>toString.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String toString()
{
return strVersion;
}
+ /**
+ * <p>getVersionString.</p>
+ *
+ * @param info a {@link org.apache.maven.shared.release.versions.Version} object
+ * @param buildSpecifier a {@link java.lang.String} object
+ * @param buildSeparator a {@link java.lang.String} object
+ * @return a {@link java.lang.String} object
+ */
protected static String getVersionString( Version info, String buildSpecifier, String buildSeparator )
{
StringBuilder sb = new StringBuilder();
@@ -215,7 +241,7 @@ public class Version
/**
* Simply joins the items in the list with "." period
- *
+ *
* @return a {@code String} containing the items in the list joined by "." period
* @param digits the list of digits {@code List<String>}
*/
@@ -239,38 +265,69 @@ public class Version
return StringUtils.isEmpty( s ) ? null : s;
}
+ /**
+ * <p>Getter for the field <code>digits</code>.</p>
+ *
+ * @return a {@link java.util.List} object
+ */
public List<String> getDigits()
{
return digits;
}
+ /**
+ * <p>Getter for the field <code>annotation</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getAnnotation()
{
return annotation;
}
+ /**
+ * <p>Getter for the field <code>annotationRevSeparator</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getAnnotationRevSeparator()
{
return annotationRevSeparator;
}
+ /**
+ * <p>Getter for the field <code>annotationRevision</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getAnnotationRevision()
{
return annotationRevision;
}
+ /**
+ * <p>Getter for the field <code>buildSeparator</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getBuildSeparator()
{
return buildSeparator;
}
+ /**
+ * <p>Getter for the field <code>buildSpecifier</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getBuildSpecifier()
{
return buildSpecifier;
}
/**
- *
+ * <p>Setter for the field <code>digits</code>.</p>
+ *
* @param newDigits the new list of digits
* @return a new instance of Version
*/
@@ -281,7 +338,8 @@ public class Version
}
/**
- *
+ * <p>Setter for the field <code>annotationRevision</code>.</p>
+ *
* @param newAnnotationRevision the new annotation revision
* @return a new instance of Version
*/
@@ -294,7 +352,8 @@ public class Version
}
/**
- *
+ * <p>Setter for the field <code>buildSpecifier</code>.</p>
+ *
* @param newBuildSpecifier the new build specifier
* @return a new instance of Version
*/
@@ -304,10 +363,15 @@ public class Version
this.annotationSeparator, this.annotationRevSeparator,
Objects.toString( this.buildSeparator, DEFAULT_BUILD_SEPARATOR ) );
}
-
+
/**
- * @throws VersionComparisonConflictException if {@link org.eclipse.aether.version.Version} and
+ * <p>compareTo.</p>
+ *
+ * @throws org.apache.maven.shared.release.versions.VersionComparisonConflictException
+ * if {@link org.eclipse.aether.version.Version} and
* {@link org.apache.maven.artifact.versioning.ArtifactVersion ArtifactVersion} give different results
+ * @param other a {@link org.apache.maven.shared.release.versions.Version} object
+ * @return a int
*/
public int compareTo( Version other )
throws VersionComparisonConflictException
diff --git a/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/VersionComparisonConflictException.java b/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/VersionComparisonConflictException.java
index 441692e..80011ac 100644
--- a/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/VersionComparisonConflictException.java
+++ b/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/VersionComparisonConflictException.java
@@ -20,7 +20,7 @@ package org.apache.maven.shared.release.versions;
*/
/**
- *
+ * <p>VersionComparisonConflictException class.</p>
*/
public class VersionComparisonConflictException
extends RuntimeException
@@ -34,6 +34,14 @@ public class VersionComparisonConflictException
private int mavenComparisonResult;
+ /**
+ * <p>Constructor for VersionComparisonConflictException.</p>
+ *
+ * @param lhsVersion a {@link java.lang.String} object
+ * @param rhsVersion a {@link java.lang.String} object
+ * @param aetherComparisonResult a int
+ * @param mavenComparisonResult a int
+ */
public VersionComparisonConflictException( String lhsVersion, String rhsVersion, int aetherComparisonResult,
int mavenComparisonResult )
{
diff --git a/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/VersionParseException.java b/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/VersionParseException.java
index d37cd92..8d24cb1 100644
--- a/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/VersionParseException.java
+++ b/maven-release-api/src/main/java/org/apache/maven/shared/release/versions/VersionParseException.java
@@ -20,11 +20,16 @@ package org.apache.maven.shared.release.versions;
*/
/**
- *
+ * <p>VersionParseException class.</p>
*/
public class VersionParseException
extends Exception
{
+ /**
+ * <p>Constructor for VersionParseException.</p>
+ *
+ * @param message a {@link java.lang.String} object
+ */
public VersionParseException( String message )
{
super( message );
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/AbstractReleaseRequest.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/AbstractReleaseRequest.java
index 470c6c2..d1314c2 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/AbstractReleaseRequest.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/AbstractReleaseRequest.java
@@ -25,6 +25,7 @@ import org.apache.maven.project.MavenProject;
import org.apache.maven.shared.release.config.ReleaseDescriptorBuilder;
/**
+ * <p>Abstract AbstractReleaseRequest class.</p>
*
* @author Robert Scholte
* @since 2.3
@@ -38,6 +39,8 @@ public abstract class AbstractReleaseRequest
private ReleaseManagerListener releaseManagerListener;
/**
+ * <p>Getter for the field <code>releaseDescriptorBuilder</code>.</p>
+ *
* @return the releaseDescriptor
*/
public ReleaseDescriptorBuilder getReleaseDescriptorBuilder()
@@ -46,6 +49,8 @@ public abstract class AbstractReleaseRequest
}
/**
+ * <p>Setter for the field <code>releaseDescriptorBuilder</code>.</p>
+ *
* @param releaseDescriptor the releaseDescriptor to set
*/
public void setReleaseDescriptorBuilder( ReleaseDescriptorBuilder releaseDescriptor )
@@ -54,6 +59,8 @@ public abstract class AbstractReleaseRequest
}
/**
+ * <p>Getter for the field <code>reactorProjects</code>.</p>
+ *
* @return the reactorProjects
*/
public List<MavenProject> getReactorProjects()
@@ -62,6 +69,8 @@ public abstract class AbstractReleaseRequest
}
/**
+ * <p>Setter for the field <code>reactorProjects</code>.</p>
+ *
* @param reactorProjects the reactorProjects to set
*/
public void setReactorProjects( List<MavenProject> reactorProjects )
@@ -70,6 +79,8 @@ public abstract class AbstractReleaseRequest
}
/**
+ * <p>Getter for the field <code>releaseManagerListener</code>.</p>
+ *
* @return the releaseManagerListener
*/
public ReleaseManagerListener getReleaseManagerListener()
@@ -78,10 +89,12 @@ public abstract class AbstractReleaseRequest
}
/**
+ * <p>Setter for the field <code>releaseManagerListener</code>.</p>
+ *
* @param releaseManagerListener the releaseManagerListener to set
*/
public void setReleaseManagerListener( ReleaseManagerListener releaseManagerListener )
{
this.releaseManagerListener = releaseManagerListener;
}
-}
\ No newline at end of file
+}
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/DefaultReleaseManager.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/DefaultReleaseManager.java
index b449348..c04dd67 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/DefaultReleaseManager.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/DefaultReleaseManager.java
@@ -550,6 +550,12 @@ public class DefaultReleaseManager
}
}
+ /**
+ * <p>clean.</p>
+ *
+ * @param releaseRequest a {@link org.apache.maven.shared.release.AbstractReleaseRequest} object
+ * @throws org.apache.maven.shared.release.ReleaseFailureException if any.
+ */
protected void clean( AbstractReleaseRequest releaseRequest ) throws ReleaseFailureException
{
ReleaseCleanRequest cleanRequest = new ReleaseCleanRequest();
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/DefaultReleaseManagerListener.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/DefaultReleaseManagerListener.java
index b8bbb23..1929518 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/DefaultReleaseManagerListener.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/DefaultReleaseManagerListener.java
@@ -27,6 +27,8 @@ import org.codehaus.plexus.util.StringUtils;
import static org.apache.maven.shared.utils.logging.MessageUtils.buffer;
/**
+ * <p>DefaultReleaseManagerListener class.</p>
+ *
* @author Hervé Boutemy
*/
public class DefaultReleaseManagerListener
@@ -42,11 +44,22 @@ public class DefaultReleaseManagerListener
private int currentPhase;
+ /**
+ * <p>Constructor for DefaultReleaseManagerListener.</p>
+ *
+ * @param log a {@link org.apache.maven.plugin.logging.Log} object
+ */
public DefaultReleaseManagerListener( Log log )
{
this( log, false );
}
+ /**
+ * <p>Constructor for DefaultReleaseManagerListener.</p>
+ *
+ * @param log a {@link org.apache.maven.plugin.logging.Log} object
+ * @param dryRun a boolean
+ */
public DefaultReleaseManagerListener( Log log, boolean dryRun )
{
this.log = log;
@@ -85,6 +98,9 @@ public class DefaultReleaseManagerListener
+ "/" + phases.size() + " " + buffer().strong( name ) );
}
+ /**
+ * <p>phaseEnd.</p>
+ */
public void phaseEnd()
{
// NOOP
@@ -95,6 +111,9 @@ public class DefaultReleaseManagerListener
nextPhase( name );
}
+ /**
+ * <p>goalEnd.</p>
+ */
public void goalEnd()
{
goal = null;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseBranchRequest.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseBranchRequest.java
index 45b69c8..94725a0 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseBranchRequest.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseBranchRequest.java
@@ -23,6 +23,7 @@ import java.util.Properties;
import org.apache.maven.shared.release.env.ReleaseEnvironment;
/**
+ * <p>ReleaseBranchRequest class.</p>
*
* @author Robert Scholte
* @since 2.3
@@ -37,6 +38,8 @@ public class ReleaseBranchRequest extends AbstractReleaseRequest
private Properties userProperties;
/**
+ * <p>Getter for the field <code>dryRun</code>.</p>
+ *
* @return the dryRun
*/
public Boolean getDryRun()
@@ -45,6 +48,8 @@ public class ReleaseBranchRequest extends AbstractReleaseRequest
}
/**
+ * <p>Setter for the field <code>dryRun</code>.</p>
+ *
* @param dryRun the dryRun to set
*/
public void setDryRun( Boolean dryRun )
@@ -53,6 +58,8 @@ public class ReleaseBranchRequest extends AbstractReleaseRequest
}
/**
+ * <p>Getter for the field <code>releaseEnvironment</code>.</p>
+ *
* @return the releaseEnvironment
*/
public ReleaseEnvironment getReleaseEnvironment()
@@ -61,6 +68,8 @@ public class ReleaseBranchRequest extends AbstractReleaseRequest
}
/**
+ * <p>Setter for the field <code>releaseEnvironment</code>.</p>
+ *
* @param releaseEnvironment the releaseEnvironment to set
*/
public void setReleaseEnvironment( ReleaseEnvironment releaseEnvironment )
@@ -68,13 +77,23 @@ public class ReleaseBranchRequest extends AbstractReleaseRequest
this.releaseEnvironment = releaseEnvironment;
}
+ /**
+ * <p>Getter for the field <code>userProperties</code>.</p>
+ *
+ * @return a {@link java.util.Properties} object
+ */
public Properties getUserProperties()
{
return userProperties;
}
+ /**
+ * <p>Setter for the field <code>userProperties</code>.</p>
+ *
+ * @param userProperties a {@link java.util.Properties} object
+ */
public void setUserProperties( Properties userProperties )
{
this.userProperties = userProperties;
}
-}
\ No newline at end of file
+}
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseCleanRequest.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseCleanRequest.java
index a1a32d0..0aca351 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseCleanRequest.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseCleanRequest.java
@@ -20,6 +20,7 @@ package org.apache.maven.shared.release;
*/
/**
+ * <p>ReleaseCleanRequest class.</p>
*
* @author Robert Scholte
* @since 2.3
@@ -27,4 +28,4 @@ package org.apache.maven.shared.release;
public class ReleaseCleanRequest
extends AbstractReleaseRequest
{
-}
\ No newline at end of file
+}
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseManager.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseManager.java
index fdfb89f..791e706 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseManager.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseManager.java
@@ -30,22 +30,34 @@ public interface ReleaseManager
* Prepare a release.
*
* @param prepareRequest all prepare arguments
- * @throws ReleaseExecutionException if there is a problem performing the release
- * @throws ReleaseFailureException if there is a problem performing the release
+ * @throws org.apache.maven.shared.release.ReleaseExecutionException if there is a problem performing the release
+ * @throws org.apache.maven.shared.release.ReleaseFailureException if there is a problem performing the release
* @since 2.3
*/
void prepare( ReleasePrepareRequest prepareRequest ) throws ReleaseExecutionException, ReleaseFailureException;
+ /**
+ * <p>prepareWithResult.</p>
+ *
+ * @param prepareRequest a {@link org.apache.maven.shared.release.ReleasePrepareRequest} object
+ * @return a {@link org.apache.maven.shared.release.ReleaseResult} object
+ */
ReleaseResult prepareWithResult( ReleasePrepareRequest prepareRequest );
+ /**
+ * <p>performWithResult.</p>
+ *
+ * @param performRequest a {@link org.apache.maven.shared.release.ReleasePerformRequest} object
+ * @return a {@link org.apache.maven.shared.release.ReleaseResult} object
+ */
ReleaseResult performWithResult( ReleasePerformRequest performRequest );
/**
* Perform a release
*
* @param performRequest all perform arguments
- * @throws ReleaseExecutionException if there is a problem performing the release
- * @throws ReleaseFailureException if there is a problem performing the release
+ * @throws org.apache.maven.shared.release.ReleaseExecutionException if there is a problem performing the release
+ * @throws org.apache.maven.shared.release.ReleaseFailureException if there is a problem performing the release
* @since 2.3
*/
void perform( ReleasePerformRequest performRequest )
@@ -55,7 +67,7 @@ public interface ReleaseManager
* Clean a release.
*
* @param cleanRequest all clean arguments
- * @throws ReleaseFailureException if exception when releasing
+ * @throws org.apache.maven.shared.release.ReleaseFailureException if exception when releasing
* @since 2.3
*/
void clean( ReleaseCleanRequest cleanRequest ) throws ReleaseFailureException;
@@ -64,8 +76,8 @@ public interface ReleaseManager
* Rollback changes made by the previous release
*
* @param rollbackRequest all rollback arguments
- * @throws ReleaseExecutionException if there is a problem during release rollback
- * @throws ReleaseFailureException if there is a problem during release rollback
+ * @throws org.apache.maven.shared.release.ReleaseExecutionException if there is a problem during release rollback
+ * @throws org.apache.maven.shared.release.ReleaseFailureException if there is a problem during release rollback
* @since 2.3
*/
void rollback( ReleaseRollbackRequest rollbackRequest )
@@ -75,8 +87,8 @@ public interface ReleaseManager
* Branch a project
*
* @param branchRequest all branch arguments
- * @throws ReleaseExecutionException if there is a problem during release branch
- * @throws ReleaseFailureException if there is a problem during release branch
+ * @throws org.apache.maven.shared.release.ReleaseExecutionException if there is a problem during release branch
+ * @throws org.apache.maven.shared.release.ReleaseFailureException if there is a problem during release branch
* @since 2.3
*/
void branch( ReleaseBranchRequest branchRequest ) throws ReleaseExecutionException, ReleaseFailureException;
@@ -85,8 +97,8 @@ public interface ReleaseManager
* Update version numbers for a project
*
* @param updateVersionsRequest all update versions arguments
- * @throws ReleaseExecutionException if there is a problem during update versions
- * @throws ReleaseFailureException if there is a problem during update versions
+ * @throws org.apache.maven.shared.release.ReleaseExecutionException if there is a problem during update versions
+ * @throws org.apache.maven.shared.release.ReleaseFailureException if there is a problem during update versions
* @since 2.3
*/
void updateVersions( ReleaseUpdateVersionsRequest updateVersionsRequest )
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseManagerListener.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseManagerListener.java
index 755e3e7..e4292ee 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseManagerListener.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseManagerListener.java
@@ -22,19 +22,48 @@ package org.apache.maven.shared.release;
import java.util.List;
/**
+ * <p>ReleaseManagerListener interface.</p>
+ *
* @author Edwin Punzalan
*/
public interface ReleaseManagerListener
{
+ /**
+ * <p>goalStart.</p>
+ *
+ * @param goal a {@link java.lang.String} object
+ * @param phases a {@link java.util.List} object
+ */
void goalStart( String goal, List<String> phases );
+ /**
+ * <p>phaseStart.</p>
+ *
+ * @param name a {@link java.lang.String} object
+ */
void phaseStart( String name );
+ /**
+ * <p>phaseEnd.</p>
+ */
void phaseEnd();
+ /**
+ * <p>phaseSkip.</p>
+ *
+ * @param name a {@link java.lang.String} object
+ */
void phaseSkip( String name );
+ /**
+ * <p>goalEnd.</p>
+ */
void goalEnd();
+ /**
+ * <p>error.</p>
+ *
+ * @param reason a {@link java.lang.String} object
+ */
void error( String reason );
}
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleasePerformRequest.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleasePerformRequest.java
index 5a0f516..f4b37a4 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleasePerformRequest.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleasePerformRequest.java
@@ -22,6 +22,7 @@ package org.apache.maven.shared.release;
import org.apache.maven.shared.release.env.ReleaseEnvironment;
/**
+ * <p>ReleasePerformRequest class.</p>
*
* @author Robert Scholte
* @since 2.3
@@ -38,6 +39,8 @@ public class ReleasePerformRequest
private ReleaseEnvironment releaseEnvironment;
/**
+ * <p>Getter for the field <code>dryRun</code>.</p>
+ *
* @return the dryRun
*/
public Boolean getDryRun()
@@ -46,6 +49,8 @@ public class ReleasePerformRequest
}
/**
+ * <p>Setter for the field <code>dryRun</code>.</p>
+ *
* @param dryRun the dryRun to set
*/
public void setDryRun( Boolean dryRun )
@@ -54,6 +59,8 @@ public class ReleasePerformRequest
}
/**
+ * <p>Getter for the field <code>clean</code>.</p>
+ *
* @return the clean
*/
public Boolean getClean()
@@ -62,6 +69,8 @@ public class ReleasePerformRequest
}
/**
+ * <p>Setter for the field <code>clean</code>.</p>
+ *
* @param clean the clean to set
*/
public void setClean( Boolean clean )
@@ -70,6 +79,8 @@ public class ReleasePerformRequest
}
/**
+ * <p>Getter for the field <code>releaseEnvironment</code>.</p>
+ *
* @return the releaseEnvironment
*/
public ReleaseEnvironment getReleaseEnvironment()
@@ -78,10 +89,12 @@ public class ReleasePerformRequest
}
/**
+ * <p>Setter for the field <code>releaseEnvironment</code>.</p>
+ *
* @param releaseEnvironment the releaseEnvironment to set
*/
public void setReleaseEnvironment( ReleaseEnvironment releaseEnvironment )
{
this.releaseEnvironment = releaseEnvironment;
}
-}
\ No newline at end of file
+}
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleasePrepareRequest.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleasePrepareRequest.java
index 7ac6915..9922393 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleasePrepareRequest.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleasePrepareRequest.java
@@ -24,6 +24,7 @@ import java.util.Properties;
import org.apache.maven.shared.release.env.ReleaseEnvironment;
/**
+ * <p>ReleasePrepareRequest class.</p>
*
* @author Robert Scholte
* @since 2.3
@@ -42,6 +43,8 @@ public class ReleasePrepareRequest
private Properties userProperties;
/**
+ * <p>Getter for the field <code>dryRun</code>.</p>
+ *
* @return the dryRun
*/
public Boolean getDryRun()
@@ -50,6 +53,8 @@ public class ReleasePrepareRequest
}
/**
+ * <p>Setter for the field <code>dryRun</code>.</p>
+ *
* @param dryRun the dryRun to set
*/
public void setDryRun( Boolean dryRun )
@@ -58,6 +63,8 @@ public class ReleasePrepareRequest
}
/**
+ * <p>Getter for the field <code>resume</code>.</p>
+ *
* @return the resume
*/
public Boolean getResume()
@@ -66,6 +73,8 @@ public class ReleasePrepareRequest
}
/**
+ * <p>Setter for the field <code>resume</code>.</p>
+ *
* @param resume the resume to set
*/
public void setResume( Boolean resume )
@@ -74,6 +83,8 @@ public class ReleasePrepareRequest
}
/**
+ * <p>Getter for the field <code>releaseEnvironment</code>.</p>
+ *
* @return the releaseEnvironment
*/
public ReleaseEnvironment getReleaseEnvironment()
@@ -82,6 +93,8 @@ public class ReleasePrepareRequest
}
/**
+ * <p>Setter for the field <code>releaseEnvironment</code>.</p>
+ *
* @param releaseEnvironment the releaseEnvironment to set
*/
public void setReleaseEnvironment( ReleaseEnvironment releaseEnvironment )
@@ -89,13 +102,23 @@ public class ReleasePrepareRequest
this.releaseEnvironment = releaseEnvironment;
}
+ /**
+ * <p>Getter for the field <code>userProperties</code>.</p>
+ *
+ * @return a {@link java.util.Properties} object
+ */
public Properties getUserProperties()
{
return userProperties;
}
+ /**
+ * <p>Setter for the field <code>userProperties</code>.</p>
+ *
+ * @param userProperties a {@link java.util.Properties} object
+ */
public void setUserProperties( Properties userProperties )
{
this.userProperties = userProperties;
}
-}
\ No newline at end of file
+}
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseRollbackRequest.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseRollbackRequest.java
index d91dd3a..45d24de 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseRollbackRequest.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseRollbackRequest.java
@@ -22,6 +22,7 @@ package org.apache.maven.shared.release;
import org.apache.maven.shared.release.env.ReleaseEnvironment;
/**
+ * <p>ReleaseRollbackRequest class.</p>
*
* @author Robert Scholte
* @since 2.3
@@ -32,6 +33,8 @@ public class ReleaseRollbackRequest
private ReleaseEnvironment releaseEnvironment;
/**
+ * <p>Getter for the field <code>releaseEnvironment</code>.</p>
+ *
* @return the releaseEnvironment
*/
public ReleaseEnvironment getReleaseEnvironment()
@@ -40,10 +43,12 @@ public class ReleaseRollbackRequest
}
/**
+ * <p>Setter for the field <code>releaseEnvironment</code>.</p>
+ *
* @param releaseEnvironment the releaseEnvironment to set
*/
public void setReleaseEnvironment( ReleaseEnvironment releaseEnvironment )
{
this.releaseEnvironment = releaseEnvironment;
}
-}
\ No newline at end of file
+}
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseUpdateVersionsRequest.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseUpdateVersionsRequest.java
index 81c768c..3412fc4 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseUpdateVersionsRequest.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/ReleaseUpdateVersionsRequest.java
@@ -24,6 +24,7 @@ import java.util.Properties;
import org.apache.maven.shared.release.env.ReleaseEnvironment;
/**
+ * <p>ReleaseUpdateVersionsRequest class.</p>
*
* @author Robert Scholte
* @since 2.3
@@ -36,6 +37,8 @@ public class ReleaseUpdateVersionsRequest
private Properties userProperties;
/**
+ * <p>Getter for the field <code>releaseEnvironment</code>.</p>
+ *
* @return the releaseEnvironment
*/
public ReleaseEnvironment getReleaseEnvironment()
@@ -44,6 +47,8 @@ public class ReleaseUpdateVersionsRequest
}
/**
+ * <p>Setter for the field <code>releaseEnvironment</code>.</p>
+ *
* @param releaseEnvironment the releaseEnvironment to set
*/
public void setReleaseEnvironment( ReleaseEnvironment releaseEnvironment )
@@ -51,13 +56,23 @@ public class ReleaseUpdateVersionsRequest
this.releaseEnvironment = releaseEnvironment;
}
+ /**
+ * <p>Getter for the field <code>userProperties</code>.</p>
+ *
+ * @return a {@link java.util.Properties} object
+ */
public Properties getUserProperties()
{
return userProperties;
}
+ /**
+ * <p>Setter for the field <code>userProperties</code>.</p>
+ *
+ * @param userProperties a {@link java.util.Properties} object
+ */
public void setUserProperties( Properties userProperties )
{
this.userProperties = userProperties;
}
-}
\ No newline at end of file
+}
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/PropertiesReleaseDescriptorStore.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/PropertiesReleaseDescriptorStore.java
index a7506b8..3033a45 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/PropertiesReleaseDescriptorStore.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/PropertiesReleaseDescriptorStore.java
@@ -69,12 +69,27 @@ public class PropertiesReleaseDescriptorStore
return read( mergeDescriptor, getDefaultReleasePropertiesFile( mergeDescriptor.build() ) );
}
+ /**
+ * <p>read.</p>
+ *
+ * @param file a {@link java.io.File} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ * @throws org.apache.maven.shared.release.config.ReleaseDescriptorStoreException if any.
+ */
public ReleaseDescriptorBuilder read( File file )
throws ReleaseDescriptorStoreException
{
return read( null, file );
}
+ /**
+ * <p>read.</p>
+ *
+ * @param mergeDescriptor a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ * @param file a {@link java.io.File} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ * @throws org.apache.maven.shared.release.config.ReleaseDescriptorStoreException if any.
+ */
public ReleaseDescriptorBuilder read( ReleaseDescriptorBuilder mergeDescriptor, File file )
throws ReleaseDescriptorStoreException
{
@@ -135,6 +150,14 @@ public class PropertiesReleaseDescriptorStore
}
}
+ /**
+ * <p>write.</p>
+ *
+ * @param config a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder.BuilderReleaseDescriptor}
+ * object
+ * @param file a {@link java.io.File} object
+ * @throws org.apache.maven.shared.release.config.ReleaseDescriptorStoreException if any.
+ */
public void write( BuilderReleaseDescriptor config, File file )
throws ReleaseDescriptorStoreException
{
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorBuilder.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorBuilder.java
index eb3c3f3..e6efa91 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorBuilder.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorBuilder.java
@@ -24,7 +24,8 @@ import java.util.List;
import org.apache.maven.model.Scm;
/**
- *
+ * <p>ReleaseDescriptorBuilder class.</p>
+ *
* @author Robert Scholte
* @since 3.0.0
*/
@@ -45,191 +46,380 @@ public class ReleaseDescriptorBuilder
private final BuilderReleaseDescriptor releaseDescriptor;
+ /**
+ * <p>Constructor for ReleaseDescriptorBuilder.</p>
+ */
public ReleaseDescriptorBuilder()
{
this.releaseDescriptor = new BuilderReleaseDescriptor();
}
+ /**
+ * <p>addCheckModificationExclude.</p>
+ *
+ * @param string a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder addCheckModificationExclude( String string )
{
releaseDescriptor.addCheckModificationExclude( string );
return this;
}
+ /**
+ * <p>setActivateProfiles.</p>
+ *
+ * @param profiles a {@link java.util.List} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setActivateProfiles( List<String> profiles )
{
releaseDescriptor.setActivateProfiles( profiles );
return this;
}
+ /**
+ * <p>setAddSchema.</p>
+ *
+ * @param addSchema a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setAddSchema( boolean addSchema )
{
releaseDescriptor.setAddSchema( addSchema );
return this;
}
+ /**
+ * <p>setAdditionalArguments.</p>
+ *
+ * @param additionalArguments a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setAdditionalArguments( String additionalArguments )
{
releaseDescriptor.setAdditionalArguments( additionalArguments );
return this;
}
+ /**
+ * <p>setAllowTimestampedSnapshots.</p>
+ *
+ * @param allowTimestampedSnapshots a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setAllowTimestampedSnapshots( boolean allowTimestampedSnapshots )
{
releaseDescriptor.setAllowTimestampedSnapshots( allowTimestampedSnapshots );
return this;
}
+ /**
+ * <p>setAutoVersionSubmodules.</p>
+ *
+ * @param autoVersionSubmodules a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setAutoVersionSubmodules( boolean autoVersionSubmodules )
{
releaseDescriptor.setAutoVersionSubmodules( autoVersionSubmodules );
return this;
}
+ /**
+ * <p>setBranchCreation.</p>
+ *
+ * @param branchCreation a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setBranchCreation( boolean branchCreation )
{
releaseDescriptor.setBranchCreation( branchCreation );
return this;
}
+ /**
+ * <p>setCheckModificationExcludes.</p>
+ *
+ * @param checkModificationExcludes a {@link java.util.List} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setCheckModificationExcludes( List<String> checkModificationExcludes )
{
releaseDescriptor.setCheckModificationExcludes( checkModificationExcludes );
return this;
}
+ /**
+ * <p>setCheckoutDirectory.</p>
+ *
+ * @param checkoutDirectory a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setCheckoutDirectory( String checkoutDirectory )
{
releaseDescriptor.setCheckoutDirectory( checkoutDirectory );
return this;
}
+ /**
+ * <p>setCommitByProject.</p>
+ *
+ * @param commitByProject a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setCommitByProject( boolean commitByProject )
{
releaseDescriptor.setCommitByProject( commitByProject );
return this;
}
+ /**
+ * <p>setCompletedPhase.</p>
+ *
+ * @param completedPhase a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setCompletedPhase( String completedPhase )
{
releaseDescriptor.setCompletedPhase( completedPhase );
return this;
}
+ /**
+ * <p>setCompletionGoals.</p>
+ *
+ * @param completionGoals a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setCompletionGoals( String completionGoals )
{
releaseDescriptor.setCompletionGoals( completionGoals );
return this;
}
+ /**
+ * <p>setDefaultDevelopmentVersion.</p>
+ *
+ * @param defaultDevelopmentVersion a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setDefaultDevelopmentVersion( String defaultDevelopmentVersion )
{
releaseDescriptor.setDefaultDevelopmentVersion( defaultDevelopmentVersion );
return this;
}
+ /**
+ * <p>setDefaultReleaseVersion.</p>
+ *
+ * @param defaultReleaseVersion a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setDefaultReleaseVersion( String defaultReleaseVersion )
{
releaseDescriptor.setDefaultReleaseVersion( defaultReleaseVersion );
return this;
}
+ /**
+ * <p>setDescription.</p>
+ *
+ * @param description a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setDescription( String description )
{
releaseDescriptor.setDescription( description );
return this;
}
+ /**
+ * <p>setGenerateReleasePoms.</p>
+ *
+ * @param generateReleasePoms a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setGenerateReleasePoms( boolean generateReleasePoms )
{
releaseDescriptor.setGenerateReleasePoms( generateReleasePoms );
return this;
}
+ /**
+ * <p>setInteractive.</p>
+ *
+ * @param interactive a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setInteractive( boolean interactive )
{
releaseDescriptor.setInteractive( interactive );
return this;
}
+ /**
+ * <p>setLocalCheckout.</p>
+ *
+ * @param localCheckout a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setLocalCheckout( boolean localCheckout )
{
releaseDescriptor.setLocalCheckout( localCheckout );
return this;
}
+ /**
+ * <p>setModelEncoding.</p>
+ *
+ * @param modelEncoding a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setModelEncoding( String modelEncoding )
{
releaseDescriptor.setModelEncoding( modelEncoding );
return this;
}
+ /**
+ * <p>setName.</p>
+ *
+ * @param name a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setName( String name )
{
releaseDescriptor.setName( name );
return this;
}
+ /**
+ * <p>setPerformGoals.</p>
+ *
+ * @param performGoals a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setPerformGoals( String performGoals )
{
releaseDescriptor.setPerformGoals( performGoals );
return this;
}
+ /**
+ * <p>setPomFileName.</p>
+ *
+ * @param pomFileName a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setPomFileName( String pomFileName )
{
releaseDescriptor.setPomFileName( pomFileName );
return this;
}
+ /**
+ * <p>setPreparationGoals.</p>
+ *
+ * @param preparationGoals a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setPreparationGoals( String preparationGoals )
{
releaseDescriptor.setPreparationGoals( preparationGoals );
return this;
}
+ /**
+ * <p>setProjectNamingPolicyId.</p>
+ *
+ * @param projectNamingPolicyId a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setProjectNamingPolicyId( String projectNamingPolicyId )
{
releaseDescriptor.setProjectNamingPolicyId( projectNamingPolicyId );
return this;
}
+ /**
+ * <p>setProjectVersionPolicyId.</p>
+ *
+ * @param projectVersionPolicyId a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setProjectVersionPolicyId( String projectVersionPolicyId )
{
releaseDescriptor.setProjectVersionPolicyId( projectVersionPolicyId );
return this;
}
+ /**
+ * <p>setPushChanges.</p>
+ *
+ * @param pushChanges a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setPushChanges( boolean pushChanges )
{
releaseDescriptor.setPushChanges( pushChanges );
return this;
}
+ /**
+ * <p>setWorkItem.</p>
+ *
+ * @param workItem a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setWorkItem( String workItem )
{
releaseDescriptor.setWorkItem( workItem );
return this;
}
+ /**
+ * <p>setReleaseStrategyId.</p>
+ *
+ * @param releaseStrategyId a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setReleaseStrategyId( String releaseStrategyId )
{
releaseDescriptor.setReleaseStrategyId( releaseStrategyId );
return this;
}
+ /**
+ * <p>setRemoteTagging.</p>
+ *
+ * @param remoteTagging a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setRemoteTagging( boolean remoteTagging )
{
releaseDescriptor.setRemoteTagging( remoteTagging );
return this;
}
+ /**
+ * <p>setScmBranchBase.</p>
+ *
+ * @param scmBranchBase a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setScmBranchBase( String scmBranchBase )
{
releaseDescriptor.setScmBranchBase( scmBranchBase );
return this;
}
+ /**
+ * <p>setScmCommentPrefix.</p>
+ *
+ * @param scmCommentPrefix a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setScmCommentPrefix( String scmCommentPrefix )
{
releaseDescriptor.setScmCommentPrefix( scmCommentPrefix );
@@ -237,7 +427,11 @@ public class ReleaseDescriptorBuilder
}
/**
+ * <p>setScmReleaseCommitComment.</p>
+ *
* @since 3.0.0-M1
+ * @param scmReleaseCommitComment a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
*/
public ReleaseDescriptorBuilder setScmReleaseCommitComment( String scmReleaseCommitComment )
{
@@ -246,7 +440,11 @@ public class ReleaseDescriptorBuilder
}
/**
+ * <p>setScmDevelopmentCommitComment.</p>
+ *
* @since 3.0.0-M1
+ * @param scmDevelopmentCommitComment a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
*/
public ReleaseDescriptorBuilder setScmDevelopmentCommitComment( String scmDevelopmentCommitComment )
{
@@ -255,7 +453,11 @@ public class ReleaseDescriptorBuilder
}
/**
+ * <p>setScmBranchCommitComment.</p>
+ *
* @since 3.0.0-M1
+ * @param scmBranchCommitComment a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
*/
public ReleaseDescriptorBuilder setScmBranchCommitComment( String scmBranchCommitComment )
{
@@ -264,7 +466,11 @@ public class ReleaseDescriptorBuilder
}
/**
+ * <p>setScmRollbackCommitComment.</p>
+ *
* @since 3.0.0-M1
+ * @param scmRollbackCommitComment a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
*/
public ReleaseDescriptorBuilder setScmRollbackCommitComment( String scmRollbackCommitComment )
{
@@ -272,161 +478,327 @@ public class ReleaseDescriptorBuilder
return this;
}
+ /**
+ * <p>setScmId.</p>
+ *
+ * @param scmId a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setScmId( String scmId )
{
releaseDescriptor.setScmId( scmId );
return this;
}
+ /**
+ * <p>setScmPassword.</p>
+ *
+ * @param scmPassword a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setScmPassword( String scmPassword )
{
releaseDescriptor.setScmPassword( scmPassword );
return this;
}
+ /**
+ * <p>setScmPrivateKey.</p>
+ *
+ * @param scmPrivateKey a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setScmPrivateKey( String scmPrivateKey )
{
releaseDescriptor.setScmPrivateKey( scmPrivateKey );
return this;
}
+ /**
+ * <p>setScmPrivateKeyPassPhrase.</p>
+ *
+ * @param scmPrivateKeyPassPhrase a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setScmPrivateKeyPassPhrase( String scmPrivateKeyPassPhrase )
{
releaseDescriptor.setScmPrivateKeyPassPhrase( scmPrivateKeyPassPhrase );
return this;
}
+ /**
+ * <p>setScmRelativePathProjectDirectory.</p>
+ *
+ * @param scmRelativePathProjectDirectory a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setScmRelativePathProjectDirectory( String scmRelativePathProjectDirectory )
{
releaseDescriptor.setScmRelativePathProjectDirectory( scmRelativePathProjectDirectory );
return this;
}
+ /**
+ * <p>setScmReleaseLabel.</p>
+ *
+ * @param scmReleaseLabel a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setScmReleaseLabel( String scmReleaseLabel )
{
releaseDescriptor.setScmReleaseLabel( scmReleaseLabel );
return this;
}
+ /**
+ * <p>setScmReleasedPomRevision.</p>
+ *
+ * @param scmReleasedPomRevision a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setScmReleasedPomRevision( String scmReleasedPomRevision )
{
releaseDescriptor.setScmReleasedPomRevision( scmReleasedPomRevision );
return this;
}
+ /**
+ * <p>setScmSourceUrl.</p>
+ *
+ * @param scmSourceUrl a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setScmSourceUrl( String scmSourceUrl )
{
releaseDescriptor.setScmSourceUrl( scmSourceUrl );
return this;
}
+ /**
+ * <p>setScmTagBase.</p>
+ *
+ * @param scmTagBase a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setScmTagBase( String scmTagBase )
{
releaseDescriptor.setScmTagBase( scmTagBase );
return this;
}
+ /**
+ * <p>setScmTagNameFormat.</p>
+ *
+ * @param scmTagNameFormat a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setScmTagNameFormat( String scmTagNameFormat )
{
releaseDescriptor.setScmTagNameFormat( scmTagNameFormat );
return this;
}
+ /**
+ * <p>setScmSignTags.</p>
+ *
+ * @param signTags a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setScmSignTags( boolean signTags )
{
releaseDescriptor.setScmSignTags( signTags );
return this;
}
+ /**
+ * <p>setScmUseEditMode.</p>
+ *
+ * @param scmUseEditMode a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setScmUseEditMode( boolean scmUseEditMode )
{
releaseDescriptor.setScmUseEditMode( scmUseEditMode );
return this;
}
+ /**
+ * <p>setScmUsername.</p>
+ *
+ * @param scmUsername a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setScmUsername( String scmUsername )
{
releaseDescriptor.setScmUsername( scmUsername );
return this;
}
+ /**
+ * <p>setSnapshotReleasePluginAllowed.</p>
+ *
+ * @param snapshotReleasePluginAllowed a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setSnapshotReleasePluginAllowed( boolean snapshotReleasePluginAllowed )
{
releaseDescriptor.setSnapshotReleasePluginAllowed( snapshotReleasePluginAllowed );
return this;
}
+ /**
+ * <p>setSuppressCommitBeforeTagOrBranch.</p>
+ *
+ * @param suppressCommitBeforeTagOrBranch a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setSuppressCommitBeforeTagOrBranch( boolean suppressCommitBeforeTagOrBranch )
{
releaseDescriptor.setSuppressCommitBeforeTagOrBranch( suppressCommitBeforeTagOrBranch );
return this;
}
+ /**
+ * <p>setUpdateBranchVersions.</p>
+ *
+ * @param updateBranchVersions a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setUpdateBranchVersions( boolean updateBranchVersions )
{
releaseDescriptor.setUpdateBranchVersions( updateBranchVersions );
return this;
}
+ /**
+ * <p>setUpdateDependencies.</p>
+ *
+ * @param updateDependencies a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setUpdateDependencies( boolean updateDependencies )
{
releaseDescriptor.setUpdateDependencies( updateDependencies );
return this;
}
+ /**
+ * <p>setUpdateVersionsToSnapshot.</p>
+ *
+ * @param updateVersionsToSnapshot a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setUpdateVersionsToSnapshot( boolean updateVersionsToSnapshot )
{
releaseDescriptor.setUpdateVersionsToSnapshot( updateVersionsToSnapshot );
return this;
}
+ /**
+ * <p>setUpdateWorkingCopyVersions.</p>
+ *
+ * @param updateWorkingCopyVersions a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setUpdateWorkingCopyVersions( boolean updateWorkingCopyVersions )
{
releaseDescriptor.setUpdateWorkingCopyVersions( updateWorkingCopyVersions );
return this;
}
+ /**
+ * <p>setUseReleaseProfile.</p>
+ *
+ * @param useReleaseProfile a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setUseReleaseProfile( boolean useReleaseProfile )
{
releaseDescriptor.setUseReleaseProfile( useReleaseProfile );
return this;
}
+ /**
+ * <p>setWaitBeforeTagging.</p>
+ *
+ * @param waitBeforeTagging a int
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setWaitBeforeTagging( int waitBeforeTagging )
{
releaseDescriptor.setWaitBeforeTagging( waitBeforeTagging );
return this;
}
+ /**
+ * <p>setWorkingDirectory.</p>
+ *
+ * @param workingDirectory a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setWorkingDirectory( String workingDirectory )
{
releaseDescriptor.setWorkingDirectory( workingDirectory );
return this;
}
+ /**
+ * <p>addReleaseVersion.</p>
+ *
+ * @param key a {@link java.lang.String} object
+ * @param value a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder addReleaseVersion( String key, String value )
{
releaseDescriptor.addReleaseVersion( key, value );
return this;
}
+ /**
+ * <p>addDevelopmentVersion.</p>
+ *
+ * @param key a {@link java.lang.String} object
+ * @param value a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder addDevelopmentVersion( String key, String value )
{
releaseDescriptor.addDevelopmentVersion( key, value );
return this;
}
+ /**
+ * <p>addOriginalScmInfo.</p>
+ *
+ * @param key a {@link java.lang.String} object
+ * @param value a {@link org.apache.maven.model.Scm} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder addOriginalScmInfo( String key, Scm value )
{
releaseDescriptor.addOriginalScmInfo( key, value );
return this;
}
+ /**
+ * <p>putOriginalVersion.</p>
+ *
+ * @param projectKey a {@link java.lang.String} object
+ * @param version a {@link java.lang.String} object
+ */
public void putOriginalVersion( String projectKey, String version )
{
releaseDescriptor.addOriginalVersion( projectKey, version );
}
+ /**
+ * <p>addDependencyOriginalVersion.</p>
+ *
+ * @param dependencyKey a {@link java.lang.String} object
+ * @param version a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder addDependencyOriginalVersion( String dependencyKey, String version )
{
releaseDescriptor.addDependencyOriginalVersion( dependencyKey, version );
@@ -434,24 +806,50 @@ public class ReleaseDescriptorBuilder
}
+ /**
+ * <p>addDependencyReleaseVersion.</p>
+ *
+ * @param dependencyKey a {@link java.lang.String} object
+ * @param version a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder addDependencyReleaseVersion( String dependencyKey, String version )
{
releaseDescriptor.addDependencyReleaseVersion( dependencyKey, version );
return this;
}
+ /**
+ * <p>addDependencyDevelopmentVersion.</p>
+ *
+ * @param dependencyKey a {@link java.lang.String} object
+ * @param version a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder addDependencyDevelopmentVersion( String dependencyKey, String version )
{
releaseDescriptor.addDependencyDevelopmentVersion( dependencyKey, version );
return this;
}
+ /**
+ * <p>setAutoResolveSnapshots.</p>
+ *
+ * @param autoResolveSnapshots a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setAutoResolveSnapshots( String autoResolveSnapshots )
{
releaseDescriptor.setAutoResolveSnapshots( autoResolveSnapshots );
return this;
}
+ /**
+ * <p>setPinExternals.</p>
+ *
+ * @param pinExternals a boolean
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public ReleaseDescriptorBuilder setPinExternals( boolean pinExternals )
{
releaseDescriptor.setPinExternals( pinExternals );
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorStore.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorStore.java
index 69092c1..4327be1 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorStore.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorStore.java
@@ -32,6 +32,7 @@ public interface ReleaseDescriptorStore
* @param mergeDescriptor configuration to merge with the loaded configuration. Some values are used as defaults,
* while others are used to override
* @return the configuration
+ * @throws org.apache.maven.shared.release.config.ReleaseDescriptorStoreException if any.
*/
ReleaseDescriptorBuilder read( ReleaseDescriptorBuilder mergeDescriptor )
throws ReleaseDescriptorStoreException;
@@ -40,6 +41,7 @@ public interface ReleaseDescriptorStore
* Save a configuration.
*
* @param config the configuration
+ * @throws org.apache.maven.shared.release.config.ReleaseDescriptorStoreException if any.
*/
void write( ReleaseDescriptor config )
throws ReleaseDescriptorStoreException;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorStoreException.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorStoreException.java
index 443da6c..e6f3d70 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorStoreException.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseDescriptorStoreException.java
@@ -27,6 +27,12 @@ package org.apache.maven.shared.release.config;
public class ReleaseDescriptorStoreException
extends Exception
{
+ /**
+ * <p>Constructor for ReleaseDescriptorStoreException.</p>
+ *
+ * @param message a {@link java.lang.String} object
+ * @param t a {@link java.lang.Throwable} object
+ */
public ReleaseDescriptorStoreException( String message, Throwable t )
{
super( message, t );
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseUtils.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseUtils.java
index ed31afe..8ede3e5 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseUtils.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/config/ReleaseUtils.java
@@ -44,11 +44,23 @@ public class ReleaseUtils
// nothing to see here
}
+ /**
+ * <p>buildReleaseDescriptor.</p>
+ *
+ * @param builder a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder.BuilderReleaseDescriptor} object
+ */
public static BuilderReleaseDescriptor buildReleaseDescriptor( ReleaseDescriptorBuilder builder )
{
return builder.build();
}
+ /**
+ * <p>copyPropertiesToReleaseDescriptor.</p>
+ *
+ * @param properties a {@link java.util.Properties} object
+ * @param builder a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object
+ */
public static void copyPropertiesToReleaseDescriptor( Properties properties, ReleaseDescriptorBuilder builder )
{
if ( properties.containsKey( "completedPhase" ) )
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/env/DefaultReleaseEnvironment.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/env/DefaultReleaseEnvironment.java
index 3305756..1562c2e 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/env/DefaultReleaseEnvironment.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/env/DefaultReleaseEnvironment.java
@@ -25,6 +25,7 @@ import java.util.Locale;
import org.apache.maven.settings.Settings;
/**
+ * <p>DefaultReleaseEnvironment class.</p>
*
*/
public class DefaultReleaseEnvironment
@@ -55,12 +56,24 @@ public class DefaultReleaseEnvironment
return settings;
}
+ /**
+ * <p>Setter for the field <code>mavenHome</code>.</p>
+ *
+ * @param mavenHome a {@link java.io.File} object
+ * @return a {@link org.apache.maven.shared.release.env.DefaultReleaseEnvironment} object
+ */
public DefaultReleaseEnvironment setMavenHome( File mavenHome )
{
this.mavenHome = mavenHome;
return this;
}
+ /**
+ * <p>Setter for the field <code>settings</code>.</p>
+ *
+ * @param settings a {@link org.apache.maven.settings.Settings} object
+ * @return a {@link org.apache.maven.shared.release.env.DefaultReleaseEnvironment} object
+ */
public DefaultReleaseEnvironment setSettings( Settings settings )
{
this.settings = settings;
@@ -73,6 +86,12 @@ public class DefaultReleaseEnvironment
return mavenExecutorId;
}
+ /**
+ * <p>Setter for the field <code>mavenExecutorId</code>.</p>
+ *
+ * @param mavenExecutorId a {@link java.lang.String} object
+ * @return a {@link org.apache.maven.shared.release.env.DefaultReleaseEnvironment} object
+ */
public DefaultReleaseEnvironment setMavenExecutorId( String mavenExecutorId )
{
this.mavenExecutorId = mavenExecutorId;
@@ -85,6 +104,12 @@ public class DefaultReleaseEnvironment
return javaHome;
}
+ /**
+ * <p>Setter for the field <code>javaHome</code>.</p>
+ *
+ * @param javaHome a {@link java.io.File} object
+ * @return a {@link org.apache.maven.shared.release.env.DefaultReleaseEnvironment} object
+ */
public DefaultReleaseEnvironment setJavaHome( File javaHome )
{
this.javaHome = javaHome;
@@ -104,6 +129,12 @@ public class DefaultReleaseEnvironment
return localRepo;
}
+ /**
+ * <p>Setter for the field <code>localRepositoryDirectory</code>.</p>
+ *
+ * @param localRepositoryDirectory a {@link java.io.File} object
+ * @return a {@link org.apache.maven.shared.release.env.DefaultReleaseEnvironment} object
+ */
public DefaultReleaseEnvironment setLocalRepositoryDirectory( File localRepositoryDirectory )
{
this.localRepositoryDirectory = localRepositoryDirectory;
@@ -116,6 +147,12 @@ public class DefaultReleaseEnvironment
return locale;
}
+ /**
+ * <p>Setter for the field <code>locale</code>.</p>
+ *
+ * @param locale a {@link java.util.Locale} object
+ * @return a {@link org.apache.maven.shared.release.env.DefaultReleaseEnvironment} object
+ */
public DefaultReleaseEnvironment setLocale( Locale locale )
{
this.locale = locale;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/AbstractMavenExecutor.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/AbstractMavenExecutor.java
index e70fa0e..0041351 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/AbstractMavenExecutor.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/AbstractMavenExecutor.java
@@ -44,6 +44,7 @@ import org.sonatype.plexus.components.sec.dispatcher.SecUtil;
import org.sonatype.plexus.components.sec.dispatcher.model.SettingsSecurity;
/**
+ * <p>Abstract AbstractMavenExecutor class.</p>
*
*/
public abstract class AbstractMavenExecutor
@@ -65,6 +66,9 @@ public abstract class AbstractMavenExecutor
@Requirement
private PlexusCipher cipher;
+ /**
+ * <p>Constructor for AbstractMavenExecutor.</p>
+ */
protected AbstractMavenExecutor()
{
}
@@ -95,6 +99,11 @@ public abstract class AbstractMavenExecutor
String additionalArguments, String pomFileName, ReleaseResult result )
throws MavenExecutorException;
+ /**
+ * <p>Getter for the field <code>logger</code>.</p>
+ *
+ * @return a {@link org.codehaus.plexus.logging.Logger} object
+ */
protected final Logger getLogger()
{
return logger;
@@ -107,6 +116,12 @@ public abstract class AbstractMavenExecutor
}
+ /**
+ * <p>encryptSettings.</p>
+ *
+ * @param settings a {@link org.apache.maven.settings.Settings} object
+ * @return a {@link org.apache.maven.settings.Settings} object
+ */
protected Settings encryptSettings( Settings settings )
{
Settings encryptedSettings = SettingsUtils.copySettings( settings );
@@ -195,6 +210,11 @@ public abstract class AbstractMavenExecutor
return cipher.isEncryptedString( str );
}
+ /**
+ * <p>getSettingsWriter.</p>
+ *
+ * @return a {@link org.apache.maven.settings.io.xpp3.SettingsXpp3Writer} object
+ */
protected SettingsXpp3Writer getSettingsWriter()
{
return new SettingsXpp3Writer();
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/CommandLineFactory.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/CommandLineFactory.java
index 3699f68..c90d69c 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/CommandLineFactory.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/CommandLineFactory.java
@@ -33,7 +33,8 @@ public interface CommandLineFactory
*
* @param executable the executable
* @return the command line
- * @throws MavenExecutorException if there was a problem creating the command line
+ * @throws org.apache.maven.shared.release.exec.MavenExecutorException if there was a problem creating
+ * the command line
*/
Commandline createCommandLine( String executable )
throws MavenExecutorException;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/ForkedMavenExecutor.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/ForkedMavenExecutor.java
index af0051f..2c8907d 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/ForkedMavenExecutor.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/ForkedMavenExecutor.java
@@ -162,12 +162,27 @@ public class ForkedMavenExecutor
}
}
+ /**
+ * <p>Setter for the field <code>commandLineFactory</code>.</p>
+ *
+ * @param commandLineFactory a {@link org.apache.maven.shared.release.exec.CommandLineFactory} object
+ */
public void setCommandLineFactory( CommandLineFactory commandLineFactory )
{
this.commandLineFactory = commandLineFactory;
}
+ /**
+ * <p>executeCommandLine.</p>
+ *
+ * @param cl a {@link org.codehaus.plexus.util.cli.Commandline} object
+ * @param systemIn a {@link java.io.InputStream} object
+ * @param systemOut a {@link java.io.OutputStream} object
+ * @param systemErr a {@link java.io.OutputStream} object
+ * @return a int
+ * @throws org.codehaus.plexus.util.cli.CommandLineException if any.
+ */
public static int executeCommandLine( Commandline cl, InputStream systemIn, OutputStream systemOut,
OutputStream systemErr )
throws CommandLineException
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/InvokerMavenExecutor.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/InvokerMavenExecutor.java
index eb9e044..974a8e4 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/InvokerMavenExecutor.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/InvokerMavenExecutor.java
@@ -94,6 +94,7 @@ public class InvokerMavenExecutor
private static final String BATCH_MODE = "B";
+ /** Constant <code>ALTERNATE_USER_TOOLCHAINS='t'</code> */
public static final char ALTERNATE_USER_TOOLCHAINS = 't';
static
@@ -163,6 +164,14 @@ public class InvokerMavenExecutor
}
// TODO: Configuring an invocation request from a command line could as well be part of the Invoker API
+ /**
+ * <p>setupRequest.</p>
+ *
+ * @param req a {@link org.apache.maven.shared.invoker.InvocationRequest} object
+ * @param bridge a {@link org.apache.maven.shared.invoker.InvokerLogger} object
+ * @param additionalArguments a {@link java.lang.String} object
+ * @throws org.apache.maven.shared.release.exec.MavenExecutorException if any.
+ */
protected void setupRequest( InvocationRequest req,
InvokerLogger bridge,
String additionalArguments )
@@ -409,11 +418,21 @@ public class InvokerMavenExecutor
}
}
+ /**
+ * <p>getInvokerLogger.</p>
+ *
+ * @return a {@link org.apache.maven.shared.invoker.InvokerLogger} object
+ */
protected InvokerLogger getInvokerLogger()
{
return new LoggerBridge( getLogger() );
}
+ /**
+ * <p>getOutputHandler.</p>
+ *
+ * @return a {@link org.apache.maven.shared.invoker.InvocationOutputHandler} object
+ */
protected InvocationOutputHandler getOutputHandler()
{
return new Handler( getLogger() );
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/MavenExecutor.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/MavenExecutor.java
index e1fe9f5..e3fd6f1 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/MavenExecutor.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/MavenExecutor.java
@@ -41,7 +41,7 @@ public interface MavenExecutor
* @param additionalArguments additional arguments to pass to the Maven command
* @param pomFileName the file name of the POM to execute on
* @param result holds all results of the execution
- * @throws MavenExecutorException if an error occurred executing Maven
+ * @throws org.apache.maven.shared.release.exec.MavenExecutorException if an error occurred executing Maven
*/
void executeGoals( File workingDirectory, String goals, ReleaseEnvironment releaseEnvironment,
boolean interactive, String additionalArguments, String pomFileName, ReleaseResult result )
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/MavenExecutorException.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/MavenExecutorException.java
index 74300c7..9d8c815 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/MavenExecutorException.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/MavenExecutorException.java
@@ -29,6 +29,12 @@ public class MavenExecutorException
{
private int exitCode;
+ /**
+ * <p>Constructor for MavenExecutorException.</p>
+ *
+ * @param message a {@link java.lang.String} object
+ * @param exitCode a int
+ */
public MavenExecutorException( String message, int exitCode )
{
super( message );
@@ -36,11 +42,22 @@ public class MavenExecutorException
this.exitCode = exitCode;
}
+ /**
+ * <p>Constructor for MavenExecutorException.</p>
+ *
+ * @param message a {@link java.lang.String} object
+ * @param cause a {@link java.lang.Throwable} object
+ */
public MavenExecutorException( String message, Throwable cause )
{
super( message, cause );
}
+ /**
+ * <p>Getter for the field <code>exitCode</code>.</p>
+ *
+ * @return a int
+ */
public int getExitCode()
{
return exitCode;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/RawStreamPumper.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/RawStreamPumper.java
index f75b69e..de38e44 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/RawStreamPumper.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/RawStreamPumper.java
@@ -24,6 +24,7 @@ import java.io.InputStream;
import java.io.OutputStream;
/**
+ * <p>RawStreamPumper class.</p>
*
*/
public class RawStreamPumper
@@ -39,6 +40,13 @@ public class RawStreamPumper
byte buffer[] = new byte[256];
+ /**
+ * <p>Constructor for RawStreamPumper.</p>
+ *
+ * @param in a {@link java.io.InputStream} object
+ * @param out a {@link java.io.OutputStream} object
+ * @param poll a boolean
+ */
public RawStreamPumper( InputStream in , OutputStream out, boolean poll )
{
this.in = in;
@@ -46,6 +54,12 @@ public class RawStreamPumper
this.poll = poll;
}
+ /**
+ * <p>Constructor for RawStreamPumper.</p>
+ *
+ * @param in a {@link java.io.InputStream} object
+ * @param out a {@link java.io.OutputStream} object
+ */
public RawStreamPumper( InputStream in , OutputStream out )
{
this.in = in;
@@ -53,17 +67,30 @@ public class RawStreamPumper
this.poll = false;
}
+ /**
+ * <p>Setter for the field <code>done</code>.</p>
+ */
public void setDone()
{
done = true;
}
+ /**
+ * <p>closeInput.</p>
+ *
+ * @throws java.io.IOException if any.
+ */
public void closeInput()
throws IOException
{
in.close();
}
+ /**
+ * <p>closeOutput.</p>
+ *
+ * @throws java.io.IOException if any.
+ */
public void closeOutput()
throws IOException
{
@@ -125,4 +152,4 @@ public class RawStreamPumper
done = true;
}
}
-}
\ No newline at end of file
+}
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/TeeConsumer.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/TeeConsumer.java
index 1ca0092..c10788e 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/TeeConsumer.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/TeeConsumer.java
@@ -42,11 +42,22 @@ public class TeeConsumer
private String indent;
+ /**
+ * <p>Constructor for TeeConsumer.</p>
+ *
+ * @param stream a {@link java.io.PrintStream} object
+ */
public TeeConsumer( PrintStream stream )
{
this( stream, " " );
}
+ /**
+ * <p>Constructor for TeeConsumer.</p>
+ *
+ * @param stream a {@link java.io.PrintStream} object
+ * @param indent a {@link java.lang.String} object
+ */
public TeeConsumer( PrintStream stream, String indent )
{
this.stream = stream;
@@ -63,6 +74,11 @@ public class TeeConsumer
content.append( LS );
}
+ /**
+ * <p>Getter for the field <code>content</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getContent()
{
return content.toString();
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/TeeOutputStream.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/TeeOutputStream.java
index e06fa13..bfa6143 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/TeeOutputStream.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/exec/TeeOutputStream.java
@@ -25,6 +25,7 @@ import java.io.IOException;
import java.io.OutputStream;
/**
+ * <p>TeeOutputStream class.</p>
*
*/
public class TeeOutputStream
@@ -34,11 +35,22 @@ public class TeeOutputStream
private byte indent[];
private int last = '\n';
+ /**
+ * <p>Constructor for TeeOutputStream.</p>
+ *
+ * @param out a {@link java.io.OutputStream} object
+ */
public TeeOutputStream( OutputStream out )
{
this( out, " " );
}
+ /**
+ * <p>Constructor for TeeOutputStream.</p>
+ *
+ * @param out a {@link java.io.OutputStream} object
+ * @param i a {@link java.lang.String} object
+ */
public TeeOutputStream( OutputStream out, String i )
{
super( out );
@@ -86,6 +98,11 @@ public class TeeOutputStream
return bout.toString();
}
+ /**
+ * <p>getContent.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getContent()
{
return bout.toString();
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractBackupPomsPhase.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractBackupPomsPhase.java
index b2a7e8e..81963de 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractBackupPomsPhase.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractBackupPomsPhase.java
@@ -25,6 +25,8 @@ import org.apache.maven.shared.release.util.ReleaseUtil;
import java.io.File;
/**
+ * <p>Abstract AbstractBackupPomsPhase class.</p>
+ *
* @author Edwin Punzalan
*/
public abstract class AbstractBackupPomsPhase
@@ -32,6 +34,12 @@ public abstract class AbstractBackupPomsPhase
{
private final String backupSuffix = ".releaseBackup";
+ /**
+ * <p>getPomBackup.</p>
+ *
+ * @param project a {@link org.apache.maven.project.MavenProject} object
+ * @return a {@link java.io.File} object
+ */
protected File getPomBackup( MavenProject project )
{
File pomFile = ReleaseUtil.getStandardPom( project );
@@ -46,6 +54,11 @@ public abstract class AbstractBackupPomsPhase
}
}
+ /**
+ * <p>deletePomBackup.</p>
+ *
+ * @param project a {@link org.apache.maven.project.MavenProject} object
+ */
protected void deletePomBackup( MavenProject project )
{
File pomBackup = getPomBackup( project );
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRewritePomsPhase.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRewritePomsPhase.java
index 4c84541..7c5a047 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRewritePomsPhase.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractRewritePomsPhase.java
@@ -92,6 +92,11 @@ public abstract class AbstractRewritePomsPhase
@Requirement( role = ScmTranslator.class )
private Map<String, ScmTranslator> scmTranslators;
+ /**
+ * <p>Getter for the field <code>scmTranslators</code>.</p>
+ *
+ * @return a {@link java.util.Map} object
+ */
protected final Map<String, ScmTranslator> getScmTranslators()
{
return scmTranslators;
@@ -99,11 +104,21 @@ public abstract class AbstractRewritePomsPhase
private String ls = ReleaseUtil.LS;
+ /**
+ * <p>Setter for the field <code>ls</code>.</p>
+ *
+ * @param ls a {@link java.lang.String} object
+ */
public void setLs( String ls )
{
this.ls = ls;
}
+ /**
+ * <p>Setter for the field <code>modelETL</code>.</p>
+ *
+ * @param modelETL a {@link java.lang.String} object
+ */
public void setModelETL( String modelETL )
{
this.modelETL = modelETL;
@@ -111,11 +126,21 @@ public abstract class AbstractRewritePomsPhase
private long startTime = -1 * 1000;
+ /**
+ * <p>Setter for the field <code>startTime</code>.</p>
+ *
+ * @param startTime a long
+ */
public void setStartTime( long startTime )
{
this.startTime = startTime;
}
+ /**
+ * <p>getPomSuffix.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
protected abstract String getPomSuffix();
@Override
@@ -590,20 +615,54 @@ public abstract class AbstractRewritePomsPhase
}
+ /**
+ * <p>getResolvedSnapshotVersion.</p>
+ *
+ * @param artifactVersionlessKey a {@link java.lang.String} object
+ * @param releaseDscriptor a {@link org.apache.maven.shared.release.config.ReleaseDescriptor} object
+ * @return a {@link java.lang.String} object
+ */
protected abstract String getResolvedSnapshotVersion( String artifactVersionlessKey,
ReleaseDescriptor releaseDscriptor );
+ /**
+ * <p>getOriginalVersion.</p>
+ *
+ * @param releaseDescriptor a {@link org.apache.maven.shared.release.config.ReleaseDescriptor} object
+ * @param projectKey a {@link java.lang.String} object
+ * @param simulate a boolean
+ * @return a {@link java.lang.String} object
+ */
protected abstract String getOriginalVersion( ReleaseDescriptor releaseDescriptor, String projectKey,
boolean simulate );
+ /**
+ * <p>getNextVersion.</p>
+ *
+ * @param releaseDescriptor a {@link org.apache.maven.shared.release.config.ReleaseDescriptor} object
+ * @param key a {@link java.lang.String} object
+ * @return a {@link java.lang.String} object
+ */
protected abstract String getNextVersion( ReleaseDescriptor releaseDescriptor, String key );
+ /**
+ * <p>transformScm.</p>
+ *
+ * @param project a {@link org.apache.maven.project.MavenProject} object
+ * @param modelTarget a {@link org.apache.maven.model.Model} object
+ * @param releaseDescriptor a {@link org.apache.maven.shared.release.config.ReleaseDescriptor} object
+ * @param projectId a {@link java.lang.String} object
+ * @param scmRepository a {@link org.apache.maven.scm.repository.ScmRepository} object
+ * @param result a {@link org.apache.maven.shared.release.ReleaseResult} object
+ * @throws org.apache.maven.shared.release.ReleaseExecutionException if any.
+ */
protected abstract void transformScm( MavenProject project, Model modelTarget, ReleaseDescriptor releaseDescriptor,
String projectId, ScmRepository scmRepository,
ReleaseResult result )
throws ReleaseExecutionException;
/**
+ * <p>isUpdateScm.</p>
*
* @return {@code true} if the SCM-section should be updated, otherwise {@code false}
* @since 2.4
@@ -613,6 +672,13 @@ public abstract class AbstractRewritePomsPhase
return true;
}
+ /**
+ * <p>getOriginalResolvedSnapshotVersion.</p>
+ *
+ * @param artifactVersionlessKey a {@link java.lang.String} object
+ * @param releaseDescriptor a {@link org.apache.maven.shared.release.config.ReleaseDescriptor} object
+ * @return a {@link java.lang.String} object
+ */
protected String getOriginalResolvedSnapshotVersion( String artifactVersionlessKey,
ReleaseDescriptor releaseDescriptor )
{
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractScmCommitPhase.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractScmCommitPhase.java
index 3ae72ac..b9b1a5a 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractScmCommitPhase.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/AbstractScmCommitPhase.java
@@ -97,10 +97,33 @@ public abstract class AbstractScmCommitPhase
return result;
}
+ /**
+ * <p>runLogic.</p>
+ *
+ * @param releaseDescriptor a {@link org.apache.maven.shared.release.config.ReleaseDescriptor} object
+ * @param releaseEnvironment a {@link org.apache.maven.shared.release.env.ReleaseEnvironment} object
+ * @param reactorProjects a {@link java.util.List} object
+ * @param result a {@link org.apache.maven.shared.release.ReleaseResult} object
+ * @param simulating a boolean
+ * @throws org.apache.maven.shared.release.scm.ReleaseScmCommandException if any.
+ * @throws org.apache.maven.shared.release.ReleaseExecutionException if any.
+ * @throws org.apache.maven.shared.release.scm.ReleaseScmRepositoryException if any.
+ */
protected abstract void runLogic( ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment,
List<MavenProject> reactorProjects, ReleaseResult result, boolean simulating )
throws ReleaseScmCommandException, ReleaseExecutionException, ReleaseScmRepositoryException;
+ /**
+ * <p>performCheckins.</p>
+ *
+ * @param releaseDescriptor a {@link org.apache.maven.shared.release.config.ReleaseDescriptor} object
+ * @param releaseEnvironment a {@link org.apache.maven.shared.release.env.ReleaseEnvironment} object
+ * @param reactorProjects a {@link java.util.List} object
+ * @param message a {@link java.lang.String} object
+ * @throws org.apache.maven.shared.release.scm.ReleaseScmRepositoryException if any.
+ * @throws org.apache.maven.shared.release.ReleaseExecutionException if any.
+ * @throws org.apache.maven.shared.release.scm.ReleaseScmCommandException if any.
+ */
protected void performCheckins( ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment,
List<MavenProject> reactorProjects, String message )
throws ReleaseScmRepositoryException, ReleaseExecutionException, ReleaseScmCommandException
@@ -173,6 +196,14 @@ public abstract class AbstractScmCommitPhase
}
}
+ /**
+ * <p>simulateCheckins.</p>
+ *
+ * @param releaseDescriptor a {@link org.apache.maven.shared.release.config.ReleaseDescriptor} object
+ * @param reactorProjects a {@link java.util.List} object
+ * @param result a {@link org.apache.maven.shared.release.ReleaseResult} object
+ * @param message a {@link java.lang.String} object
+ */
protected void simulateCheckins( ReleaseDescriptor releaseDescriptor, List<MavenProject> reactorProjects,
ReleaseResult result, String message )
{
@@ -180,6 +211,12 @@ public abstract class AbstractScmCommitPhase
logInfo( result, "Full run would be commit " + pomFiles.size() + " files with message: '" + message + "'" );
}
+ /**
+ * <p>validateConfiguration.</p>
+ *
+ * @param releaseDescriptor a {@link org.apache.maven.shared.release.config.ReleaseDescriptor} object
+ * @throws org.apache.maven.shared.release.ReleaseFailureException if any.
+ */
protected void validateConfiguration( ReleaseDescriptor releaseDescriptor )
throws ReleaseFailureException
{
@@ -189,6 +226,14 @@ public abstract class AbstractScmCommitPhase
}
}
+ /**
+ * <p>createMessage.</p>
+ *
+ * @param reactorProjects a {@link java.util.List} object
+ * @param releaseDescriptor a {@link org.apache.maven.shared.release.config.ReleaseDescriptor} object
+ * @return a {@link java.lang.String} object
+ * @throws org.apache.maven.shared.release.ReleaseExecutionException if any.
+ */
protected String createMessage( List<MavenProject> reactorProjects,
ReleaseDescriptor releaseDescriptor )
throws ReleaseExecutionException
@@ -232,6 +277,13 @@ public abstract class AbstractScmCommitPhase
return comment;
}
+ /**
+ * <p>createPomFiles.</p>
+ *
+ * @param releaseDescriptor a {@link org.apache.maven.shared.release.config.ReleaseDescriptor} object
+ * @param project a {@link org.apache.maven.project.MavenProject} object
+ * @return a {@link java.util.List} object
+ */
protected static List<File> createPomFiles( ReleaseDescriptor releaseDescriptor, MavenProject project )
{
List<File> pomFiles = new ArrayList<>();
@@ -246,6 +298,13 @@ public abstract class AbstractScmCommitPhase
return pomFiles;
}
+ /**
+ * <p>createPomFiles.</p>
+ *
+ * @param releaseDescriptor a {@link org.apache.maven.shared.release.config.ReleaseDescriptor} object
+ * @param reactorProjects a {@link java.util.List} object
+ * @return a {@link java.util.List} object
+ */
protected static List<File> createPomFiles( ReleaseDescriptor releaseDescriptor,
List<MavenProject> reactorProjects )
{
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/CheckCompletedPreparePhasesPhase.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/CheckCompletedPreparePhasesPhase.java
index 5f78c76..3424c1e 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/CheckCompletedPreparePhasesPhase.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/CheckCompletedPreparePhasesPhase.java
@@ -31,7 +31,6 @@ import org.codehaus.plexus.component.annotations.Component;
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- * @version $Id$
*/
@Component( role = ReleasePhase.class, hint = "verify-completed-prepare-phases" )
public class CheckCompletedPreparePhasesPhase
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/CheckoutProjectFromScm.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/CheckoutProjectFromScm.java
index 17bc3f4..76e5534 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/CheckoutProjectFromScm.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/CheckoutProjectFromScm.java
@@ -53,7 +53,6 @@ import org.codehaus.plexus.util.StringUtils;
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- * @version $Id$
*/
@Component( role = ReleasePhase.class, hint = "checkout-project-from-scm" )
public class CheckoutProjectFromScm
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/InputVariablesPhase.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/InputVariablesPhase.java
index c155e3c..bdf292f 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/InputVariablesPhase.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/InputVariablesPhase.java
@@ -96,6 +96,15 @@ public class InputVariablesPhase
return branchOperation;
}
+ /**
+ * <p>getScmProvider.</p>
+ *
+ * @param releaseDescriptor a {@link org.apache.maven.shared.release.config.ReleaseDescriptor} object
+ * @param releaseEnvironment a {@link org.apache.maven.shared.release.env.ReleaseEnvironment} object
+ * @return a {@link org.apache.maven.scm.provider.ScmProvider} object
+ * @throws org.apache.maven.shared.release.scm.ReleaseScmRepositoryException if any.
+ * @throws org.apache.maven.shared.release.ReleaseExecutionException if any.
+ */
protected ScmProvider getScmProvider( ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment )
throws ReleaseScmRepositoryException, ReleaseExecutionException
{
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RemoveReleasePomsPhase.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RemoveReleasePomsPhase.java
index e3f0cab..032271f 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RemoveReleasePomsPhase.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RemoveReleasePomsPhase.java
@@ -154,4 +154,4 @@ public class RemoveReleasePomsPhase
}
}
}
-}
\ No newline at end of file
+}
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomVersionsPhase.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomVersionsPhase.java
index 95d06db..3d55614 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomVersionsPhase.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomVersionsPhase.java
@@ -36,6 +36,7 @@ import org.codehaus.plexus.component.annotations.Component;
public class RewritePomVersionsPhase
extends AbstractRewritePomsPhase
{
+
@Override
protected final String getPomSuffix()
{
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForBranchPhase.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForBranchPhase.java
index 82e61b4..6f60c06 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForBranchPhase.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/RewritePomsForBranchPhase.java
@@ -40,7 +40,6 @@ import org.codehaus.plexus.component.annotations.Component;
* Rewrite POMs for branch.
*
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- * @version $Id$
*/
@Component( role = ReleasePhase.class, hint = "rewrite-poms-for-branch" )
public class RewritePomsForBranchPhase
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/ScmBranchPhase.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/ScmBranchPhase.java
index a3243e4..41c2616 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/ScmBranchPhase.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/ScmBranchPhase.java
@@ -58,6 +58,7 @@ public class ScmBranchPhase
@Requirement
private ScmRepositoryConfigurator scmRepositoryConfigurator;
+
@Override
public ReleaseResult execute( ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment,
List<MavenProject> reactorProjects )
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/ScmCommitDevelopmentPhase.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/ScmCommitDevelopmentPhase.java
index c81889e..bf8a8a8 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/ScmCommitDevelopmentPhase.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/phase/ScmCommitDevelopmentPhase.java
@@ -100,4 +100,4 @@ public class ScmCommitDevelopmentPhase
new Object[]{releaseDescriptor.getScmReleaseLabel()} );
}
-}
\ No newline at end of file
+}
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/policies/DefaultNamingPolicy.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/policies/DefaultNamingPolicy.java
index a646dfc..7966730 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/policies/DefaultNamingPolicy.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/policies/DefaultNamingPolicy.java
@@ -26,6 +26,7 @@ import org.apache.maven.shared.release.policy.naming.NamingPolicyResult;
import org.codehaus.plexus.component.annotations.Component;
/**
+ * <p>DefaultNamingPolicy class.</p>
*
* @author Robert Scholte
* @since 3.0.0
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/policies/DefaultVersionPolicy.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/policies/DefaultVersionPolicy.java
index 3f32371..f4c8cf0 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/policies/DefaultVersionPolicy.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/policies/DefaultVersionPolicy.java
@@ -28,6 +28,7 @@ import org.apache.maven.shared.release.versions.VersionParseException;
import org.codehaus.plexus.component.annotations.Component;
/**
+ * <p>DefaultVersionPolicy class.</p>
*
* @author Robert Scholte
*/
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ClearCaseScmTranslator.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ClearCaseScmTranslator.java
index 2baa915..e67b08f 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ClearCaseScmTranslator.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ClearCaseScmTranslator.java
@@ -30,27 +30,18 @@ import org.codehaus.plexus.component.annotations.Component;
public class ClearCaseScmTranslator
implements ScmTranslator
{
- /**
- * {@inheritDoc}
- */
@Override
public String translateBranchUrl( String url, String branchName, String branchBase )
{
return url;
}
- /**
- * {@inheritDoc}
- */
@Override
public String translateTagUrl( String url, String tag, String tagBase )
{
return url;
}
- /**
- * {@inheritDoc}
- */
@Override
public String resolveTag( String tag )
{
@@ -64,9 +55,6 @@ public class ClearCaseScmTranslator
}
}
- /**
- * {@inheritDoc}
- */
@Override
public String toRelativePath( String path )
{
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/CvsScmTranslator.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/CvsScmTranslator.java
index 60370a9..3180a3d 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/CvsScmTranslator.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/CvsScmTranslator.java
@@ -30,27 +30,18 @@ import org.codehaus.plexus.component.annotations.Component;
public class CvsScmTranslator
implements ScmTranslator
{
- /**
- * {@inheritDoc}
- */
@Override
public String translateBranchUrl( String url, String branchName, String branchBase )
{
return url;
}
- /**
- * {@inheritDoc}
- */
@Override
public String translateTagUrl( String url, String tag, String tagBase )
{
return url;
}
- /**
- * {@inheritDoc}
- */
@Override
public String resolveTag( String tag )
{
@@ -64,9 +55,6 @@ public class CvsScmTranslator
}
}
- /**
- * {@inheritDoc}
- */
@Override
public String toRelativePath( String path )
{
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/DefaultScmRepositoryConfigurator.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/DefaultScmRepositoryConfigurator.java
index 3bfa4dd..0dd2280 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/DefaultScmRepositoryConfigurator.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/DefaultScmRepositoryConfigurator.java
@@ -207,6 +207,11 @@ public class DefaultScmRepositoryConfigurator
return scmManager.getProviderByRepository( repository );
}
+ /**
+ * <p>Setter for the field <code>scmManager</code>.</p>
+ *
+ * @param scmManager a {@link org.apache.maven.scm.manager.ScmManager} object
+ */
public void setScmManager( ScmManager scmManager )
{
this.scmManager = scmManager;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/GitScmTranslator.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/GitScmTranslator.java
index ccc67ce..2739576 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/GitScmTranslator.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/GitScmTranslator.java
@@ -22,6 +22,7 @@ package org.apache.maven.shared.release.scm;
import org.codehaus.plexus.component.annotations.Component;
/**
+ * <p>GitScmTranslator class.</p>
*/
@Component( role = ScmTranslator.class, hint = "git" )
public class GitScmTranslator
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/HgScmTranslator.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/HgScmTranslator.java
index 953d534..1968fb3 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/HgScmTranslator.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/HgScmTranslator.java
@@ -22,6 +22,7 @@ package org.apache.maven.shared.release.scm;
import org.codehaus.plexus.component.annotations.Component;
/**
+ * <p>HgScmTranslator class.</p>
*/
@Component( role = ScmTranslator.class, hint = "hg" )
public class HgScmTranslator
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/IdentifiedScm.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/IdentifiedScm.java
index 51b3ad1..0a963fb 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/IdentifiedScm.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/IdentifiedScm.java
@@ -26,7 +26,6 @@ import org.apache.maven.model.Scm;
* This makes it quite hard to bind it to the credentials of a server as specified in the settings.xml
*
* @author Robert Scholte
- *
* @since 2.3
*/
public class IdentifiedScm
@@ -36,6 +35,8 @@ public class IdentifiedScm
private String id;
/**
+ * <p>Getter for the field <code>id</code>.</p>
+ *
* @return the id
*/
public String getId()
@@ -44,10 +45,12 @@ public class IdentifiedScm
}
/**
+ * <p>Setter for the field <code>id</code>.</p>
+ *
* @param id the id to set
*/
public void setId( String id )
{
this.id = id;
}
-}
\ No newline at end of file
+}
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/JazzScmTranslator.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/JazzScmTranslator.java
index d5fd8cd..a770d4e 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/JazzScmTranslator.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/JazzScmTranslator.java
@@ -32,9 +32,6 @@ import org.codehaus.plexus.component.annotations.Component;
public class JazzScmTranslator
implements ScmTranslator
{
- /**
- * {@inheritDoc}
- */
@Override
public String translateBranchUrl( String url, String branchName, String branchBase )
{
@@ -53,9 +50,6 @@ public class JazzScmTranslator
return url;
}
- /**
- * {@inheritDoc}
- */
@Override
public String translateTagUrl( String url, String tag, String tagBase )
{
@@ -74,9 +68,6 @@ public class JazzScmTranslator
return url;
}
- /**
- * {@inheritDoc}
- */
@Override
public String resolveTag( String tag )
{
@@ -84,9 +75,6 @@ public class JazzScmTranslator
return null;
}
- /**
- * {@inheritDoc}
- */
@Override
public String toRelativePath( String path )
{
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ReleaseScmCommandException.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ReleaseScmCommandException.java
index 96562f2..a372a2b 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ReleaseScmCommandException.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ReleaseScmCommandException.java
@@ -30,6 +30,12 @@ import org.apache.maven.shared.release.ReleaseFailureException;
public class ReleaseScmCommandException
extends ReleaseFailureException
{
+ /**
+ * <p>Constructor for ReleaseScmCommandException.</p>
+ *
+ * @param message a {@link java.lang.String} object
+ * @param result a {@link org.apache.maven.scm.ScmResult} object
+ */
public ReleaseScmCommandException( String message, ScmResult result )
{
super( message + "\nProvider message:\n" + result.getProviderMessage() + "\nCommand output:\n"
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ReleaseScmRepositoryException.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ReleaseScmRepositoryException.java
index 6edfb22..f644b3b 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ReleaseScmRepositoryException.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ReleaseScmRepositoryException.java
@@ -31,6 +31,12 @@ import java.util.List;
public class ReleaseScmRepositoryException
extends ReleaseFailureException
{
+ /**
+ * <p>Constructor for ReleaseScmRepositoryException.</p>
+ *
+ * @param message a {@link java.lang.String} object
+ * @param validationMessages a {@link java.util.List} object
+ */
public ReleaseScmRepositoryException( String message, List<String> validationMessages )
{
super( message + listValidationMessages( validationMessages ) );
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ScmRepositoryConfigurator.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ScmRepositoryConfigurator.java
index 6281d63..b4c759a 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ScmRepositoryConfigurator.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ScmRepositoryConfigurator.java
@@ -39,8 +39,9 @@ public interface ScmRepositoryConfigurator
* @param releaseDescriptor the configuration to insert into the repository
* @param settings the settings.xml configuraiton
* @return the repository created
- * @throws ScmRepositoryException if it is not possible to create a suitable SCM repository
- * @throws NoSuchScmProviderException if the requested SCM provider is not available
+ * @throws org.apache.maven.scm.repository.ScmRepositoryException if it is not possible to create a suitable
+ * SCM repository
+ * @throws org.apache.maven.scm.manager.NoSuchScmProviderException if the requested SCM provider is not available
*/
ScmRepository getConfiguredRepository( ReleaseDescriptor releaseDescriptor, Settings settings )
throws ScmRepositoryException, NoSuchScmProviderException;
@@ -50,7 +51,7 @@ public interface ScmRepositoryConfigurator
*
* @param repository the SCM repository
* @return the SCM provider
- * @throws NoSuchScmProviderException if the requested SCM provider is not available
+ * @throws org.apache.maven.scm.manager.NoSuchScmProviderException if the requested SCM provider is not available
*/
ScmProvider getRepositoryProvider( ScmRepository repository )
throws NoSuchScmProviderException;
@@ -62,8 +63,9 @@ public interface ScmRepositoryConfigurator
* @param releaseDescriptor the configuration to insert into the repository
* @param settings the settings.xml configuraiton
* @return the repository created
- * @throws ScmRepositoryException if it is not possible to create a suitable SCM repository
- * @throws NoSuchScmProviderException if the requested SCM provider is not available
+ * @throws org.apache.maven.scm.repository.ScmRepositoryException if it is not possible to create a suitable
+ * SCM repository
+ * @throws org.apache.maven.scm.manager.NoSuchScmProviderException if the requested SCM provider is not available
*/
ScmRepository getConfiguredRepository( String url, ReleaseDescriptor releaseDescriptor, Settings settings )
throws ScmRepositoryException, NoSuchScmProviderException;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/SubversionScmTranslator.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/SubversionScmTranslator.java
index 85b6bb6..abf68e1 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/SubversionScmTranslator.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/SubversionScmTranslator.java
@@ -33,9 +33,6 @@ import org.codehaus.plexus.component.annotations.Component;
public class SubversionScmTranslator
implements ScmTranslator
{
- /**
- * {@inheritDoc}
- */
@Override
public String translateBranchUrl( String url, String branchName, String branchBase )
{
@@ -43,27 +40,18 @@ public class SubversionScmTranslator
new ScmBranch( branchName ) );
}
- /**
- * {@inheritDoc}
- */
@Override
public String translateTagUrl( String url, String tag, String tagBase )
{
return SvnTagBranchUtils.resolveUrl( url, tagBase, SvnTagBranchUtils.SVN_TAGS, new ScmTag( tag ) );
}
- /**
- * {@inheritDoc}
- */
@Override
public String resolveTag( String tag )
{
return null;
}
- /**
- * {@inheritDoc}
- */
@Override
public String toRelativePath( String path )
{
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/strategies/DefaultStrategy.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/strategies/DefaultStrategy.java
index ad5c1ee..3a8042a 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/strategies/DefaultStrategy.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/strategies/DefaultStrategy.java
@@ -24,7 +24,8 @@ import java.util.List;
import org.apache.maven.shared.release.strategy.Strategy;
/**
- *
+ * <p>DefaultStrategy class.</p>
+ *
* @author Robert Scholte
* @since 3.0.0
*/
@@ -61,6 +62,11 @@ public class DefaultStrategy implements Strategy
return preparePhases;
}
+ /**
+ * <p>Setter for the field <code>preparePhases</code>.</p>
+ *
+ * @param preparePhases a {@link java.util.List} object
+ */
public void setPreparePhases( List<String> preparePhases )
{
this.preparePhases = preparePhases;
@@ -72,6 +78,11 @@ public class DefaultStrategy implements Strategy
return performPhases;
}
+ /**
+ * <p>Setter for the field <code>performPhases</code>.</p>
+ *
+ * @param performPhases a {@link java.util.List} object
+ */
public void setPerformPhases( List<String> performPhases )
{
this.performPhases = performPhases;
@@ -83,6 +94,11 @@ public class DefaultStrategy implements Strategy
return rollbackPhases;
}
+ /**
+ * <p>Setter for the field <code>rollbackPhases</code>.</p>
+ *
+ * @param rollbackPhases a {@link java.util.List} object
+ */
public void setRollbackPhases( List<String> rollbackPhases )
{
this.rollbackPhases = rollbackPhases;
@@ -94,6 +110,11 @@ public class DefaultStrategy implements Strategy
return branchPhases;
}
+ /**
+ * <p>Setter for the field <code>branchPhases</code>.</p>
+ *
+ * @param branchPhases a {@link java.util.List} object
+ */
public void setBranchPhases( List<String> branchPhases )
{
this.branchPhases = branchPhases;
@@ -105,6 +126,11 @@ public class DefaultStrategy implements Strategy
return updateVersionsPhases;
}
+ /**
+ * <p>Setter for the field <code>updateVersionsPhases</code>.</p>
+ *
+ * @param updateVersionsPhases a {@link java.util.List} object
+ */
public void setUpdateVersionsPhases( List<String> updateVersionsPhases )
{
this.updateVersionsPhases = updateVersionsPhases;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/MavenCoordinate.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/MavenCoordinate.java
index 69b08e1..422b66c 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/MavenCoordinate.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/MavenCoordinate.java
@@ -20,20 +20,46 @@ package org.apache.maven.shared.release.transform;
*/
/**
+ * <p>MavenCoordinate interface.</p>
*
* @author Robert Scholte
* @since 3.0
*/
public interface MavenCoordinate
{
+ /**
+ * <p>getGroupId.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
String getGroupId();
+ /**
+ * <p>getArtifactId.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
String getArtifactId();
+ /**
+ * <p>getVersion.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
String getVersion();
+ /**
+ * <p>setVersion.</p>
+ *
+ * @param version a {@link java.lang.String} object
+ */
void setVersion( String version );
// @todo helper method during refactoring, will be removed
+ /**
+ * <p>getName.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
String getName();
}
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/ModelETL.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/ModelETL.java
index e0c2550..4ebd365 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/ModelETL.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/ModelETL.java
@@ -25,19 +25,40 @@ import org.apache.maven.model.Model;
import org.apache.maven.shared.release.ReleaseExecutionException;
/**
+ * <p>ModelETL interface.</p>
*
* @author Robert Scholte
* @since 3.0
*/
public interface ModelETL
{
+ /**
+ * <p>extract.</p>
+ *
+ * @param pomFile a {@link java.io.File} object
+ * @throws org.apache.maven.shared.release.ReleaseExecutionException if any.
+ */
void extract( File pomFile ) throws ReleaseExecutionException;
+ /**
+ * <p>transform.</p>
+ */
void transform();
+ /**
+ * <p>load.</p>
+ *
+ * @param pomFile a {@link java.io.File} object
+ * @throws org.apache.maven.shared.release.ReleaseExecutionException if any.
+ */
void load( File pomFile ) throws ReleaseExecutionException;
// will be removed once transform() is implemented
+ /**
+ * <p>getModel.</p>
+ *
+ * @return a {@link org.apache.maven.model.Model} object
+ */
@Deprecated
Model getModel();
}
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/ModelETLFactory.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/ModelETLFactory.java
index 4748edc..618d93e 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/ModelETLFactory.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/ModelETLFactory.java
@@ -20,11 +20,18 @@ package org.apache.maven.shared.release.transform;
*/
/**
+ * <p>ModelETLFactory interface.</p>
*
* @author Robert Scholte
* @since 3.0
*/
public interface ModelETLFactory
{
+ /**
+ * <p>newInstance.</p>
+ *
+ * @param request a {@link org.apache.maven.shared.release.transform.ModelETLRequest} object
+ * @return a {@link org.apache.maven.shared.release.transform.ModelETL} object
+ */
ModelETL newInstance( ModelETLRequest request );
}
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/ModelETLRequest.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/ModelETLRequest.java
index ae57d1f..c39c56f 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/ModelETLRequest.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/ModelETLRequest.java
@@ -23,6 +23,7 @@ import org.apache.maven.project.MavenProject;
import org.apache.maven.shared.release.config.ReleaseDescriptor;
/**
+ * <p>ModelETLRequest class.</p>
*
* @author Robert Scholte
* @since 3.0
@@ -35,33 +36,63 @@ public class ModelETLRequest
private ReleaseDescriptor releaseDescriptor;
+ /**
+ * <p>Getter for the field <code>lineSeparator</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getLineSeparator()
{
return lineSeparator;
}
+ /**
+ * <p>Setter for the field <code>lineSeparator</code>.</p>
+ *
+ * @param lineSeparator a {@link java.lang.String} object
+ */
public void setLineSeparator( String lineSeparator )
{
this.lineSeparator = lineSeparator;
}
+ /**
+ * <p>Getter for the field <code>project</code>.</p>
+ *
+ * @return a {@link org.apache.maven.project.MavenProject} object
+ */
public MavenProject getProject()
{
return project;
}
+ /**
+ * <p>Setter for the field <code>project</code>.</p>
+ *
+ * @param project a {@link org.apache.maven.project.MavenProject} object
+ */
public void setProject( MavenProject project )
{
this.project = project;
}
+ /**
+ * <p>Getter for the field <code>releaseDescriptor</code>.</p>
+ *
+ * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptor} object
+ */
public ReleaseDescriptor getReleaseDescriptor()
{
return releaseDescriptor;
}
+ /**
+ * <p>Setter for the field <code>releaseDescriptor</code>.</p>
+ *
+ * @param releaseDescriptor a {@link org.apache.maven.shared.release.config.ReleaseDescriptor} object
+ */
public void setReleaseDescriptor( ReleaseDescriptor releaseDescriptor )
{
this.releaseDescriptor = releaseDescriptor;
}
-}
\ No newline at end of file
+}
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomBuild.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomBuild.java
index cc00f32..53fb678 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomBuild.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomBuild.java
@@ -41,6 +41,11 @@ public class JDomBuild
{
private final Element build;
+ /**
+ * <p>Constructor for JDomBuild.</p>
+ *
+ * @param build a {@link org.jdom2.Element} object
+ */
public JDomBuild( Element build )
{
this.build = build;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomDependency.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomDependency.java
index c1f6230..3d94cc7 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomDependency.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomDependency.java
@@ -36,6 +36,11 @@ public class JDomDependency extends Dependency implements MavenCoordinate
{
private final MavenCoordinate coordinate;
+ /**
+ * <p>Constructor for JDomDependency.</p>
+ *
+ * @param dependency a {@link org.jdom2.Element} object
+ */
public JDomDependency( Element dependency )
{
this.coordinate = new JDomMavenCoordinate( dependency );
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomDependencyManagement.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomDependencyManagement.java
index 84fc1f9..5fcf488 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomDependencyManagement.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomDependencyManagement.java
@@ -37,6 +37,11 @@ public class JDomDependencyManagement extends DependencyManagement
{
private final Element dependencyManagement;
+ /**
+ * <p>Constructor for JDomDependencyManagement.</p>
+ *
+ * @param dependencyManagement a {@link org.jdom2.Element} object
+ */
public JDomDependencyManagement( Element dependencyManagement )
{
this.dependencyManagement = dependencyManagement;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomExtension.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomExtension.java
index 49f0f46..9473640 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomExtension.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomExtension.java
@@ -33,6 +33,11 @@ public class JDomExtension extends Extension implements MavenCoordinate
{
private final MavenCoordinate coordinate;
+ /**
+ * <p>Constructor for JDomExtension.</p>
+ *
+ * @param extension a {@link org.jdom2.Element} object
+ */
public JDomExtension( Element extension )
{
this.coordinate = new JDomMavenCoordinate( extension );
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomMavenCoordinate.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomMavenCoordinate.java
index af47636..c2e10aa 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomMavenCoordinate.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomMavenCoordinate.java
@@ -23,6 +23,7 @@ import org.apache.maven.shared.release.transform.MavenCoordinate;
import org.jdom2.Element;
/**
+ * <p>JDomMavenCoordinate class.</p>
*
* @author Robert Scholte
* @since 3.0
@@ -31,6 +32,11 @@ public class JDomMavenCoordinate implements MavenCoordinate
{
private final Element element;
+ /**
+ * <p>Constructor for JDomMavenCoordinate.</p>
+ *
+ * @param elm a {@link org.jdom2.Element} object
+ */
public JDomMavenCoordinate( Element elm )
{
this.element = elm;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModel.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModel.java
index 28c2826..5567e68 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModel.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModel.java
@@ -48,11 +48,21 @@ public class JDomModel extends Model
private final JDomModelBase modelBase;
+ /**
+ * <p>Constructor for JDomModel.</p>
+ *
+ * @param document a {@link org.jdom2.Document} object
+ */
public JDomModel( Document document )
{
this( document.getRootElement() );
}
+ /**
+ * <p>Constructor for JDomModel.</p>
+ *
+ * @param project a {@link org.jdom2.Element} object
+ */
public JDomModel( Element project )
{
this.project = project;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModelBase.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModelBase.java
index 347fb81..c97d599 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModelBase.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModelBase.java
@@ -29,6 +29,7 @@ import org.apache.maven.model.DependencyManagement;
import org.jdom2.Element;
/**
+ * <p>JDomModelBase class.</p>
*
* @author Robert Scholte
* @since 3.0
@@ -37,11 +38,21 @@ public class JDomModelBase
{
private final Element modelBase;
+ /**
+ * <p>Constructor for JDomModelBase.</p>
+ *
+ * @param modelBase a {@link org.jdom2.Element} object
+ */
public JDomModelBase( Element modelBase )
{
this.modelBase = modelBase;
}
+ /**
+ * <p>getBuild.</p>
+ *
+ * @return a {@link org.apache.maven.model.Build} object
+ */
public Build getBuild()
{
Element elm = modelBase.getChild( "build", modelBase.getNamespace() );
@@ -56,6 +67,11 @@ public class JDomModelBase
}
}
+ /**
+ * <p>getDependencies.</p>
+ *
+ * @return a {@link java.util.List} object
+ */
public List<Dependency> getDependencies()
{
Element dependenciesElm = modelBase.getChild( "dependencies", modelBase.getNamespace() );
@@ -78,6 +94,11 @@ public class JDomModelBase
}
}
+ /**
+ * <p>getDependencyManagement.</p>
+ *
+ * @return a {@link org.apache.maven.model.DependencyManagement} object
+ */
public DependencyManagement getDependencyManagement()
{
Element elm = modelBase.getChild( "dependencyManagement", modelBase.getNamespace() );
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModelETL.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModelETL.java
index 2c5bbf5..e0cb7c5 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModelETL.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModelETL.java
@@ -66,16 +66,31 @@ public class JDomModelETL implements ModelETL
private String ls = ReleaseUtil.LS;
+ /**
+ * <p>Setter for the field <code>ls</code>.</p>
+ *
+ * @param ls a {@link java.lang.String} object
+ */
public void setLs( String ls )
{
this.ls = ls;
}
+ /**
+ * <p>Setter for the field <code>releaseDescriptor</code>.</p>
+ *
+ * @param releaseDescriptor a {@link org.apache.maven.shared.release.config.ReleaseDescriptor} object
+ */
public void setReleaseDescriptor( ReleaseDescriptor releaseDescriptor )
{
this.releaseDescriptor = releaseDescriptor;
}
+ /**
+ * <p>Setter for the field <code>project</code>.</p>
+ *
+ * @param project a {@link org.apache.maven.project.MavenProject} object
+ */
public void setProject( MavenProject project )
{
this.project = project;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModelETLFactory.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModelETLFactory.java
index 66db575..4d7ba69 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModelETLFactory.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomModelETLFactory.java
@@ -24,12 +24,15 @@ import org.apache.maven.shared.release.transform.ModelETLFactory;
import org.codehaus.plexus.component.annotations.Component;
/**
+ * <p>JDomModelETLFactory class.</p>
+ *
* @author Robert Scholte
* @since 3.0
*/
@Component( role = ModelETLFactory.class, hint = JDomModelETLFactory.ROLE_HINT )
public class JDomModelETLFactory implements ModelETLFactory
{
+ /** Constant <code>ROLE_HINT="jdom2-sax"</code> */
public static final String ROLE_HINT = "jdom2-sax";
@Override
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomParent.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomParent.java
index 51cb708..9d179c8 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomParent.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomParent.java
@@ -32,6 +32,11 @@ public class JDomParent extends Parent
{
private Element parent;
+ /**
+ * <p>Constructor for JDomParent.</p>
+ *
+ * @param parent a {@link org.jdom2.Element} object
+ */
public JDomParent( Element parent )
{
this.parent = parent;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomPlugin.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomPlugin.java
index 3b29700..128405a 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomPlugin.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomPlugin.java
@@ -41,6 +41,11 @@ public class JDomPlugin extends Plugin implements MavenCoordinate
private Element plugin;
private final MavenCoordinate coordinate;
+ /**
+ * <p>Constructor for JDomPlugin.</p>
+ *
+ * @param plugin a {@link org.jdom2.Element} object
+ */
public JDomPlugin( Element plugin )
{
this.plugin = plugin;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomPluginManagement.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomPluginManagement.java
index 5bfa072..39bd061 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomPluginManagement.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomPluginManagement.java
@@ -38,6 +38,11 @@ public class JDomPluginManagement extends PluginManagement
{
private final Element pluginManagement;
+ /**
+ * <p>Constructor for JDomPluginManagement.</p>
+ *
+ * @param pluginManagement a {@link org.jdom2.Element} object
+ */
public JDomPluginManagement( Element pluginManagement )
{
this.pluginManagement = pluginManagement;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomProfile.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomProfile.java
index a7114fa..0a95f9d 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomProfile.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomProfile.java
@@ -38,6 +38,11 @@ public class JDomProfile
{
private final JDomModelBase modelBase;
+ /**
+ * <p>Constructor for JDomProfile.</p>
+ *
+ * @param profile a {@link org.jdom2.Element} object
+ */
public JDomProfile( Element profile )
{
this.modelBase = new JDomModelBase( profile ) ;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomProperties.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomProperties.java
index 5ca3eeb..ea7eb75 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomProperties.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomProperties.java
@@ -43,6 +43,11 @@ public class JDomProperties extends Properties
{
private final Element properties;
+ /**
+ * <p>Constructor for JDomProperties.</p>
+ *
+ * @param properties a {@link org.jdom2.Element} object
+ */
public JDomProperties( Element properties )
{
this.properties = properties;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomReportPlugin.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomReportPlugin.java
index f3e169c..12dcc9f 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomReportPlugin.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomReportPlugin.java
@@ -38,6 +38,11 @@ public class JDomReportPlugin
{
private final MavenCoordinate coordinate;
+ /**
+ * <p>Constructor for JDomReportPlugin.</p>
+ *
+ * @param reportPlugin a {@link org.jdom2.Element} object
+ */
public JDomReportPlugin( Element reportPlugin )
{
this.coordinate = new JDomMavenCoordinate( reportPlugin );
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomReporting.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomReporting.java
index 21adc8e..1f50fec 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomReporting.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomReporting.java
@@ -39,6 +39,11 @@ public class JDomReporting extends Reporting
private final Element reporting;
+ /**
+ * <p>Constructor for JDomReporting.</p>
+ *
+ * @param reporting a {@link org.jdom2.Element} object
+ */
public JDomReporting( Element reporting )
{
this.reporting = reporting;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomUtils.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomUtils.java
index f11fc19..d40b652 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomUtils.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/transform/jdom2/JDomUtils.java
@@ -89,6 +89,15 @@ public final class JDomUtils
}
}
+ /**
+ * <p>rewriteElement.</p>
+ *
+ * @param name a {@link java.lang.String} object
+ * @param value a {@link java.lang.String} object
+ * @param root a {@link org.jdom2.Element} object
+ * @param namespace a {@link org.jdom2.Namespace} object
+ * @return a {@link org.jdom2.Element} object
+ */
public static Element rewriteElement( String name, String value, Element root, Namespace namespace )
{
Element tagElement = root.getChild( name, namespace );
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/PomFinder.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/PomFinder.java
index df25192..5f93e59 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/PomFinder.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/PomFinder.java
@@ -42,7 +42,7 @@ import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
* 'right' sub directory in this case.
* subdirectory </p>
*
- * <h3>Usage:</h3>
+ * Usage:
* <p>PomFinder is a statefull class. One instance of this class intended
* for a singular use! You need to create a new instance if you like
* to search for another pom.</p>
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/ReleaseUtil.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/ReleaseUtil.java
index 7b64f20..5aee8d9 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/ReleaseUtil.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/util/ReleaseUtil.java
@@ -45,7 +45,6 @@ import org.codehaus.plexus.util.ReaderFactory;
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- * @version $Id$
*/
public class ReleaseUtil
{
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/DefaultVersionInfo.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/DefaultVersionInfo.java
index 71b4963..d879cda 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/DefaultVersionInfo.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/DefaultVersionInfo.java
@@ -91,6 +91,7 @@ public class DefaultVersionInfo
private static final String DIGIT_SEPARATOR_STRING = ".";
+ /** Constant <code>STANDARD_PATTERN</code> */
public static final Pattern STANDARD_PATTERN = Pattern.compile(
"^((?:\\d+\\.)*\\d+)" // digit(s) and '.' repeated - followed by digit (version digits 1.22.0, etc)
+ "([-_])?" // optional - or _ (annotation separator)
@@ -108,13 +109,14 @@ public class DefaultVersionInfo
* SNAPSHOT
*/
// for SNAPSHOT releases only (possible versions include: trunk-SNAPSHOT or SNAPSHOT)
+ /** Constant <code>ALTERNATE_PATTERN</code> */
public static final Pattern ALTERNATE_PATTERN = Pattern.compile( "^(SNAPSHOT|[a-zA-Z]+[_-]SNAPSHOT)" );
/**
* Constructs this object and parses the supplied version string.
*
* @param version the version string
- * @throws VersionParseException if an exception during parsing the input
+ * @throws org.apache.maven.shared.release.versions.VersionParseException if an exception during parsing the input
*/
public DefaultVersionInfo( String version )
throws VersionParseException
@@ -171,6 +173,17 @@ public class DefaultVersionInfo
}
}
+ /**
+ * <p>Constructor for DefaultVersionInfo.</p>
+ *
+ * @param digits a {@link java.util.List} object
+ * @param annotation a {@link java.lang.String} object
+ * @param annotationRevision a {@link java.lang.String} object
+ * @param buildSpecifier a {@link java.lang.String} object
+ * @param annotationSeparator a {@link java.lang.String} object
+ * @param annotationRevSeparator a {@link java.lang.String} object
+ * @param buildSeparator a {@link java.lang.String} object
+ */
public DefaultVersionInfo( List<String> digits, String annotation, String annotationRevision, String buildSpecifier,
String annotationSeparator, String annotationRevSeparator, String buildSeparator )
{
@@ -214,13 +227,10 @@ public class DefaultVersionInfo
}
/**
+ * {@inheritDoc}
+ *
* Compares this {@link DefaultVersionInfo} to the supplied {@link DefaultVersionInfo} to determine which version is
* greater.
- *
- * @param obj the comparison version
- * @return the comparison value
- * @throws IllegalArgumentException if the components differ between the objects or if either of the annotations can
- * not be determined.
*/
@Override
public int compareTo( VersionInfo obj )
@@ -272,9 +282,9 @@ public class DefaultVersionInfo
* Takes a string and increments it as an integer.
* Preserves any lpad of "0" zeros.
*
- * @return {@code String} increments the input {@code String} as an integer
- * and Preserves any lpad of "0" zeros.
* @param s the version number
+ * @return {@code String} increments the input {@code String} as an integer
+ * and Preserves any lpad of "0" zeros.
*/
protected String incrementVersionString( String s )
{
@@ -334,6 +344,14 @@ public class DefaultVersionInfo
return strVersion;
}
+ /**
+ * <p>getVersionString.</p>
+ *
+ * @param info a {@link org.apache.maven.shared.release.versions.DefaultVersionInfo} object
+ * @param buildSpecifier a {@link java.lang.String} object
+ * @param buildSeparator a {@link java.lang.String} object
+ * @return a {@link java.lang.String} object
+ */
protected static String getVersionString( DefaultVersionInfo info, String buildSpecifier, String buildSeparator )
{
StringBuilder sb = new StringBuilder();
@@ -402,21 +420,41 @@ public class DefaultVersionInfo
return StringUtils.isEmpty( s ) ? null : s;
}
+ /**
+ * <p>Getter for the field <code>digits</code>.</p>
+ *
+ * @return a {@link java.util.List} object
+ */
public List<String> getDigits()
{
return digits;
}
+ /**
+ * <p>Getter for the field <code>annotation</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getAnnotation()
{
return annotation;
}
+ /**
+ * <p>Getter for the field <code>annotationRevision</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getAnnotationRevision()
{
return annotationRevision;
}
+ /**
+ * <p>Getter for the field <code>buildSpecifier</code>.</p>
+ *
+ * @return a {@link java.lang.String} object
+ */
public String getBuildSpecifier()
{
return buildSpecifier;
diff --git a/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/VersionInfo.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/VersionInfo.java
index de2c994..f1cd578 100644
--- a/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/VersionInfo.java
+++ b/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/VersionInfo.java
@@ -21,6 +21,7 @@ package org.apache.maven.shared.release.versions;
/**
* Represent the different version representations during the release-prepare phase
+ *
*/
public interface VersionInfo
extends Comparable<VersionInfo>
@@ -41,7 +42,8 @@ public interface VersionInfo
String getReleaseVersionString();
/**
- * Returns a {@link VersionInfo} object which represents the next version of this object.
+ * Returns a {@link org.apache.maven.shared.release.versions.VersionInfo} object which represents the next version
+ * of this object.
*
* @return the next VersionInfo
*/
diff --git a/maven-release-manager/src/test/java/org/apache/maven/shared/release/exec/TeeOutputStreamTest.java b/maven-release-manager/src/test/java/org/apache/maven/shared/release/exec/TeeOutputStreamTest.java
index 5b6cbf7..0855a41 100644
--- a/maven-release-manager/src/test/java/org/apache/maven/shared/release/exec/TeeOutputStreamTest.java
+++ b/maven-release-manager/src/test/java/org/apache/maven/shared/release/exec/TeeOutputStreamTest.java
@@ -28,7 +28,6 @@ import java.io.PrintStream;
* Test the output stream that tees output both to a stream and into an internal buffer for later.
*
* @author Benjamin Bentmann
- * @version $Id$
*/
public class TeeOutputStreamTest
extends TestCase
diff --git a/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/RunPerformGoalsPhaseTest.java b/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/RunPerformGoalsPhaseTest.java
index 0d7827b..b983e50 100644
--- a/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/RunPerformGoalsPhaseTest.java
+++ b/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/RunPerformGoalsPhaseTest.java
@@ -59,7 +59,6 @@ import org.junit.Test;
/**
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- * @version $Id$
*/
public class RunPerformGoalsPhaseTest
extends PlexusJUnit4TestCase
diff --git a/maven-release-plugin/src/it/setup/maven-scm-provider-dummy/src/main/java/org/apache/maven/scm/provider/dummy/DummyScmProvider.java b/maven-release-plugin/src/it/setup/maven-scm-provider-dummy/src/main/java/org/apache/maven/scm/provider/dummy/DummyScmProvider.java
index c115403..cde39ac 100644
--- a/maven-release-plugin/src/it/setup/maven-scm-provider-dummy/src/main/java/org/apache/maven/scm/provider/dummy/DummyScmProvider.java
+++ b/maven-release-plugin/src/it/setup/maven-scm-provider-dummy/src/main/java/org/apache/maven/scm/provider/dummy/DummyScmProvider.java
@@ -33,7 +33,6 @@ import org.apache.maven.scm.repository.ScmRepositoryException;
*
* @plexus.component role="org.apache.maven.scm.provider.ScmProvider" role-hint="dummy"
* @author Benjamin Bentmann
- * @version $Id$
*/
public class DummyScmProvider
extends AbstractScmProvider
diff --git a/maven-release-plugin/src/it/setup/maven-scm-provider-dummy/src/main/java/org/apache/maven/scm/provider/dummy/DummyScmProviderRepository.java b/maven-release-plugin/src/it/setup/maven-scm-provider-dummy/src/main/java/org/apache/maven/scm/provider/dummy/DummyScmProviderRepository.java
index 7ad6faa..831aa59 100644
--- a/maven-release-plugin/src/it/setup/maven-scm-provider-dummy/src/main/java/org/apache/maven/scm/provider/dummy/DummyScmProviderRepository.java
+++ b/maven-release-plugin/src/it/setup/maven-scm-provider-dummy/src/main/java/org/apache/maven/scm/provider/dummy/DummyScmProviderRepository.java
@@ -26,7 +26,6 @@ import org.apache.maven.scm.provider.ScmProviderRepository;
* run for integration testing.
*
* @author Benjamin Bentmann
- * @version $Id$
*/
public class DummyScmProviderRepository
extends ScmProviderRepository
diff --git a/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubBranchCommand.java b/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubBranchCommand.java
index 4d8f963..e24c982 100644
--- a/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubBranchCommand.java
+++ b/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubBranchCommand.java
@@ -33,7 +33,6 @@ import org.apache.maven.scm.provider.ScmProviderRepository;
* A dummy branch command.
*
* @author Peter Janes
- * @version $Id$
*/
class StubBranchCommand
extends AbstractCommand
diff --git a/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubCheckInCommand.java b/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubCheckInCommand.java
index 86e453f..22c6d8a 100644
--- a/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubCheckInCommand.java
+++ b/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubCheckInCommand.java
@@ -40,7 +40,6 @@ import org.codehaus.plexus.util.FileUtils;
* A dummy check-in command.
*
* @author Benjamin Bentmann
- * @version $Id$
*/
class StubCheckInCommand
extends AbstractCommand
diff --git a/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubCheckOutCommand.java b/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubCheckOutCommand.java
index e2284fc..9296f4f 100644
--- a/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubCheckOutCommand.java
+++ b/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubCheckOutCommand.java
@@ -44,7 +44,6 @@ import org.codehaus.plexus.util.FileUtils;
* A dummy check-out command.
*
* @author Benjamin Bentmann
- * @version $Id$
*/
class StubCheckOutCommand
extends AbstractCommand
diff --git a/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubScmProvider.java b/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubScmProvider.java
index 7afbcee..b9172ec 100644
--- a/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubScmProvider.java
+++ b/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubScmProvider.java
@@ -38,7 +38,6 @@ import org.apache.maven.scm.repository.ScmRepositoryException;
*
* @plexus.component role="org.apache.maven.scm.provider.ScmProvider" role-hint="stub"
* @author Benjamin Bentmann
- * @version $Id$
*/
public class StubScmProvider
extends AbstractScmProvider
diff --git a/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubScmProviderRepository.java b/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubScmProviderRepository.java
index df6c242..aaa4d53 100644
--- a/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubScmProviderRepository.java
+++ b/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubScmProviderRepository.java
@@ -32,7 +32,6 @@ import org.apache.maven.scm.provider.ScmProviderRepository;
* A stub SCM repository used for the Maven Release Plugin when doing integration testing.
*
* @author Benjamin Bentmann
- * @version $Id$
*/
class StubScmProviderRepository
extends ScmProviderRepository
diff --git a/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubStatusCommand.java b/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubStatusCommand.java
index 0b4f8c4..a682d84 100644
--- a/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubStatusCommand.java
+++ b/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubStatusCommand.java
@@ -34,7 +34,6 @@ import org.apache.maven.scm.provider.ScmProviderRepository;
* A dummy status command.
*
* @author Benjamin Bentmann
- * @version $Id$
*/
class StubStatusCommand
extends AbstractCommand
diff --git a/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubTagCommand.java b/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubTagCommand.java
index d44ed8c..537e026 100644
--- a/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubTagCommand.java
+++ b/maven-release-plugin/src/it/setup/maven-scm-provider-stub/src/main/java/org/apache/maven/scm/provider/stub/StubTagCommand.java
@@ -41,7 +41,6 @@ import org.codehaus.plexus.util.FileUtils;
* A dummy tag command.
*
* @author Benjamin Bentmann
- * @version $Id$
*/
class StubTagCommand
extends AbstractCommand
diff --git a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractReleaseMojo.java b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractReleaseMojo.java
index 5a4ded4..46eccec 100644
--- a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractReleaseMojo.java
+++ b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractReleaseMojo.java
@@ -43,7 +43,6 @@ import org.codehaus.plexus.util.StringUtils;
* Base class with shared configuration.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- * @version $Id$
*/
public abstract class AbstractReleaseMojo
extends AbstractMojo
diff --git a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractScmReleaseMojo.java b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractScmReleaseMojo.java
index 6804603..af2c42a 100644
--- a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractScmReleaseMojo.java
+++ b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/AbstractScmReleaseMojo.java
@@ -182,6 +182,12 @@ public abstract class AbstractScmReleaseMojo
return descriptor;
}
+ /**
+ * <p>buildScm.</p>
+ *
+ * @param project a {@link org.apache.maven.project.MavenProject} object
+ * @return a {@link org.apache.maven.model.Scm} object
+ */
protected Scm buildScm( MavenProject project )
{
Scm scm;
diff --git a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/BranchReleaseMojo.java b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/BranchReleaseMojo.java
index 955b01a..6ffe71f 100644
--- a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/BranchReleaseMojo.java
+++ b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/BranchReleaseMojo.java
@@ -32,12 +32,11 @@ import org.apache.maven.shared.release.ReleaseFailureException;
import org.apache.maven.shared.release.config.ReleaseDescriptorBuilder;
/**
- * Branch a project in SCM, using the same steps as the <tt>release:prepare</tt> goal, creating a branch instead of a
- * tag. For more info see <a href="https://maven.apache.org/plugins/maven-release-plugin/examples/branch.html"
+ * Branch a project in SCM, using the same steps as the <code>release:prepare</code> goal, creating a branch instead of
+ * a tag. For more info see <a href="https://maven.apache.org/plugins/maven-release-plugin/examples/branch.html"
* >https://maven.apache.org/plugins/maven-release-plugin/examples/branch.html</a>.
*
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
- * @version $Id$
* @since 2.0-beta-6
*/
@Mojo( name = "branch", aggregator = true )
diff --git a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/CleanReleaseMojo.java b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/CleanReleaseMojo.java
index 43e3475..6c2d009 100644
--- a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/CleanReleaseMojo.java
+++ b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/CleanReleaseMojo.java
@@ -28,14 +28,13 @@ import org.apache.maven.shared.release.ReleaseFailureException;
import org.apache.maven.shared.release.config.ReleaseDescriptorBuilder;
/**
- * Clean up after a release preparation. This is done automatically after a successful <tt>release:perform</tt>,
+ * Clean up after a release preparation. This is done automatically after a successful <code>release:perform</code>,
* so is best served for cleaning up a failed or abandoned release, or a dry run. Note that only the working copy
* is cleaned up, no previous steps are rolled back.
* For more info see <a href="https://maven.apache.org/plugins/maven-release-plugin/examples/clean-release.html"
* >https://maven.apache.org/plugins/maven-release-plugin/examples/clean-release.html</a>.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- * @version $Id$
*/
@Mojo( name = "clean", aggregator = true )
public class CleanReleaseMojo
diff --git a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java
index 51636f0..e1aa97d 100644
--- a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java
+++ b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java
@@ -37,13 +37,12 @@ import org.codehaus.plexus.util.StringUtils;
/**
* Perform a release from SCM, either from a specified tag, or the tag representing the previous release in
- * the working copy created by <tt>release:prepare</tt>.
+ * the working copy created by <code>release:prepare</code>.
* For more info see <a href="https://maven.apache.org/plugins/maven-release-plugin/examples/perform-release.html"
* >https://maven.apache.org/plugins/maven-release-plugin/examples/perform-release.html</a>.
*
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- * @version $Id$
*/
@Mojo( name = "perform", aggregator = true, requiresProject = false )
public class PerformReleaseMojo
diff --git a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java
index 204e27f..aff953e 100644
--- a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java
+++ b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java
@@ -35,7 +35,7 @@ import org.apache.maven.shared.release.config.ReleaseDescriptorBuilder;
/**
* Prepare for a release in SCM. Steps through several phases to ensure the POM is ready to be released and then
* prepares SCM to eventually contain a tagged version of the release and a record in the local copy of the parameters
- * used. This can be followed by a call to <tt>release:perform</tt>. For more info see <a
+ * used. This can be followed by a call to <code>release:perform</code>. For more info see <a
* href="https://maven.apache.org/plugins/maven-release-plugin/examples/prepare-release.html"
* >https://maven.apache.org/plugins/maven-release-plugin/examples/prepare-release.html</a>.
*
@@ -43,7 +43,6 @@ import org.apache.maven.shared.release.config.ReleaseDescriptorBuilder;
* @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- * @version $Id$
*/
// TODO [!] check how this works with version ranges
@Mojo( name = "prepare", aggregator = true, requiresDependencyCollection = ResolutionScope.TEST )
@@ -315,9 +314,6 @@ public class PrepareReleaseMojo
@Parameter( defaultValue = "false", property = "pinExternals" )
private boolean pinExternals;
- /**
- * {@inheritDoc}
- */
@Override
public void execute()
throws MojoExecutionException, MojoFailureException
@@ -331,6 +327,13 @@ public class PrepareReleaseMojo
prepareRelease( generateReleasePoms );
}
+ /**
+ * <p>prepareRelease.</p>
+ *
+ * @param generateReleasePoms a boolean
+ * @throws org.apache.maven.plugin.MojoExecutionException if any.
+ * @throws org.apache.maven.plugin.MojoFailureException if any.
+ */
protected void prepareRelease( boolean generateReleasePoms )
throws MojoExecutionException, MojoFailureException
{
diff --git a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/RollbackReleaseMojo.java b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/RollbackReleaseMojo.java
index 11778c6..19ee200 100644
--- a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/RollbackReleaseMojo.java
+++ b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/RollbackReleaseMojo.java
@@ -31,13 +31,12 @@ import org.apache.maven.shared.release.config.ReleaseDescriptorBuilder;
/**
* Rollback changes made by a previous release. This requires that the previous release descriptor
- * <tt>release.properties</tt> is still available in the local working copy. For more info see <a
+ * <code>release.properties</code> is still available in the local working copy. For more info see <a
* href="https://maven.apache.org/plugins/maven-release-plugin/examples/rollback-release.html"
* >https://maven.apache.org/plugins/maven-release-plugin/examples/rollback-release.html</a>.
*
* @since 2.0-beta-5
* @author Edwin Punzalan
- * @version $Id$
*/
@Mojo( name = "rollback", aggregator = true )
public class RollbackReleaseMojo
diff --git a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/StageReleaseMojo.java b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/StageReleaseMojo.java
index a92b7b3..a32b990 100644
--- a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/StageReleaseMojo.java
+++ b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/StageReleaseMojo.java
@@ -33,7 +33,6 @@ import org.codehaus.plexus.util.StringUtils;
* are overridden with <code>site:stage-deploy</code>.
*
* @author <a href="mailto:nicolas@apache.org">Nicolas De Loof</a>
- * @version $Id$
* @since 2.0-beta-8
*/
@Mojo( name = "stage", aggregator = true, requiresProject = false )
diff --git a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/UpdateVersionsMojo.java b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/UpdateVersionsMojo.java
index 17c47de..b790d64 100644
--- a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/UpdateVersionsMojo.java
+++ b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/UpdateVersionsMojo.java
@@ -31,13 +31,12 @@ import org.apache.maven.shared.release.ReleaseUpdateVersionsRequest;
import org.apache.maven.shared.release.config.ReleaseDescriptorBuilder;
/**
- * Update the POM versions for a project. This performs the normal version updates of the <tt>release:prepare</tt> goal
- * without making other modifications to the SCM such as tagging. For more info see <a
+ * Update the POM versions for a project. This performs the normal version updates of the <code>release:prepare</code>
+ * goal without making other modifications to the SCM such as tagging. For more info see <a
* href="https://maven.apache.org/plugins/maven-release-plugin/examples/update-versions.html"
* >https://maven.apache.org/plugins/maven-release-plugin/examples/update-versions.html</a>.
*
* @author Paul Gier
- * @version $Id$
* @since 2.0
*/
@Mojo( name = "update-versions", aggregator = true )
diff --git a/maven-release-policies/maven-release-oddeven-policy/src/main/java/org/apache/maven/shared/release/policy/oddeven/OddEvenVersionPolicy.java b/maven-release-policies/maven-release-oddeven-policy/src/main/java/org/apache/maven/shared/release/policy/oddeven/OddEvenVersionPolicy.java
index 2aedf9c..8a34780 100644
--- a/maven-release-policies/maven-release-oddeven-policy/src/main/java/org/apache/maven/shared/release/policy/oddeven/OddEvenVersionPolicy.java
+++ b/maven-release-policies/maven-release-oddeven-policy/src/main/java/org/apache/maven/shared/release/policy/oddeven/OddEvenVersionPolicy.java
@@ -32,12 +32,13 @@ import org.codehaus.plexus.component.annotations.Component;
import org.codehaus.plexus.util.StringUtils;
/**
- * A {@link VersionPolicy} implementation that propose even version numbers only for releases and odd
+ * A {@link org.apache.maven.shared.release.policy.version.VersionPolicy} implementation that propose even version numbers only for releases and odd
* numbers for development. For example:<ul>
* <li><code>1.0.0-SNAPSHOT</code> gets <code>1.0.0</code> for next release,</li>
* <li><code>1.0.1-SNAPSHOT</code> gets <code>1.0.2</code> for next release,</li>
* <li><code>1.0.2</code> gets <code>1.0.3-SNAPSHOT</code> for next development version.</li>
* </ul>
+ *
*/
@Component(
role = VersionPolicy.class,
diff --git a/maven-release-policies/maven-release-semver-policy/src/main/java/org/apache/maven/shared/release/policy/semver/SemVerVersionPolicy.java b/maven-release-policies/maven-release-semver-policy/src/main/java/org/apache/maven/shared/release/policy/semver/SemVerVersionPolicy.java
index 0a20c62..6cf0b1e 100644
--- a/maven-release-policies/maven-release-semver-policy/src/main/java/org/apache/maven/shared/release/policy/semver/SemVerVersionPolicy.java
+++ b/maven-release-policies/maven-release-semver-policy/src/main/java/org/apache/maven/shared/release/policy/semver/SemVerVersionPolicy.java
@@ -29,9 +29,8 @@ import org.semver.Version;
import org.semver.Version.Element;
/**
- *
- * Uses SemVer implementation to increase minor element when resolving the development version
*
+ * Uses SemVer implementation to increase minor element when resolving the development version
*/
@Component(
role = VersionPolicy.class,
[maven-release] 02/03: [MRELEASE-1066] Upgrade Plexus Utils to 3.4.1
Posted by sl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch MRELEASE-1066
in repository https://gitbox.apache.org/repos/asf/maven-release.git
commit 9244fd63c5a443f8d847344b0c3b10e3acc030d9
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Sat Oct 2 12:12:51 2021 +0200
[MRELEASE-1066] Upgrade Plexus Utils to 3.4.1
---
pom.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/pom.xml b/pom.xml
index d01be27..3c6d9ac 100644
--- a/pom.xml
+++ b/pom.xml
@@ -181,7 +181,7 @@
<dependency>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-utils</artifactId>
- <version>3.0.15</version>
+ <version>3.4.1</version>
</dependency>
<dependency>
<groupId>org.jdom</groupId>
[maven-release] 01/03: [MRELEASE-1066] Use try-with-resources
Posted by sl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch MRELEASE-1066
in repository https://gitbox.apache.org/repos/asf/maven-release.git
commit aab0aa3a24a045af39431082ad7e0879e9304006
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Sat Oct 2 12:10:00 2021 +0200
[MRELEASE-1066] Use try-with-resources
---
.../release/phase/AbstractBackupPomsPhaseTest.java | 23 +++++++++++-----------
1 file changed, 12 insertions(+), 11 deletions(-)
diff --git a/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/AbstractBackupPomsPhaseTest.java b/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/AbstractBackupPomsPhaseTest.java
index ce8e00e..6f2c560 100644
--- a/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/AbstractBackupPomsPhaseTest.java
+++ b/maven-release-manager/src/test/java/org/apache/maven/shared/release/phase/AbstractBackupPomsPhaseTest.java
@@ -24,8 +24,11 @@ import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
import org.apache.maven.project.MavenProject;
import org.apache.maven.shared.release.PlexusJUnit4TestCase;
import org.codehaus.plexus.util.ReaderFactory;
+import org.codehaus.plexus.util.xml.XmlStreamReader;
+import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
import java.io.File;
+import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
@@ -76,18 +79,16 @@ public abstract class AbstractBackupPomsPhaseTest
return reactorProjects;
}
- private MavenProject createMavenProject( File pomFile )
- throws Exception
+ private MavenProject createMavenProject( File pomFile ) throws IOException, XmlPullParserException
{
- MavenXpp3Reader reader = new MavenXpp3Reader();
-
- Model model = reader.read( ReaderFactory.newXmlReader( pomFile ) );
-
- MavenProject project = new MavenProject( model );
-
- project.setFile( pomFile );
-
- return project;
+ try ( XmlStreamReader xmlStreamReader = ReaderFactory.newXmlReader( pomFile ))
+ {
+ MavenXpp3Reader reader = new MavenXpp3Reader();
+ Model model = reader.read( xmlStreamReader );
+ MavenProject project = new MavenProject( model );
+ project.setFile( pomFile );
+ return project;
+ }
}
}