From cb55288a4c16a2d69aeba0c03a59dc4e47a5c1fd Mon Sep 17 00:00:00 2001 From: Sylwester Lachiewicz Date: Sat, 2 Oct 2021 14:18:17 +0200 Subject: [PATCH] (doc) javadoc:fix (auto) --- .../release/ReleaseExecutionException.java | 14 +- .../maven/shared/release/ReleaseResult.java | 46 +- .../release/config/ReleaseDescriptor.java | 83 +++- .../release/env/ReleaseEnvironment.java | 28 ++ .../release/phase/AbstractReleasePhase.java | 36 ++ .../release/phase/ResourceGenerator.java | 2 +- .../release/policy/PolicyException.java | 14 +- .../release/policy/naming/NamingPolicy.java | 6 +- .../policy/naming/NamingPolicyRequest.java | 36 +- .../policy/naming/NamingPolicyResult.java | 12 + .../release/policy/version/VersionPolicy.java | 16 +- .../policy/version/VersionPolicyRequest.java | 25 +- .../policy/version/VersionPolicyResult.java | 14 +- .../shared/release/strategy/Strategy.java | 25 +- .../release/versions/AetherVersion.java | 6 + .../versions/MavenArtifactVersion.java | 25 ++ .../shared/release/versions/Version.java | 78 +++- .../VersionComparisonConflictException.java | 10 +- .../versions/VersionParseException.java | 7 +- .../release/AbstractReleaseRequest.java | 15 +- .../shared/release/DefaultReleaseManager.java | 6 + .../DefaultReleaseManagerListener.java | 19 + .../shared/release/ReleaseBranchRequest.java | 21 +- .../shared/release/ReleaseCleanRequest.java | 3 +- .../maven/shared/release/ReleaseManager.java | 34 +- .../release/ReleaseManagerListener.java | 29 ++ .../shared/release/ReleasePerformRequest.java | 15 +- .../shared/release/ReleasePrepareRequest.java | 25 +- .../release/ReleaseRollbackRequest.java | 7 +- .../release/ReleaseUpdateVersionsRequest.java | 17 +- .../PropertiesReleaseDescriptorStore.java | 23 + .../config/ReleaseDescriptorBuilder.java | 400 +++++++++++++++++- .../config/ReleaseDescriptorStore.java | 2 + .../ReleaseDescriptorStoreException.java | 6 + .../shared/release/config/ReleaseUtils.java | 12 + .../env/DefaultReleaseEnvironment.java | 37 ++ .../release/exec/AbstractMavenExecutor.java | 20 + .../release/exec/CommandLineFactory.java | 3 +- .../release/exec/ForkedMavenExecutor.java | 15 + .../release/exec/InvokerMavenExecutor.java | 19 + .../shared/release/exec/MavenExecutor.java | 2 +- .../release/exec/MavenExecutorException.java | 17 + .../shared/release/exec/RawStreamPumper.java | 29 +- .../shared/release/exec/TeeConsumer.java | 16 + .../shared/release/exec/TeeOutputStream.java | 17 + .../phase/AbstractBackupPomsPhase.java | 13 + .../phase/AbstractRewritePomsPhase.java | 66 +++ .../release/phase/AbstractScmCommitPhase.java | 59 +++ .../CheckCompletedPreparePhasesPhase.java | 1 - .../release/phase/CheckoutProjectFromScm.java | 1 - .../release/phase/InputVariablesPhase.java | 9 + .../release/phase/RemoveReleasePomsPhase.java | 2 +- .../phase/RewritePomVersionsPhase.java | 1 + .../phase/RewritePomsForBranchPhase.java | 1 - .../shared/release/phase/ScmBranchPhase.java | 1 + .../phase/ScmCommitDevelopmentPhase.java | 2 +- .../release/policies/DefaultNamingPolicy.java | 1 + .../policies/DefaultVersionPolicy.java | 1 + .../release/scm/ClearCaseScmTranslator.java | 12 - .../shared/release/scm/CvsScmTranslator.java | 12 - .../scm/DefaultScmRepositoryConfigurator.java | 5 + .../shared/release/scm/GitScmTranslator.java | 1 + .../shared/release/scm/HgScmTranslator.java | 1 + .../shared/release/scm/IdentifiedScm.java | 7 +- .../shared/release/scm/JazzScmTranslator.java | 12 - .../scm/ReleaseScmCommandException.java | 6 + .../scm/ReleaseScmRepositoryException.java | 6 + .../scm/ScmRepositoryConfigurator.java | 12 +- .../release/scm/SubversionScmTranslator.java | 12 - .../release/strategies/DefaultStrategy.java | 28 +- .../release/transform/MavenCoordinate.java | 26 ++ .../shared/release/transform/ModelETL.java | 21 + .../release/transform/ModelETLFactory.java | 7 + .../release/transform/ModelETLRequest.java | 33 +- .../release/transform/jdom2/JDomBuild.java | 5 + .../transform/jdom2/JDomDependency.java | 5 + .../jdom2/JDomDependencyManagement.java | 5 + .../transform/jdom2/JDomExtension.java | 5 + .../transform/jdom2/JDomMavenCoordinate.java | 6 + .../release/transform/jdom2/JDomModel.java | 10 + .../transform/jdom2/JDomModelBase.java | 21 + .../release/transform/jdom2/JDomModelETL.java | 15 + .../transform/jdom2/JDomModelETLFactory.java | 3 + .../release/transform/jdom2/JDomParent.java | 5 + .../release/transform/jdom2/JDomPlugin.java | 5 + .../transform/jdom2/JDomPluginManagement.java | 5 + .../release/transform/jdom2/JDomProfile.java | 5 + .../transform/jdom2/JDomProperties.java | 5 + .../transform/jdom2/JDomReportPlugin.java | 5 + .../transform/jdom2/JDomReporting.java | 5 + .../release/transform/jdom2/JDomUtils.java | 9 + .../maven/shared/release/util/PomFinder.java | 2 +- .../shared/release/util/ReleaseUtil.java | 1 - .../release/versions/DefaultVersionInfo.java | 54 ++- .../shared/release/versions/VersionInfo.java | 4 +- .../release/exec/TeeOutputStreamTest.java | 1 - .../phase/RunPerformGoalsPhaseTest.java | 1 - .../scm/provider/dummy/DummyScmProvider.java | 1 - .../dummy/DummyScmProviderRepository.java | 1 - .../scm/provider/stub/StubBranchCommand.java | 1 - .../scm/provider/stub/StubCheckInCommand.java | 1 - .../provider/stub/StubCheckOutCommand.java | 1 - .../scm/provider/stub/StubScmProvider.java | 1 - .../stub/StubScmProviderRepository.java | 1 - .../scm/provider/stub/StubStatusCommand.java | 1 - .../scm/provider/stub/StubTagCommand.java | 1 - .../plugins/release/AbstractReleaseMojo.java | 1 - .../release/AbstractScmReleaseMojo.java | 6 + .../plugins/release/BranchReleaseMojo.java | 5 +- .../plugins/release/CleanReleaseMojo.java | 3 +- .../plugins/release/PerformReleaseMojo.java | 3 +- .../plugins/release/PrepareReleaseMojo.java | 13 +- .../plugins/release/RollbackReleaseMojo.java | 3 +- .../plugins/release/StageReleaseMojo.java | 1 - .../plugins/release/UpdateVersionsMojo.java | 5 +- .../policy/oddeven/OddEvenVersionPolicy.java | 3 +- .../policy/semver/SemVerVersionPolicy.java | 3 +- pom.xml | 9 + 118 files changed, 1727 insertions(+), 170 deletions(-) diff --git a/maven-release-api/src/main/java/org/apache/maven/shared/release/ReleaseExecutionException.java b/maven-release-api/src/main/java/org/apache/maven/shared/release/ReleaseExecutionException.java index afaf6ad8e..de529f9b8 100644 --- a/maven-release-api/src/main/java/org/apache/maven/shared/release/ReleaseExecutionException.java +++ b/maven-release-api/src/main/java/org/apache/maven/shared/release/ReleaseExecutionException.java @@ -20,20 +20,28 @@ */ /** - * Exception occuring during release execution. + * Exception occurring during release execution. * * @author Brett Porter */ public class ReleaseExecutionException extends Exception { + /** + * Creates a new instance of ReleaseExecutionException without detail message. + */ public ReleaseExecutionException( String message ) { super( message ); } - public ReleaseExecutionException( String message, Throwable t ) + /** + * Constructs an instance of ReleaseExecutionException with the specified detail message. + * + * @param message the detail message. + */ + public ReleaseExecutionException( String message, Throwable cause ) { - super( message, t ); + super( message, cause ); } } diff --git a/maven-release-api/src/main/java/org/apache/maven/shared/release/ReleaseResult.java b/maven-release-api/src/main/java/org/apache/maven/shared/release/ReleaseResult.java index 04547ed3a..62fde5cd7 100644 --- a/maven-release-api/src/main/java/org/apache/maven/shared/release/ReleaseResult.java +++ b/maven-release-api/src/main/java/org/apache/maven/shared/release/ReleaseResult.java @@ -27,7 +27,12 @@ */ public class ReleaseResult { - public static final int UNDEFINED = -1, SUCCESS = 0, ERROR = 1; + /** The result of the release. */ + public static final int UNDEFINED = -1; + /** The release was successful. */ + public static final int SUCCESS = 0; + /** The release failed. */ + public static final int ERROR = 1; private StringBuilder stdOut = new StringBuilder(); @@ -39,21 +44,37 @@ public class ReleaseResult private static final String LS = System.getProperty( "line.separator" ); + /** + * Append Info message to the output. + * @param message the message to append + */ public void appendInfo( String message ) { stdOut.append( "[INFO] " ).append( message ).append( LS ); } - + /** + * Append warning message to the output. + * @param message the message to append + */ public void appendWarn( String message ) { stdOut.append( "[WARN] " ).append( message ).append( LS ); } + /** + * Append debug message to the output. + * @param message the message to append + */ public void appendDebug( String message ) { stdOut.append( "[DEBUG] " ).append( message ).append( LS ); } + /** + * Append error message to the output. + * @param message the message to append + * @param e the exception to append + */ public void appendDebug( String message, Exception e ) { appendDebug( message ); @@ -61,6 +82,11 @@ public void appendDebug( String message, Exception e ) stdOut.append( getStackTrace( e ) ).append( LS ); } + /** + * Append error message to the output. + * + * @param message the message to append + */ public void appendError( String message ) { stdOut.append( "[ERROR] " ).append( message ).append( LS ); @@ -68,11 +94,22 @@ public void appendError( String message ) setResultCode( ERROR ); } + /** + * Append error exception to the output + * + * @param e the exception to append + */ public void appendError( Exception e ) { appendError( getStackTrace( e ) ); } + /** + * Append stack trace to the output + * + * @param message the message to append + * @param e the exception to append + */ public void appendError( String message, Exception e ) { appendError( message ); @@ -80,6 +117,11 @@ public void appendError( String message, Exception e ) stdOut.append( getStackTrace( e ) ).append( LS ); } + /** + * Append message to the output. + * + * @param message the message to append + */ public void appendOutput( String message ) { stdOut.append( message ); 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 e8896cfe2..312584da4 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 org.apache.maven.model.Scm; /** + *

ReleaseDescriptor interface.

* * @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(); /** + *

getActivateProfiles.

* * @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. + *

getDependencyOriginalVersion.

* + * @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. + *

getDependencyReleaseVersion.

* + * @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. + *

getDependencyDevelopmentVersion.

* + * @return {@code String} the release version for the resolved snapshot dependency. * @param artifactKey the artifact key {@code String} */ String getDependencyDevelopmentVersion( String artifactKey ); + /** + *

getProjectOriginalVersion.

+ * + * @param projectKey a {@link java.lang.String} object + * @return a {@link java.lang.String} object + */ String getProjectOriginalVersion( String projectKey ); + /** + *

getProjectDevelopmentVersion.

+ * + * @param projectKey a {@link java.lang.String} object + * @return a {@link java.lang.String} object + */ String getProjectDevelopmentVersion( String projectKey ); + /** + *

getProjectReleaseVersion.

+ * + * @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. + *

getOriginalScmInfo.

* + * @return the original {@code Scm} information. * @param projectKey the project key {@code String} */ Scm getOriginalScmInfo( String projectKey ); // Modifiable + /** + *

addDependencyOriginalVersion.

+ * + * @param versionlessKey a {@link java.lang.String} object + * @param string a {@link java.lang.String} object + */ void addDependencyOriginalVersion( String versionlessKey, String string ); + /** + *

addDependencyReleaseVersion.

+ * + * @param versionlessKey a {@link java.lang.String} object + * @param version a {@link java.lang.String} object + */ void addDependencyReleaseVersion( String versionlessKey, String version ); + /** + *

addDependencyDevelopmentVersion.

+ * + * @param versionlessKey a {@link java.lang.String} object + * @param version a {@link java.lang.String} object + */ void addDependencyDevelopmentVersion( String versionlessKey, String version ); + /** + *

addReleaseVersion.

+ * + * @param projectId a {@link java.lang.String} object + * @param nextVersion a {@link java.lang.String} object + */ void addReleaseVersion( String projectId, String nextVersion ); + /** + *

addDevelopmentVersion.

+ * + * @param projectId a {@link java.lang.String} object + * @param nextVersion a {@link java.lang.String} object + */ void addDevelopmentVersion( String projectId, String nextVersion ); + /** + *

setScmReleaseLabel.

+ * + * @param tag a {@link java.lang.String} object + */ void setScmReleaseLabel( String tag ); + /** + *

setScmReleasedPomRevision.

+ * + * @param scmRevision a {@link java.lang.String} object + */ void setScmReleasedPomRevision( String scmRevision ); + /** + *

setScmRelativePathProjectDirectory.

+ * + * @param scmRelativePathProjectDirectory a {@link java.lang.String} object + */ void setScmRelativePathProjectDirectory( String scmRelativePathProjectDirectory ); + /** + *

setScmSourceUrl.

+ * + * @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 88ef9e20c..2614473da 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 org.apache.maven.settings.Settings; /** + *

ReleaseEnvironment interface.

* */ public interface ReleaseEnvironment { + /** Constant DEFAULT_MAVEN_EXECUTOR_ID="forked-path" */ String DEFAULT_MAVEN_EXECUTOR_ID = "forked-path"; + /** + *

getMavenExecutorId.

+ * + * @return a {@link java.lang.String} object + */ String getMavenExecutorId(); + /** + *

getLocalRepositoryDirectory.

+ * + * @return a {@link java.io.File} object + */ File getLocalRepositoryDirectory(); + /** + *

getSettings.

+ * + * @return a {@link org.apache.maven.settings.Settings} object + */ Settings getSettings(); + /** + *

getMavenHome.

+ * + * @return a {@link java.io.File} object + */ File getMavenHome(); + /** + *

getJavaHome.

+ * + * @return a {@link java.io.File} object + */ File getJavaHome(); /** + *

getLocale.

* * @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 672c18e07..271849343 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 { + /** + *

logInfo.

+ * + * @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 ); } + /** + *

logWarn.

+ * + * @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 ); } + /** + *

logError.

+ * + * @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 ); } + /** + *

logDebug.

+ * + * @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 ); } + /** + *

logDebug.

+ * + * @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 ); } + /** + *

getReleaseResultSuccess.

+ * + * @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 8f85e3eef..f2940229d 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 @@ /** * 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 a3d7c340a..2531d7f04 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 @@ */ /** - * + *

PolicyException class.

+ * * @since 2.5.1 (MRELEASE-431) */ public class PolicyException extends Exception { + /** + *

Constructor for PolicyException.

+ * + * @param message a {@link java.lang.String} object + */ public PolicyException( String message ) { super( message ); } + /** + *

Constructor for PolicyException.

+ * + * @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 467f2cd82..c2abbc222 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 @@ public interface NamingPolicy { /** + *

getName.

+ * * @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 d6181425a..b7c8d4f65 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 @@ */ /** - * + *

NamingPolicyRequest class.

+ * * @author Robert Scholte * @since 3.0.0 */ @@ -32,33 +33,66 @@ public class NamingPolicyRequest private String version; + /** + *

Getter for the field groupId.

+ * + * @return a {@link java.lang.String} object + */ public String getGroupId() { return groupId; } + /** + *

Setter for the field groupId.

+ * + * @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; } + /** + *

Getter for the field artifactId.

+ * + * @return a {@link java.lang.String} object + */ public String getArtifactId() { return artifactId; } + /** + *

Setter for the field artifactId.

+ * + * @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; } + /** + *

Getter for the field version.

+ * + * @return a {@link java.lang.String} object + */ public String getVersion() { return version; } + /** + *

Setter for the field version.

+ * + * @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 411e8b724..8920bf338 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 @@ */ /** + *

NamingPolicyResult class.

* * @since 3.0.0 (MRELEASE-979) */ @@ -30,11 +31,22 @@ public class NamingPolicyResult */ private String name; + /** + *

Getter for the field name.

+ * + * @return a {@link java.lang.String} object + */ public String getName() { return name; } + /** + *

Setter for the field name.

+ * + * @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 607080247..e9fd5fce2 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 @@ public interface VersionPolicy { /** + *

getReleaseVersion.

+ * * @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. + *

getDevelopmentVersion.

* + * @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 36bd1a148..4001b8714 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 @@ import org.apache.maven.artifact.repository.metadata.Metadata; /** - * + *

VersionPolicyRequest class.

+ * * @since 2.5.1 (MRELEASE-431) */ public class VersionPolicyRequest @@ -32,22 +33,44 @@ public class VersionPolicyRequest private Metadata metaData; + /** + *

Getter for the field version.

+ * + * @return a {@link java.lang.String} object + */ public String getVersion() { return version; } + /** + *

Setter for the field version.

+ * + * @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; } + /** + *

Getter for the field metaData.

+ * + * @return a {@link org.apache.maven.artifact.repository.metadata.Metadata} object + */ public Metadata getMetaData() { return metaData; } + /** + *

Setter for the field metaData.

+ * + * @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 de7fb5836..f1ccbf96b 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 @@ */ /** - * + *

VersionPolicyResult class.

+ * * @since 2.5.1 (MRELEASE-431) */ public class VersionPolicyResult { private String version; + /** + *

Getter for the field version.

+ * + * @return a {@link java.lang.String} object + */ public String getVersion() { return version; } + /** + *

Setter for the field version.

+ * + * @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 43300b012..b02b02bb1 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 @@ /** * 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 { /** + *

getPreparePhases.

+ * * @return The release phases to execute the calling the prepare goal */ List getPreparePhases(); /** - * @return The release phases to execute the calling the perform goal + *

getPerformPhases.

+ * + * @return The release phases to execute the calling the perform goal */ List getPerformPhases(); /** - * @return The release phases to execute the calling the branch goal + *

getBranchPhases.

+ * + * @return The release phases to execute the calling the branch goal */ List getBranchPhases(); /** - * @return The release phases to execute the calling the rollback goal + *

getRollbackPhases.

+ * + * @return The release phases to execute the calling the rollback goal */ List getRollbackPhases(); /** - * @return The release phases to execute the calling the update-versions goal + *

getUpdateVersionsPhases.

+ * + * @return The release phases to execute the calling the update-versions goal */ List 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 55a014c4b..7b3dd4816 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 @@ public String toString() return this.version.toString(); } + /** + *

compareTo.

+ * + * @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 25a2acb17..fe579cc9a 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 @@ public int compareTo( Object o ) } } + /** + *

getMajorVersion.

+ * + * @return a int + */ public int getMajorVersion() { return version.getMajorVersion(); } + /** + *

getMinorVersion.

+ * + * @return a int + */ public int getMinorVersion() { return version.getMinorVersion(); } + /** + *

getIncrementalVersion.

+ * + * @return a int + */ public int getIncrementalVersion() { return version.getIncrementalVersion(); } + /** + *

getBuildNumber.

+ * + * @return a int + */ public int getBuildNumber() { return version.getBuildNumber(); } + /** + *

getQualifier.

+ * + * @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 7d4fbcded..6548e55ff 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.codehaus.plexus.util.StringUtils; /** - * + *

Version class.

*/ public class Version implements Comparable, Cloneable @@ -76,6 +76,7 @@ public class Version private static final String DEFAULT_BUILD_SEPARATOR = "-"; + /** Constant STANDARD_PATTERN */ 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 ALTERNATE_PATTERN */ public static final Pattern ALTERNATE_PATTERN = Pattern.compile( "^(SNAPSHOT|[a-zA-Z]+[_-]SNAPSHOT)" ); private Version( List digits, String annotation, String annotationRevision, String buildSpecifier, @@ -109,6 +111,12 @@ private Version( List digits, String annotation, String annotationRevisi this.mavenArtifactVersion = null; } + /** + *

Constructor for Version.

+ * + * @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 Version( String version ) } } + /** + *

isSnapshot.

+ * + * @return a boolean + */ public boolean isSnapshot() { return ArtifactUtils.isSnapshot( strVersion ); } + /** + *

toString.

+ * + * @return a {@link java.lang.String} object + */ public String toString() { return strVersion; } + /** + *

getVersionString.

+ * + * @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 @@ protected static String getVersionString( Version info, String buildSpecifier, S /** * 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} */ @@ -239,38 +265,69 @@ private static String nullIfEmpty( String s ) return StringUtils.isEmpty( s ) ? null : s; } + /** + *

Getter for the field digits.

+ * + * @return a {@link java.util.List} object + */ public List getDigits() { return digits; } + /** + *

Getter for the field annotation.

+ * + * @return a {@link java.lang.String} object + */ public String getAnnotation() { return annotation; } + /** + *

Getter for the field annotationRevSeparator.

+ * + * @return a {@link java.lang.String} object + */ public String getAnnotationRevSeparator() { return annotationRevSeparator; } + /** + *

Getter for the field annotationRevision.

+ * + * @return a {@link java.lang.String} object + */ public String getAnnotationRevision() { return annotationRevision; } + /** + *

Getter for the field buildSeparator.

+ * + * @return a {@link java.lang.String} object + */ public String getBuildSeparator() { return buildSeparator; } + /** + *

Getter for the field buildSpecifier.

+ * + * @return a {@link java.lang.String} object + */ public String getBuildSpecifier() { return buildSpecifier; } /** - * + *

Setter for the field digits.

+ * * @param newDigits the new list of digits * @return a new instance of Version */ @@ -281,7 +338,8 @@ public Version setDigits( List newDigits ) } /** - * + *

Setter for the field annotationRevision.

+ * * @param newAnnotationRevision the new annotation revision * @return a new instance of Version */ @@ -294,7 +352,8 @@ public Version setAnnotationRevision( String newAnnotationRevision ) } /** - * + *

Setter for the field buildSpecifier.

+ * * @param newBuildSpecifier the new build specifier * @return a new instance of Version */ @@ -304,10 +363,15 @@ public Version setBuildSpecifier( String newBuildSpecifier ) this.annotationSeparator, this.annotationRevSeparator, Objects.toString( this.buildSeparator, DEFAULT_BUILD_SEPARATOR ) ); } - + /** - * @throws VersionComparisonConflictException if {@link org.eclipse.aether.version.Version} and + *

compareTo.

+ * + * @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 441692eb7..80011ac90 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 @@ */ /** - * + *

VersionComparisonConflictException class.

*/ public class VersionComparisonConflictException extends RuntimeException @@ -34,6 +34,14 @@ public class VersionComparisonConflictException private int mavenComparisonResult; + /** + *

Constructor for VersionComparisonConflictException.

+ * + * @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 d37cd9218..8d24cb112 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 @@ */ /** - * + *

VersionParseException class.

*/ public class VersionParseException extends Exception { + /** + *

Constructor for VersionParseException.

+ * + * @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 470c6c24a..d1314c2a2 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.shared.release.config.ReleaseDescriptorBuilder; /** + *

Abstract AbstractReleaseRequest class.

* * @author Robert Scholte * @since 2.3 @@ -38,6 +39,8 @@ public abstract class AbstractReleaseRequest private ReleaseManagerListener releaseManagerListener; /** + *

Getter for the field releaseDescriptorBuilder.

+ * * @return the releaseDescriptor */ public ReleaseDescriptorBuilder getReleaseDescriptorBuilder() @@ -46,6 +49,8 @@ public ReleaseDescriptorBuilder getReleaseDescriptorBuilder() } /** + *

Setter for the field releaseDescriptorBuilder.

+ * * @param releaseDescriptor the releaseDescriptor to set */ public void setReleaseDescriptorBuilder( ReleaseDescriptorBuilder releaseDescriptor ) @@ -54,6 +59,8 @@ public void setReleaseDescriptorBuilder( ReleaseDescriptorBuilder releaseDescrip } /** + *

Getter for the field reactorProjects.

+ * * @return the reactorProjects */ public List getReactorProjects() @@ -62,6 +69,8 @@ public List getReactorProjects() } /** + *

Setter for the field reactorProjects.

+ * * @param reactorProjects the reactorProjects to set */ public void setReactorProjects( List reactorProjects ) @@ -70,6 +79,8 @@ public void setReactorProjects( List reactorProjects ) } /** + *

Getter for the field releaseManagerListener.

+ * * @return the releaseManagerListener */ public ReleaseManagerListener getReleaseManagerListener() @@ -78,10 +89,12 @@ public ReleaseManagerListener getReleaseManagerListener() } /** + *

Setter for the field releaseManagerListener.

+ * * @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 b44934809..c04dd674c 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 @@ private ReleaseDescriptorBuilder loadReleaseDescriptorBuilder( ReleaseDescriptor } } + /** + *

clean.

+ * + * @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 b8bbb2315..192951873 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 static org.apache.maven.shared.utils.logging.MessageUtils.buffer; /** + *

DefaultReleaseManagerListener class.

+ * * @author Hervé Boutemy */ public class DefaultReleaseManagerListener @@ -42,11 +44,22 @@ public class DefaultReleaseManagerListener private int currentPhase; + /** + *

Constructor for DefaultReleaseManagerListener.

+ * + * @param log a {@link org.apache.maven.plugin.logging.Log} object + */ public DefaultReleaseManagerListener( Log log ) { this( log, false ); } + /** + *

Constructor for DefaultReleaseManagerListener.

+ * + * @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 void phaseStart( String name ) + "/" + phases.size() + " " + buffer().strong( name ) ); } + /** + *

phaseEnd.

+ */ public void phaseEnd() { // NOOP @@ -95,6 +111,9 @@ public void phaseSkip( String name ) nextPhase( name ); } + /** + *

goalEnd.

+ */ 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 45b69c85e..94725a0b2 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 org.apache.maven.shared.release.env.ReleaseEnvironment; /** + *

ReleaseBranchRequest class.

* * @author Robert Scholte * @since 2.3 @@ -37,6 +38,8 @@ public class ReleaseBranchRequest extends AbstractReleaseRequest private Properties userProperties; /** + *

Getter for the field dryRun.

+ * * @return the dryRun */ public Boolean getDryRun() @@ -45,6 +48,8 @@ public Boolean getDryRun() } /** + *

Setter for the field dryRun.

+ * * @param dryRun the dryRun to set */ public void setDryRun( Boolean dryRun ) @@ -53,6 +58,8 @@ public void setDryRun( Boolean dryRun ) } /** + *

Getter for the field releaseEnvironment.

+ * * @return the releaseEnvironment */ public ReleaseEnvironment getReleaseEnvironment() @@ -61,6 +68,8 @@ public ReleaseEnvironment getReleaseEnvironment() } /** + *

Setter for the field releaseEnvironment.

+ * * @param releaseEnvironment the releaseEnvironment to set */ public void setReleaseEnvironment( ReleaseEnvironment releaseEnvironment ) @@ -68,13 +77,23 @@ public void setReleaseEnvironment( ReleaseEnvironment releaseEnvironment ) this.releaseEnvironment = releaseEnvironment; } + /** + *

Getter for the field userProperties.

+ * + * @return a {@link java.util.Properties} object + */ public Properties getUserProperties() { return userProperties; } + /** + *

Setter for the field userProperties.

+ * + * @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 a1a32d0df..0aca351be 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 @@ */ /** + *

ReleaseCleanRequest class.

* * @author Robert Scholte * @since 2.3 @@ -27,4 +28,4 @@ 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 fdfb89ffe..791e70604 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; + /** + *

prepareWithResult.

+ * + * @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 ); + /** + *

performWithResult.

+ * + * @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 @@ void perform( ReleasePerformRequest performRequest ) * 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 @@ void perform( ReleasePerformRequest performRequest ) * 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 @@ void rollback( ReleaseRollbackRequest rollbackRequest ) * 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 @@ void rollback( ReleaseRollbackRequest rollbackRequest ) * 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 755e3e7df..e4292eed1 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 @@ import java.util.List; /** + *

ReleaseManagerListener interface.

+ * * @author Edwin Punzalan */ public interface ReleaseManagerListener { + /** + *

goalStart.

+ * + * @param goal a {@link java.lang.String} object + * @param phases a {@link java.util.List} object + */ void goalStart( String goal, List phases ); + /** + *

phaseStart.

+ * + * @param name a {@link java.lang.String} object + */ void phaseStart( String name ); + /** + *

phaseEnd.

+ */ void phaseEnd(); + /** + *

phaseSkip.

+ * + * @param name a {@link java.lang.String} object + */ void phaseSkip( String name ); + /** + *

goalEnd.

+ */ void goalEnd(); + /** + *

error.

+ * + * @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 5a0f51631..f4b37a458 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 @@ import org.apache.maven.shared.release.env.ReleaseEnvironment; /** + *

ReleasePerformRequest class.

* * @author Robert Scholte * @since 2.3 @@ -38,6 +39,8 @@ public class ReleasePerformRequest private ReleaseEnvironment releaseEnvironment; /** + *

Getter for the field dryRun.

+ * * @return the dryRun */ public Boolean getDryRun() @@ -46,6 +49,8 @@ public Boolean getDryRun() } /** + *

Setter for the field dryRun.

+ * * @param dryRun the dryRun to set */ public void setDryRun( Boolean dryRun ) @@ -54,6 +59,8 @@ public void setDryRun( Boolean dryRun ) } /** + *

Getter for the field clean.

+ * * @return the clean */ public Boolean getClean() @@ -62,6 +69,8 @@ public Boolean getClean() } /** + *

Setter for the field clean.

+ * * @param clean the clean to set */ public void setClean( Boolean clean ) @@ -70,6 +79,8 @@ public void setClean( Boolean clean ) } /** + *

Getter for the field releaseEnvironment.

+ * * @return the releaseEnvironment */ public ReleaseEnvironment getReleaseEnvironment() @@ -78,10 +89,12 @@ public ReleaseEnvironment getReleaseEnvironment() } /** + *

Setter for the field releaseEnvironment.

+ * * @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 7ac691559..992239322 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 org.apache.maven.shared.release.env.ReleaseEnvironment; /** + *

ReleasePrepareRequest class.

* * @author Robert Scholte * @since 2.3 @@ -42,6 +43,8 @@ public class ReleasePrepareRequest private Properties userProperties; /** + *

Getter for the field dryRun.

+ * * @return the dryRun */ public Boolean getDryRun() @@ -50,6 +53,8 @@ public Boolean getDryRun() } /** + *

Setter for the field dryRun.

+ * * @param dryRun the dryRun to set */ public void setDryRun( Boolean dryRun ) @@ -58,6 +63,8 @@ public void setDryRun( Boolean dryRun ) } /** + *

Getter for the field resume.

+ * * @return the resume */ public Boolean getResume() @@ -66,6 +73,8 @@ public Boolean getResume() } /** + *

Setter for the field resume.

+ * * @param resume the resume to set */ public void setResume( Boolean resume ) @@ -74,6 +83,8 @@ public void setResume( Boolean resume ) } /** + *

Getter for the field releaseEnvironment.

+ * * @return the releaseEnvironment */ public ReleaseEnvironment getReleaseEnvironment() @@ -82,6 +93,8 @@ public ReleaseEnvironment getReleaseEnvironment() } /** + *

Setter for the field releaseEnvironment.

+ * * @param releaseEnvironment the releaseEnvironment to set */ public void setReleaseEnvironment( ReleaseEnvironment releaseEnvironment ) @@ -89,13 +102,23 @@ public void setReleaseEnvironment( ReleaseEnvironment releaseEnvironment ) this.releaseEnvironment = releaseEnvironment; } + /** + *

Getter for the field userProperties.

+ * + * @return a {@link java.util.Properties} object + */ public Properties getUserProperties() { return userProperties; } + /** + *

Setter for the field userProperties.

+ * + * @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 d91dd3a2c..45d24de88 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 @@ import org.apache.maven.shared.release.env.ReleaseEnvironment; /** + *

ReleaseRollbackRequest class.

* * @author Robert Scholte * @since 2.3 @@ -32,6 +33,8 @@ public class ReleaseRollbackRequest private ReleaseEnvironment releaseEnvironment; /** + *

Getter for the field releaseEnvironment.

+ * * @return the releaseEnvironment */ public ReleaseEnvironment getReleaseEnvironment() @@ -40,10 +43,12 @@ public ReleaseEnvironment getReleaseEnvironment() } /** + *

Setter for the field releaseEnvironment.

+ * * @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 81c768c35..3412fc465 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 org.apache.maven.shared.release.env.ReleaseEnvironment; /** + *

ReleaseUpdateVersionsRequest class.

* * @author Robert Scholte * @since 2.3 @@ -36,6 +37,8 @@ public class ReleaseUpdateVersionsRequest private Properties userProperties; /** + *

Getter for the field releaseEnvironment.

+ * * @return the releaseEnvironment */ public ReleaseEnvironment getReleaseEnvironment() @@ -44,6 +47,8 @@ public ReleaseEnvironment getReleaseEnvironment() } /** + *

Setter for the field releaseEnvironment.

+ * * @param releaseEnvironment the releaseEnvironment to set */ public void setReleaseEnvironment( ReleaseEnvironment releaseEnvironment ) @@ -51,13 +56,23 @@ public void setReleaseEnvironment( ReleaseEnvironment releaseEnvironment ) this.releaseEnvironment = releaseEnvironment; } + /** + *

Getter for the field userProperties.

+ * + * @return a {@link java.util.Properties} object + */ public Properties getUserProperties() { return userProperties; } + /** + *

Setter for the field userProperties.

+ * + * @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 a7506b8fa..3033a45de 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 ReleaseDescriptorBuilder read( ReleaseDescriptorBuilder mergeDescriptor ) return read( mergeDescriptor, getDefaultReleasePropertiesFile( mergeDescriptor.build() ) ); } + /** + *

read.

+ * + * @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 ); } + /** + *

read.

+ * + * @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 void delete( ReleaseDescriptor config ) } } + /** + *

write.

+ * + * @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 eb3c3f37b..e6efa91af 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 org.apache.maven.model.Scm; /** - * + *

ReleaseDescriptorBuilder class.

+ * * @author Robert Scholte * @since 3.0.0 */ @@ -45,191 +46,380 @@ private BuilderReleaseDescriptor() private final BuilderReleaseDescriptor releaseDescriptor; + /** + *

Constructor for ReleaseDescriptorBuilder.

+ */ public ReleaseDescriptorBuilder() { this.releaseDescriptor = new BuilderReleaseDescriptor(); } + /** + *

addCheckModificationExclude.

+ * + * @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; } + /** + *

setActivateProfiles.

+ * + * @param profiles a {@link java.util.List} object + * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object + */ public ReleaseDescriptorBuilder setActivateProfiles( List profiles ) { releaseDescriptor.setActivateProfiles( profiles ); return this; } + /** + *

setAddSchema.

+ * + * @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; } + /** + *

setAdditionalArguments.

+ * + * @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; } + /** + *

setAllowTimestampedSnapshots.

+ * + * @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; } + /** + *

setAutoVersionSubmodules.

+ * + * @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; } + /** + *

setBranchCreation.

+ * + * @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; } + /** + *

setCheckModificationExcludes.

+ * + * @param checkModificationExcludes a {@link java.util.List} object + * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptorBuilder} object + */ public ReleaseDescriptorBuilder setCheckModificationExcludes( List checkModificationExcludes ) { releaseDescriptor.setCheckModificationExcludes( checkModificationExcludes ); return this; } + /** + *

setCheckoutDirectory.

+ * + * @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; } + /** + *

setCommitByProject.

+ * + * @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; } + /** + *

setCompletedPhase.

+ * + * @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; } + /** + *

setCompletionGoals.

+ * + * @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; } + /** + *

setDefaultDevelopmentVersion.

+ * + * @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; } + /** + *

setDefaultReleaseVersion.

+ * + * @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; } + /** + *

setDescription.

+ * + * @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; } + /** + *

setGenerateReleasePoms.

+ * + * @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; } + /** + *

setInteractive.

+ * + * @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; } + /** + *

setLocalCheckout.

+ * + * @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; } + /** + *

setModelEncoding.

+ * + * @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; } + /** + *

setName.

+ * + * @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; } + /** + *

setPerformGoals.

+ * + * @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; } + /** + *

setPomFileName.

+ * + * @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; } + /** + *

setPreparationGoals.

+ * + * @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; } + /** + *

setProjectNamingPolicyId.

+ * + * @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; } + /** + *

setProjectVersionPolicyId.

+ * + * @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; } + /** + *

setPushChanges.

+ * + * @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; } + /** + *

setWorkItem.

+ * + * @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; } + /** + *

setReleaseStrategyId.

+ * + * @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; } + /** + *

setRemoteTagging.

+ * + * @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; } + /** + *

setScmBranchBase.

+ * + * @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; } + /** + *

setScmCommentPrefix.

+ * + * @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 ReleaseDescriptorBuilder setScmCommentPrefix( String scmCommentPrefix ) } /** + *

setScmReleaseCommitComment.

+ * * @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 ReleaseDescriptorBuilder setScmReleaseCommitComment( String scmReleaseCom } /** + *

setScmDevelopmentCommitComment.

+ * * @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 ReleaseDescriptorBuilder setScmDevelopmentCommitComment( String scmDevelo } /** + *

setScmBranchCommitComment.

+ * * @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 ReleaseDescriptorBuilder setScmBranchCommitComment( String scmBranchCommi } /** + *

setScmRollbackCommitComment.

+ * * @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 ReleaseDescriptorBuilder setScmRollbackCommitComment( String scmRollbackC return this; } + /** + *

setScmId.

+ * + * @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; } + /** + *

setScmPassword.

+ * + * @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; } + /** + *

setScmPrivateKey.

+ * + * @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; } + /** + *

setScmPrivateKeyPassPhrase.

+ * + * @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; } + /** + *

setScmRelativePathProjectDirectory.

+ * + * @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; } + /** + *

setScmReleaseLabel.

+ * + * @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; } + /** + *

setScmReleasedPomRevision.

+ * + * @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; } + /** + *

setScmSourceUrl.

+ * + * @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; } + /** + *

setScmTagBase.

+ * + * @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; } + /** + *

setScmTagNameFormat.

+ * + * @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; } + /** + *

setScmSignTags.

+ * + * @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; } + /** + *

setScmUseEditMode.

+ * + * @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; } + /** + *

setScmUsername.

+ * + * @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; } + /** + *

setSnapshotReleasePluginAllowed.

+ * + * @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; } + /** + *

setSuppressCommitBeforeTagOrBranch.

+ * + * @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; } + /** + *

setUpdateBranchVersions.

+ * + * @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; } + /** + *

setUpdateDependencies.

+ * + * @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; } + /** + *

setUpdateVersionsToSnapshot.

+ * + * @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; } + /** + *

setUpdateWorkingCopyVersions.

+ * + * @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; } + /** + *

setUseReleaseProfile.

+ * + * @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; } + /** + *

setWaitBeforeTagging.

+ * + * @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; } + /** + *

setWorkingDirectory.

+ * + * @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; } + /** + *

addReleaseVersion.

+ * + * @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; } + /** + *

addDevelopmentVersion.

+ * + * @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; } + /** + *

addOriginalScmInfo.

+ * + * @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; } + /** + *

putOriginalVersion.

+ * + * @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 ); } + /** + *

addDependencyOriginalVersion.

+ * + * @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 ReleaseDescriptorBuilder addDependencyOriginalVersion( String dependencyK } + /** + *

addDependencyReleaseVersion.

+ * + * @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; } + /** + *

addDependencyDevelopmentVersion.

+ * + * @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; } + /** + *

setAutoResolveSnapshots.

+ * + * @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; } + /** + *

setPinExternals.

+ * + * @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 69092c174..4327be101 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 @@ ReleaseDescriptorBuilder read( ReleaseDescriptorBuilder mergeDescriptor ) * 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 443da6c45..e6f3d708b 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 @@ public class ReleaseDescriptorStoreException extends Exception { + /** + *

Constructor for ReleaseDescriptorStoreException.

+ * + * @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 ed31afe1a..8ede3e5ea 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 @@ private ReleaseUtils() // nothing to see here } + /** + *

buildReleaseDescriptor.

+ * + * @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(); } + /** + *

copyPropertiesToReleaseDescriptor.

+ * + * @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 3305756f3..1562c2e09 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 org.apache.maven.settings.Settings; /** + *

DefaultReleaseEnvironment class.

* */ public class DefaultReleaseEnvironment @@ -55,12 +56,24 @@ public Settings getSettings() return settings; } + /** + *

Setter for the field mavenHome.

+ * + * @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; } + /** + *

Setter for the field settings.

+ * + * @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 String getMavenExecutorId() return mavenExecutorId; } + /** + *

Setter for the field mavenExecutorId.

+ * + * @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 File getJavaHome() return javaHome; } + /** + *

Setter for the field javaHome.

+ * + * @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 File getLocalRepositoryDirectory() return localRepo; } + /** + *

Setter for the field localRepositoryDirectory.

+ * + * @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 Locale getLocale() return locale; } + /** + *

Setter for the field locale.

+ * + * @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 e70fa0e1e..0041351f2 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.model.SettingsSecurity; /** + *

Abstract AbstractMavenExecutor class.

* */ public abstract class AbstractMavenExecutor @@ -65,6 +66,9 @@ public abstract class AbstractMavenExecutor @Requirement private PlexusCipher cipher; + /** + *

Constructor for AbstractMavenExecutor.

+ */ protected AbstractMavenExecutor() { } @@ -95,6 +99,11 @@ protected abstract void executeGoals( File workingDirectory, List goals, String additionalArguments, String pomFileName, ReleaseResult result ) throws MavenExecutorException; + /** + *

Getter for the field logger.

+ * + * @return a {@link org.codehaus.plexus.logging.Logger} object + */ protected final Logger getLogger() { return logger; @@ -107,6 +116,12 @@ public void enableLogging( Logger logger ) } + /** + *

encryptSettings.

+ * + * @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 @@ private boolean isEncryptedString( String str ) return cipher.isEncryptedString( str ); } + /** + *

getSettingsWriter.

+ * + * @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 3699f68a4..c90d69c11 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 af0051fb2..2c8907d0a 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 void executeGoals( File workingDirectory, List goals, ReleaseEnvi } } + /** + *

Setter for the field commandLineFactory.

+ * + * @param commandLineFactory a {@link org.apache.maven.shared.release.exec.CommandLineFactory} object + */ public void setCommandLineFactory( CommandLineFactory commandLineFactory ) { this.commandLineFactory = commandLineFactory; } + /** + *

executeCommandLine.

+ * + * @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 eb9e04487..974a8e45d 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 ALTERNATE_USER_TOOLCHAINS='t' */ 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 + /** + *

setupRequest.

+ * + * @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 void executeGoals( File workingDirectory, List goals, ReleaseEnvi } } + /** + *

getInvokerLogger.

+ * + * @return a {@link org.apache.maven.shared.invoker.InvokerLogger} object + */ protected InvokerLogger getInvokerLogger() { return new LoggerBridge( getLogger() ); } + /** + *

getOutputHandler.

+ * + * @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 e1fe9f54d..e3fd6f137 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 74300c730..9d8c8154e 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; + /** + *

Constructor for MavenExecutorException.

+ * + * @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 MavenExecutorException( String message, int exitCode ) this.exitCode = exitCode; } + /** + *

Constructor for MavenExecutorException.

+ * + * @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 ); } + /** + *

Getter for the field exitCode.

+ * + * @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 f75b69e51..de38e44b7 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.OutputStream; /** + *

RawStreamPumper class.

* */ public class RawStreamPumper @@ -39,6 +40,13 @@ public class RawStreamPumper byte buffer[] = new byte[256]; + /** + *

Constructor for RawStreamPumper.

+ * + * @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 RawStreamPumper( InputStream in , OutputStream out, boolean poll ) this.poll = poll; } + /** + *

Constructor for RawStreamPumper.

+ * + * @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 RawStreamPumper( InputStream in , OutputStream out ) this.poll = false; } + /** + *

Setter for the field done.

+ */ public void setDone() { done = true; } + /** + *

closeInput.

+ * + * @throws java.io.IOException if any. + */ public void closeInput() throws IOException { in.close(); } + /** + *

closeOutput.

+ * + * @throws java.io.IOException if any. + */ public void closeOutput() throws IOException { @@ -125,4 +152,4 @@ public void run() 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 1ca009244..c10788e0b 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; + /** + *

Constructor for TeeConsumer.

+ * + * @param stream a {@link java.io.PrintStream} object + */ public TeeConsumer( PrintStream stream ) { this( stream, " " ); } + /** + *

Constructor for TeeConsumer.

+ * + * @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 void consumeLine( String line ) content.append( LS ); } + /** + *

Getter for the field content.

+ * + * @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 e06fa1337..bfa6143d4 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.OutputStream; /** + *

TeeOutputStream class.

* */ public class TeeOutputStream @@ -34,11 +35,22 @@ public class TeeOutputStream private byte indent[]; private int last = '\n'; + /** + *

Constructor for TeeOutputStream.

+ * + * @param out a {@link java.io.OutputStream} object + */ public TeeOutputStream( OutputStream out ) { this( out, " " ); } + /** + *

Constructor for TeeOutputStream.

+ * + * @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 String toString() return bout.toString(); } + /** + *

getContent.

+ * + * @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 b2a7e8edf..81963de50 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 java.io.File; /** + *

Abstract AbstractBackupPomsPhase class.

+ * * @author Edwin Punzalan */ public abstract class AbstractBackupPomsPhase @@ -32,6 +34,12 @@ public abstract class AbstractBackupPomsPhase { private final String backupSuffix = ".releaseBackup"; + /** + *

getPomBackup.

+ * + * @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 @@ protected File getPomBackup( MavenProject project ) } } + /** + *

deletePomBackup.

+ * + * @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 4c845410a..7c5a04705 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 scmTranslators; + /** + *

Getter for the field scmTranslators.

+ * + * @return a {@link java.util.Map} object + */ protected final Map getScmTranslators() { return scmTranslators; @@ -99,11 +104,21 @@ protected final Map getScmTranslators() private String ls = ReleaseUtil.LS; + /** + *

Setter for the field ls.

+ * + * @param ls a {@link java.lang.String} object + */ public void setLs( String ls ) { this.ls = ls; } + /** + *

Setter for the field modelETL.

+ * + * @param modelETL a {@link java.lang.String} object + */ public void setModelETL( String modelETL ) { this.modelETL = modelETL; @@ -111,11 +126,21 @@ public void setModelETL( String modelETL ) private long startTime = -1 * 1000; + /** + *

Setter for the field startTime.

+ * + * @param startTime a long + */ public void setStartTime( long startTime ) { this.startTime = startTime; } + /** + *

getPomSuffix.

+ * + * @return a {@link java.lang.String} object + */ protected abstract String getPomSuffix(); @Override @@ -590,20 +615,54 @@ private void prepareScm( File pomFile, ReleaseDescriptor releaseDescriptor, ScmR } + /** + *

getResolvedSnapshotVersion.

+ * + * @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 ); + /** + *

getOriginalVersion.

+ * + * @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 ); + /** + *

getNextVersion.

+ * + * @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 ); + /** + *

transformScm.

+ * + * @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; /** + *

isUpdateScm.

* * @return {@code true} if the SCM-section should be updated, otherwise {@code false} * @since 2.4 @@ -613,6 +672,13 @@ protected boolean isUpdateScm() return true; } + /** + *

getOriginalResolvedSnapshotVersion.

+ * + * @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 3ae72acab..b9b1a5a1c 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 ReleaseResult simulate( ReleaseDescriptor releaseDescriptor, ReleaseEnvir return result; } + /** + *

runLogic.

+ * + * @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 reactorProjects, ReleaseResult result, boolean simulating ) throws ReleaseScmCommandException, ReleaseExecutionException, ReleaseScmRepositoryException; + /** + *

performCheckins.

+ * + * @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 reactorProjects, String message ) throws ReleaseScmRepositoryException, ReleaseExecutionException, ReleaseScmCommandException @@ -173,6 +196,14 @@ private void checkin( ScmProvider provider, ScmRepository repository, ScmFileSet } } + /** + *

simulateCheckins.

+ * + * @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 reactorProjects, ReleaseResult result, String message ) { @@ -180,6 +211,12 @@ protected void simulateCheckins( ReleaseDescriptor releaseDescriptor, ListvalidateConfiguration.

+ * + * @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 @@ protected void validateConfiguration( ReleaseDescriptor releaseDescriptor ) } } + /** + *

createMessage.

+ * + * @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 reactorProjects, ReleaseDescriptor releaseDescriptor ) throws ReleaseExecutionException @@ -232,6 +277,13 @@ else if ( "getScmRollbackCommitComment".equals( descriptorCommentGetter ) ) return comment; } + /** + *

createPomFiles.

+ * + * @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 createPomFiles( ReleaseDescriptor releaseDescriptor, MavenProject project ) { List pomFiles = new ArrayList<>(); @@ -246,6 +298,13 @@ protected static List createPomFiles( ReleaseDescriptor releaseDescriptor, return pomFiles; } + /** + *

createPomFiles.

+ * + * @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 createPomFiles( ReleaseDescriptor releaseDescriptor, List 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 5f78c76c4..3424c1e34 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 @@ /** * @author Emmanuel Venisse - * @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 17bc3f467..76e55343d 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 @@ /** * @author Emmanuel Venisse - * @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 c155e3c46..bdf292fbd 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 @@ boolean isBranchOperation() return branchOperation; } + /** + *

getScmProvider.

+ * + * @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 e3f0cabaa..032271ff5 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 @@ private void removeReleasePomsFromScm( ReleaseDescriptor releaseDescriptor, Rele } } } -} \ 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 95d06db68..3d5561406 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 @@ 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 82e61b407..6f60c06d9 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 @@ * Rewrite POMs for branch. * * @author Emmanuel Venisse - * @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 a3243e46a..41c261666 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 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 c81889e7e..bf8a8a80c 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 @@ private String createRollbackMessage( ReleaseDescriptor releaseDescriptor ) 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 a646dfcc1..79667305d 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.codehaus.plexus.component.annotations.Component; /** + *

DefaultNamingPolicy class.

* * @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 3f323719a..f4c8cf012 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.codehaus.plexus.component.annotations.Component; /** + *

DefaultVersionPolicy class.

* * @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 2baa91520..e67b08f19 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 @@ 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 String resolveTag( String tag ) } } - /** - * {@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 60370a932..3180a3db3 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 @@ 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 String resolveTag( String tag ) } } - /** - * {@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 3bfa4dd7c..0dd2280ad 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 ScmProvider getRepositoryProvider( ScmRepository repository ) return scmManager.getProviderByRepository( repository ); } + /** + *

Setter for the field scmManager.

+ * + * @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 ccc67ce2e..2739576c5 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 @@ import org.codehaus.plexus.component.annotations.Component; /** + *

GitScmTranslator class.

*/ @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 953d5346f..1968fb352 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 @@ import org.codehaus.plexus.component.annotations.Component; /** + *

HgScmTranslator class.

*/ @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 51b3ad1bb..0a963fb89 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 @@ * 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; /** + *

Getter for the field id.

+ * * @return the id */ public String getId() @@ -44,10 +45,12 @@ public String getId() } /** + *

Setter for the field id.

+ * * @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 d5fd8cded..a770d4e54 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 @@ public class JazzScmTranslator implements ScmTranslator { - /** - * {@inheritDoc} - */ @Override public String translateBranchUrl( String url, String branchName, String branchBase ) { @@ -53,9 +50,6 @@ public String translateBranchUrl( String url, String branchName, String branchBa return url; } - /** - * {@inheritDoc} - */ @Override public String translateTagUrl( String url, String tag, String tagBase ) { @@ -74,9 +68,6 @@ public String translateTagUrl( String url, String tag, String tagBase ) return url; } - /** - * {@inheritDoc} - */ @Override public String resolveTag( String tag ) { @@ -84,9 +75,6 @@ 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/scm/ReleaseScmCommandException.java b/maven-release-manager/src/main/java/org/apache/maven/shared/release/scm/ReleaseScmCommandException.java index 96562f202..a372a2b3a 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 @@ public class ReleaseScmCommandException extends ReleaseFailureException { + /** + *

Constructor for ReleaseScmCommandException.

+ * + * @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 6edfb228b..f644b3b7e 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 @@ public class ReleaseScmRepositoryException extends ReleaseFailureException { + /** + *

Constructor for ReleaseScmRepositoryException.

+ * + * @param message a {@link java.lang.String} object + * @param validationMessages a {@link java.util.List} object + */ public ReleaseScmRepositoryException( String message, List 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 6281d631e..b4c759aed 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 @@ ScmRepository getConfiguredRepository( ReleaseDescriptor releaseDescriptor, Sett * * @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 @@ ScmProvider getRepositoryProvider( ScmRepository repository ) * @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 85b6bb698..abf68e114 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 @@ public class SubversionScmTranslator implements ScmTranslator { - /** - * {@inheritDoc} - */ @Override public String translateBranchUrl( String url, String branchName, String branchBase ) { @@ -43,27 +40,18 @@ public String translateBranchUrl( String url, String branchName, String branchBa 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 ad5c1ee6e..3a8042aca 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 org.apache.maven.shared.release.strategy.Strategy; /** - * + *

DefaultStrategy class.

+ * * @author Robert Scholte * @since 3.0.0 */ @@ -61,6 +62,11 @@ public List getPreparePhases() return preparePhases; } + /** + *

Setter for the field preparePhases.

+ * + * @param preparePhases a {@link java.util.List} object + */ public void setPreparePhases( List preparePhases ) { this.preparePhases = preparePhases; @@ -72,6 +78,11 @@ public List getPerformPhases() return performPhases; } + /** + *

Setter for the field performPhases.

+ * + * @param performPhases a {@link java.util.List} object + */ public void setPerformPhases( List performPhases ) { this.performPhases = performPhases; @@ -83,6 +94,11 @@ public List getRollbackPhases() return rollbackPhases; } + /** + *

Setter for the field rollbackPhases.

+ * + * @param rollbackPhases a {@link java.util.List} object + */ public void setRollbackPhases( List rollbackPhases ) { this.rollbackPhases = rollbackPhases; @@ -94,6 +110,11 @@ public List getBranchPhases() return branchPhases; } + /** + *

Setter for the field branchPhases.

+ * + * @param branchPhases a {@link java.util.List} object + */ public void setBranchPhases( List branchPhases ) { this.branchPhases = branchPhases; @@ -105,6 +126,11 @@ public List getUpdateVersionsPhases() return updateVersionsPhases; } + /** + *

Setter for the field updateVersionsPhases.

+ * + * @param updateVersionsPhases a {@link java.util.List} object + */ public void setUpdateVersionsPhases( List 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 69b08e172..422b66c3d 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 @@ */ /** + *

MavenCoordinate interface.

* * @author Robert Scholte * @since 3.0 */ public interface MavenCoordinate { + /** + *

getGroupId.

+ * + * @return a {@link java.lang.String} object + */ String getGroupId(); + /** + *

getArtifactId.

+ * + * @return a {@link java.lang.String} object + */ String getArtifactId(); + /** + *

getVersion.

+ * + * @return a {@link java.lang.String} object + */ String getVersion(); + /** + *

setVersion.

+ * + * @param version a {@link java.lang.String} object + */ void setVersion( String version ); // @todo helper method during refactoring, will be removed + /** + *

getName.

+ * + * @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 e0c255058..4ebd36578 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.shared.release.ReleaseExecutionException; /** + *

ModelETL interface.

* * @author Robert Scholte * @since 3.0 */ public interface ModelETL { + /** + *

extract.

+ * + * @param pomFile a {@link java.io.File} object + * @throws org.apache.maven.shared.release.ReleaseExecutionException if any. + */ void extract( File pomFile ) throws ReleaseExecutionException; + /** + *

transform.

+ */ void transform(); + /** + *

load.

+ * + * @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 + /** + *

getModel.

+ * + * @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 4748edc93..618d93ead 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 @@ */ /** + *

ModelETLFactory interface.

* * @author Robert Scholte * @since 3.0 */ public interface ModelETLFactory { + /** + *

newInstance.

+ * + * @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 ae57d1f55..c39c56fec 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.shared.release.config.ReleaseDescriptor; /** + *

ModelETLRequest class.

* * @author Robert Scholte * @since 3.0 @@ -35,33 +36,63 @@ public class ModelETLRequest private ReleaseDescriptor releaseDescriptor; + /** + *

Getter for the field lineSeparator.

+ * + * @return a {@link java.lang.String} object + */ public String getLineSeparator() { return lineSeparator; } + /** + *

Setter for the field lineSeparator.

+ * + * @param lineSeparator a {@link java.lang.String} object + */ public void setLineSeparator( String lineSeparator ) { this.lineSeparator = lineSeparator; } + /** + *

Getter for the field project.

+ * + * @return a {@link org.apache.maven.project.MavenProject} object + */ public MavenProject getProject() { return project; } + /** + *

Setter for the field project.

+ * + * @param project a {@link org.apache.maven.project.MavenProject} object + */ public void setProject( MavenProject project ) { this.project = project; } + /** + *

Getter for the field releaseDescriptor.

+ * + * @return a {@link org.apache.maven.shared.release.config.ReleaseDescriptor} object + */ public ReleaseDescriptor getReleaseDescriptor() { return releaseDescriptor; } + /** + *

Setter for the field releaseDescriptor.

+ * + * @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 cc00f3265..53fb678f5 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; + /** + *

Constructor for JDomBuild.

+ * + * @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 c1f62304e..3d94cc730 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; + /** + *

Constructor for JDomDependency.

+ * + * @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 84fc1f9a0..5fcf48865 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; + /** + *

Constructor for JDomDependencyManagement.

+ * + * @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 49f0f4687..947364012 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; + /** + *

Constructor for JDomExtension.

+ * + * @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 af476364e..c2e10aa49 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.jdom2.Element; /** + *

JDomMavenCoordinate class.

* * @author Robert Scholte * @since 3.0 @@ -31,6 +32,11 @@ public class JDomMavenCoordinate implements MavenCoordinate { private final Element element; + /** + *

Constructor for JDomMavenCoordinate.

+ * + * @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 28c282623..5567e6886 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; + /** + *

Constructor for JDomModel.

+ * + * @param document a {@link org.jdom2.Document} object + */ public JDomModel( Document document ) { this( document.getRootElement() ); } + /** + *

Constructor for JDomModel.

+ * + * @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 347fb810b..c97d59985 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.jdom2.Element; /** + *

JDomModelBase class.

* * @author Robert Scholte * @since 3.0 @@ -37,11 +38,21 @@ public class JDomModelBase { private final Element modelBase; + /** + *

Constructor for JDomModelBase.

+ * + * @param modelBase a {@link org.jdom2.Element} object + */ public JDomModelBase( Element modelBase ) { this.modelBase = modelBase; } + /** + *

getBuild.

+ * + * @return a {@link org.apache.maven.model.Build} object + */ public Build getBuild() { Element elm = modelBase.getChild( "build", modelBase.getNamespace() ); @@ -56,6 +67,11 @@ public Build getBuild() } } + /** + *

getDependencies.

+ * + * @return a {@link java.util.List} object + */ public List getDependencies() { Element dependenciesElm = modelBase.getChild( "dependencies", modelBase.getNamespace() ); @@ -78,6 +94,11 @@ public List getDependencies() } } + /** + *

getDependencyManagement.

+ * + * @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 2c5bbf5b5..e0cb7c5d1 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; + /** + *

Setter for the field ls.

+ * + * @param ls a {@link java.lang.String} object + */ public void setLs( String ls ) { this.ls = ls; } + /** + *

Setter for the field releaseDescriptor.

+ * + * @param releaseDescriptor a {@link org.apache.maven.shared.release.config.ReleaseDescriptor} object + */ public void setReleaseDescriptor( ReleaseDescriptor releaseDescriptor ) { this.releaseDescriptor = releaseDescriptor; } + /** + *

Setter for the field project.

+ * + * @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 66db57535..4d7ba695e 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.codehaus.plexus.component.annotations.Component; /** + *

JDomModelETLFactory class.

+ * * @author Robert Scholte * @since 3.0 */ @Component( role = ModelETLFactory.class, hint = JDomModelETLFactory.ROLE_HINT ) public class JDomModelETLFactory implements ModelETLFactory { + /** Constant ROLE_HINT="jdom2-sax" */ 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 51cb70845..9d179c834 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; + /** + *

Constructor for JDomParent.

+ * + * @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 3b2970001..128405acd 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; + /** + *

Constructor for JDomPlugin.

+ * + * @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 5bfa072c0..39bd06140 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; + /** + *

Constructor for JDomPluginManagement.

+ * + * @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 a7114fa6b..0a95f9d1c 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; + /** + *

Constructor for JDomProfile.

+ * + * @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 5ca3eeb96..ea7eb75a1 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; + /** + *

Constructor for JDomProperties.

+ * + * @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 f3e169ccf..12dcc9fd1 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; + /** + *

Constructor for JDomReportPlugin.

+ * + * @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 21adc8eec..1f50fec93 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; + /** + *

Constructor for JDomReporting.

+ * + * @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 f11fc19a8..d40b652c9 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 static void rewriteValue( Element element, String value ) } } + /** + *

rewriteElement.

+ * + * @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 df2519222..5f93e590f 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 @@ * 'right' sub directory in this case. * subdirectory

* - *

Usage:

+ * Usage: *

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.

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 7b64f20c7..5aee8d974 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 @@ /** * @author Emmanuel Venisse - * @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 71b496329..d879cdaaf 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 STANDARD_PATTERN */ 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 ALTERNATE_PATTERN */ 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 DefaultVersionInfo( String version ) } } + /** + *

Constructor for DefaultVersionInfo.

+ * + * @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 digits, String annotation, String annotationRevision, String buildSpecifier, String annotationSeparator, String annotationRevSeparator, String buildSeparator ) { @@ -214,13 +227,10 @@ public VersionInfo getNextVersion() } /** + * {@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 int hashCode() * 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 String toString() return strVersion; } + /** + *

getVersionString.

+ * + * @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 @@ private static String nullIfEmpty( String s ) return StringUtils.isEmpty( s ) ? null : s; } + /** + *

Getter for the field digits.

+ * + * @return a {@link java.util.List} object + */ public List getDigits() { return digits; } + /** + *

Getter for the field annotation.

+ * + * @return a {@link java.lang.String} object + */ public String getAnnotation() { return annotation; } + /** + *

Getter for the field annotationRevision.

+ * + * @return a {@link java.lang.String} object + */ public String getAnnotationRevision() { return annotationRevision; } + /** + *

Getter for the field buildSpecifier.

+ * + * @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 de2c9945e..f1cd57880 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 @@ /** * Represent the different version representations during the release-prepare phase + * */ public interface VersionInfo extends Comparable @@ -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 5b6cbf7ac..0855a4179 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 @@ * 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 0d7827b05..b983e50a6 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 @@ /** * @author Emmanuel Venisse - * @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 c11540350..cde39acf9 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 @@ * * @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 7ad6faac9..831aa59be 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 @@ * 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 4d8f9633a..e24c98221 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 @@ * 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 86e453fde..22c6d8af3 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 @@ * 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 e2284fc88..9296f4f4a 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 @@ * 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 7afbcee44..b9172ec97 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 @@ * * @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 df6c24219..aaa4d53d7 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 @@ * 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 0b4f8c4e9..a682d844c 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 @@ * 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 d44ed8c89..537e026a4 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 @@ * 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 5a4ded431..46eccec7d 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 @@ * Base class with shared configuration. * * @author Brett Porter - * @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 f7113bbc3..b7532a75b 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 @@ else if ( project.getScm().getConnection() != null ) return descriptor; } + /** + *

buildScm.

+ * + * @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 955b01ad2..6ffe71f55 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.config.ReleaseDescriptorBuilder; /** - * Branch a project in SCM, using the same steps as the release:prepare goal, creating a branch instead of a - * tag. For more info see release:prepare goal, creating a branch instead of + * a tag. For more info see https://maven.apache.org/plugins/maven-release-plugin/examples/branch.html. * * @author Emmanuel Venisse - * @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 43e34756e..6c2d00974 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.config.ReleaseDescriptorBuilder; /** - * Clean up after a release preparation. This is done automatically after a successful release:perform, + * Clean up after a release preparation. This is done automatically after a successful release:perform, * 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 https://maven.apache.org/plugins/maven-release-plugin/examples/clean-release.html. * * @author Brett Porter - * @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 51636f0b2..e1aa97d70 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 @@ /** * Perform a release from SCM, either from a specified tag, or the tag representing the previous release in - * the working copy created by release:prepare. + * the working copy created by release:prepare. * For more info see https://maven.apache.org/plugins/maven-release-plugin/examples/perform-release.html. * * @author Emmanuel Venisse * @author Brett Porter - * @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 204e27f4b..aff953e71 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 @@ /** * 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 release:perform. For more info see release:perform. For more info see https://maven.apache.org/plugins/maven-release-plugin/examples/prepare-release.html. * @@ -43,7 +43,6 @@ * @author Emmanuel Venisse * @author Jason van Zyl * @author Brett Porter - * @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 void execute() prepareRelease( generateReleasePoms ); } + /** + *

prepareRelease.

+ * + * @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 11778c6f9..19ee2009d 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 @@ /** * Rollback changes made by a previous release. This requires that the previous release descriptor - * release.properties is still available in the local working copy. For more info see release.properties is still available in the local working copy. For more info see https://maven.apache.org/plugins/maven-release-plugin/examples/rollback-release.html. * * @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 a92b7b3ba..a32b9907c 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 @@ * are overridden with site:stage-deploy. * * @author Nicolas De Loof - * @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 17c47de8a..b790d6411 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.config.ReleaseDescriptorBuilder; /** - * Update the POM versions for a project. This performs the normal version updates of the release:prepare goal - * without making other modifications to the SCM such as tagging. For more info see release:prepare + * goal without making other modifications to the SCM such as tagging. For more info see https://maven.apache.org/plugins/maven-release-plugin/examples/update-versions.html. * * @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 2aedf9c6c..8a34780db 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.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:
    *
  • 1.0.0-SNAPSHOT gets 1.0.0 for next release,
    • *
  • 1.0.1-SNAPSHOT gets 1.0.2 for next release,
    • *
  • 1.0.2 gets 1.0.3-SNAPSHOT for next development version.
    • *
+ * */ @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 0a20c620c..6cf0b1ec9 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.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, diff --git a/pom.xml b/pom.xml index 4db155139..c6488ce05 100644 --- a/pom.xml +++ b/pom.xml @@ -106,6 +106,15 @@ + + maven-javadoc-plugin + 3.2.0 + + + org.apache.maven.plugins + maven-project-info-reports-plugin + 3.1.2 +