You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kh...@apache.org on 2017/05/07 12:27:57 UTC
svn commit: r1794194 - in
/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared:
artifact/install/ dependencies/ dependencies/collect/ dependencies/resolve/
project/deploy/ project/deploy/internal/ project/install/
Author: khmarbaise
Date: Sun May 7 12:27:57 2017
New Revision: 1794194
URL: http://svn.apache.org/viewvc?rev=1794194&view=rev
Log:
Fixed several checkstyle reported errors
o Added missing JavaDoc's
o Added missing author.
o Enhanced class docs.
Modified:
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/install/ArtifactInstaller.java
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/DefaultDependableCoordinate.java
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/TransferUtils.java
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/collect/DependencyCollector.java
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/resolve/DependencyResolver.java
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/resolve/DependencyResolverException.java
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/resolve/DependencyResult.java
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployer.java
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployerRequest.java
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/internal/DefaultProjectDeployer.java
maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/install/ProjectInstallerRequest.java
Modified: maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/install/ArtifactInstaller.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/install/ArtifactInstaller.java?rev=1794194&r1=1794193&r2=1794194&view=diff
==============================================================================
--- maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/install/ArtifactInstaller.java (original)
+++ maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/artifact/install/ArtifactInstaller.java Sun May 7 12:27:57 2017
@@ -38,8 +38,15 @@ public interface ArtifactInstaller
*/
void install( ProjectBuildingRequest request, Collection<Artifact> mavenArtifacts )
throws ArtifactInstallerException;
-
+
+ /**
+ * @param request {@link ProjectBuildingRequest}.
+ * @param localRepository The location for the local repository.
+ * @param mavenArtifacts Collection of {@link Artifact MavenArtifacts}
+ * @throws ArtifactInstallerException In case of an error which can be the a given artifact can not be found or the
+ * installation has failed.
+ */
void install( ProjectBuildingRequest request, File localRepository, Collection<Artifact> mavenArtifacts )
- throws ArtifactInstallerException;
-
+ throws ArtifactInstallerException;
+
}
Modified: maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/DefaultDependableCoordinate.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/DefaultDependableCoordinate.java?rev=1794194&r1=1794193&r2=1794194&view=diff
==============================================================================
--- maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/DefaultDependableCoordinate.java (original)
+++ maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/DefaultDependableCoordinate.java Sun May 7 12:27:57 2017
@@ -97,6 +97,9 @@ public class DefaultDependableCoordinate
return groupId;
}
+ /**
+ * @param groupId The groupId to be set.
+ */
public final void setGroupId( String groupId )
{
this.groupId = groupId;
@@ -108,6 +111,9 @@ public class DefaultDependableCoordinate
return artifactId;
}
+ /**
+ * @param artifactId The artifactId to be set.
+ */
public final void setArtifactId( String artifactId )
{
this.artifactId = artifactId;
@@ -119,6 +125,9 @@ public class DefaultDependableCoordinate
return version;
}
+ /**
+ * @param version The version to be set.
+ */
public final void setVersion( String version )
{
this.version = version;
@@ -130,6 +139,9 @@ public class DefaultDependableCoordinate
return type != null ? type : "jar";
}
+ /**
+ * @param type The type to be set.
+ */
public void setType( String type )
{
this.type = type;
@@ -141,6 +153,9 @@ public class DefaultDependableCoordinate
return classifier;
}
+ /**
+ * @param classifier The classifier to be set.
+ */
public final void setClassifier( String classifier )
{
this.classifier = classifier;
Modified: maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/TransferUtils.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/TransferUtils.java?rev=1794194&r1=1794193&r2=1794194&view=diff
==============================================================================
--- maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/TransferUtils.java (original)
+++ maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/TransferUtils.java Sun May 7 12:27:57 2017
@@ -27,10 +27,10 @@ import org.apache.maven.model.Plugin;
import org.apache.maven.model.ReportPlugin;
/**
- * Utility class
+ * Utility class to convert different things like {@link Dependency}, {@link Extension}, {@link Model}, {@link Parent},
+ * {@link Plugin} and {@link ReportPlugin} into {@link DependableCoordinate}.
*
* @author Robert Scholte
- *
*/
public final class TransferUtils
{
@@ -38,6 +38,10 @@ public final class TransferUtils
{
}
+ /**
+ * @param dependency {@link Dependency} to be converted to {@link DependableCoordinate}
+ * @return {@link DependableCoordinate}
+ */
public static DependableCoordinate toDependableCoordinate( Dependency dependency )
{
DefaultDependableCoordinate coordinate = new DefaultDependableCoordinate();
@@ -51,6 +55,10 @@ public final class TransferUtils
return coordinate;
}
+ /**
+ * @param extension {@link Extension} to be converted to {@link DependableCoordinate}
+ * @return {@link DependableCoordinate}
+ */
public static DependableCoordinate toDependableCoordinate( Extension extension )
{
DefaultDependableCoordinate coordinate = new DefaultDependableCoordinate();
@@ -62,6 +70,10 @@ public final class TransferUtils
return coordinate;
}
+ /**
+ * @param model {@link Model} coordinates to be converted to {@link DependableCoordinate}.
+ * @return {@link DependableCoordinate}
+ */
public static DependableCoordinate toDependableCoordinate( Model model )
{
DefaultDependableCoordinate coordinate = new DefaultDependableCoordinate();
@@ -74,6 +86,10 @@ public final class TransferUtils
return coordinate;
}
+ /**
+ * @param parent {@link Parent parent} coordinates to be converted to {@link DependableCoordinate}.
+ * @return {@link DependableCoordinate}.
+ */
public static DependableCoordinate toDependableCoordinate( Parent parent )
{
DefaultDependableCoordinate coordinate = new DefaultDependableCoordinate();
@@ -86,6 +102,10 @@ public final class TransferUtils
return coordinate;
}
+ /**
+ * @param plugin The {@link Plugin plugin} coordiantes which should be converted.
+ * @return {@link DependableCoordinate}.
+ */
public static DependableCoordinate toDependableCoordinate( Plugin plugin )
{
DefaultDependableCoordinate coordinate = new DefaultDependableCoordinate();
@@ -97,6 +117,11 @@ public final class TransferUtils
return coordinate;
}
+ /**
+ * Convert {@link ReportPlugin plugin} coordinates to {@link DependableCoordinate}.
+ * @param plugin The {@link ReportPlugin plugin} to be converted to {@link DependableCoordinate}.
+ * @return The converted {@link DependableCoordinate} coordinates.
+ */
public static DependableCoordinate toDependableCoordinate( ReportPlugin plugin )
{
DefaultDependableCoordinate coordinate = new DefaultDependableCoordinate();
Modified: maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/collect/DependencyCollector.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/collect/DependencyCollector.java?rev=1794194&r1=1794193&r2=1794194&view=diff
==============================================================================
--- maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/collect/DependencyCollector.java (original)
+++ maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/collect/DependencyCollector.java Sun May 7 12:27:57 2017
@@ -44,9 +44,23 @@ public interface DependencyCollector
CollectorResult collectDependencies( ProjectBuildingRequest buildingRequest, Dependency root )
throws DependencyCollectorException;
+ /**
+ * @param buildingRequest {@link ProjectBuildingRequest}.
+ * @param root {@link DependableCoordinate}
+ * @return {@link CollectorResult}
+ * @throws DependencyCollectorException in case of an error which can be a component lookup error or
+ * an error while trying to look up the dependencies.
+ */
CollectorResult collectDependencies( ProjectBuildingRequest buildingRequest, DependableCoordinate root )
throws DependencyCollectorException;
+ /**
+ * @param buildingRequest {@link ProjectBuildingRequest}.
+ * @param root {@link Model}
+ * @return {@link CollectorResult}
+ * @throws DependencyCollectorException in case of an error which can be a component lookup error or
+ * an error while trying to look up the dependencies.
+ */
CollectorResult collectDependencies( ProjectBuildingRequest buildingRequest, Model root )
throws DependencyCollectorException;
Modified: maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/resolve/DependencyResolver.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/resolve/DependencyResolver.java?rev=1794194&r1=1794193&r2=1794194&view=diff
==============================================================================
--- maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/resolve/DependencyResolver.java (original)
+++ maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/resolve/DependencyResolver.java Sun May 7 12:27:57 2017
@@ -29,13 +29,13 @@ import org.apache.maven.shared.artifact.
import org.apache.maven.shared.dependencies.DependableCoordinate;
/**
- *
+ * @author Robert Scholte
*/
public interface DependencyResolver
{
/**
- * This will resolve the dependencies of the coordinate, not resolving the the artifact of the coordinate itself.
- * If the coordinate needs to be resolved too, use
+ * This will resolve the dependencies of the coordinate, not resolving the the artifact of the coordinate itself. If
+ * the coordinate needs to be resolved too, use
* {@link #resolveDependencies(ProjectBuildingRequest, Collection, Collection, TransformableFilter)} passing
* {@code Collections.singletonList(coordinate)}
*
@@ -45,13 +45,25 @@ public interface DependencyResolver
* @return the resolved dependencies.
* @throws DependencyResolverException in case of an error.
*/
- Iterable<ArtifactResult> resolveDependencies( ProjectBuildingRequest buildingRequest,
- DependableCoordinate coordinate,
- TransformableFilter filter ) throws DependencyResolverException;
-
- Iterable<ArtifactResult> resolveDependencies( ProjectBuildingRequest buildingRequest,
- Model model,
- TransformableFilter filter ) throws DependencyResolverException;
+ Iterable<ArtifactResult> resolveDependencies( ProjectBuildingRequest buildingRequest,
+ DependableCoordinate coordinate, TransformableFilter filter )
+ throws DependencyResolverException;
+
+ /**
+ * This will resolve the dependencies of the coordinate, not resolving the the artifact of the coordinate itself. If
+ * the coordinate needs to be resolved too, use
+ * {@link #resolveDependencies(ProjectBuildingRequest, Collection, Collection, TransformableFilter)} passing
+ * {@code Collections.singletonList(coordinate)}
+ *
+ * @param buildingRequest {@link ProjectBuildingRequest}
+ * @param model {@link Model}
+ * @param filter {@link TransformableFilter}
+ * @return the resolved dependencies.
+ * @throws DependencyResolverException in case of an error.
+ */
+ Iterable<ArtifactResult> resolveDependencies( ProjectBuildingRequest buildingRequest, Model model,
+ TransformableFilter filter )
+ throws DependencyResolverException;
/**
* @param buildingRequest the project building request, never {@code null}
@@ -64,5 +76,6 @@ public interface DependencyResolver
Iterable<ArtifactResult> resolveDependencies( ProjectBuildingRequest buildingRequest,
Collection<Dependency> dependencies,
Collection<Dependency> managedDependencies,
- TransformableFilter filter ) throws DependencyResolverException;
+ TransformableFilter filter )
+ throws DependencyResolverException;
}
Modified: maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/resolve/DependencyResolverException.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/resolve/DependencyResolverException.java?rev=1794194&r1=1794193&r2=1794194&view=diff
==============================================================================
--- maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/resolve/DependencyResolverException.java (original)
+++ maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/resolve/DependencyResolverException.java Sun May 7 12:27:57 2017
@@ -20,21 +20,33 @@ package org.apache.maven.shared.dependen
*/
/**
- *
+ * The Exception class in case a resolving does not work.
*/
public class DependencyResolverException
extends Exception
{
+ private static final long serialVersionUID = 5320065249974323888L;
+
+ /**
+ * @param cause The {@link Exception cause} of the problem.
+ */
protected DependencyResolverException( Exception cause )
{
super( cause );
}
+ /**
+ * @param message The message to give.
+ * @param e The {@link Exception}.
+ */
public DependencyResolverException( String message, Exception e )
{
super( message, e );
}
-
+
+ /**
+ * @return {@link DependencyResult}
+ */
public DependencyResult getResult()
{
return null;
Modified: maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/resolve/DependencyResult.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/resolve/DependencyResult.java?rev=1794194&r1=1794193&r2=1794194&view=diff
==============================================================================
--- maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/resolve/DependencyResult.java (original)
+++ maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/dependencies/resolve/DependencyResult.java Sun May 7 12:27:57 2017
@@ -31,7 +31,7 @@ public interface DependencyResult
/**
* Gets the exceptions that occurred while building the dependency graph.
*
- * @return
+ * @return The list of exceptions {@link Exception}.
*/
List<Exception> getCollectorExceptions();
}
Modified: maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployer.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployer.java?rev=1794194&r1=1794193&r2=1794194&view=diff
==============================================================================
--- maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployer.java (original)
+++ maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployer.java Sun May 7 12:27:57 2017
@@ -56,9 +56,9 @@ public interface ProjectDeployer
* appropriate remote repository.
*
* <pre class="java">
- * @Parameter( defaultValue = "${session}", required=true, readonly = true)
+ * @Parameter( defaultValue = "${session}", required=true, readonly = true)
* MavenSession session;
- * @Parameter( defaultValue = "${project}", required=true, readonly = true)
+ * @Parameter( defaultValue = "${project}", required=true, readonly = true)
* MavenProject project;
* ..
* @Component
@@ -78,6 +78,7 @@ public interface ProjectDeployer
* @throws IOException In case of problems related to checksums.
* @throws NoFileAssignedException In case of missing file which has not been assigned to project.
*/
+ //FIXME: Need to check to remove IOException cause it looks like it's not being thrown by code.
void deploy( ProjectBuildingRequest buildingRequest, ProjectDeployerRequest request,
ArtifactRepository artifactRepository )
throws IOException, NoFileAssignedException;
Modified: maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployerRequest.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployerRequest.java?rev=1794194&r1=1794193&r2=1794194&view=diff
==============================================================================
--- maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployerRequest.java (original)
+++ maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployerRequest.java Sun May 7 12:27:57 2017
@@ -53,11 +53,12 @@ public class ProjectDeployerRequest
}
/**
- * @param updateReleaseInfo the updateReleaseInfo to set
+ * @param theUpdateReleaseInfoToBeSet the updateReleaseInfo to set
+ * @return {@link ProjectDeployerRequest} for chaining.
*/
- public ProjectDeployerRequest setUpdateReleaseInfo( boolean updateReleaseInfo )
+ public ProjectDeployerRequest setUpdateReleaseInfo( boolean theUpdateReleaseInfoToBeSet )
{
- this.updateReleaseInfo = updateReleaseInfo;
+ this.updateReleaseInfo = theUpdateReleaseInfoToBeSet;
return this;
}
@@ -70,11 +71,12 @@ public class ProjectDeployerRequest
}
/**
- * @param retryFailedDeploymentCount the retryFailedDeploymentCount to set
+ * @param theRetryFailedDeploymentCountToBeSet the retryFailedDeploymentCount to set
+ * @return {@link ProjectDeployerRequest} for chaining.
*/
- public ProjectDeployerRequest setRetryFailedDeploymentCount( int retryFailedDeploymentCount )
+ public ProjectDeployerRequest setRetryFailedDeploymentCount( int theRetryFailedDeploymentCountToBeSet )
{
- this.retryFailedDeploymentCount = retryFailedDeploymentCount;
+ this.retryFailedDeploymentCount = theRetryFailedDeploymentCountToBeSet;
return this;
}
@@ -87,11 +89,12 @@ public class ProjectDeployerRequest
}
/**
- * @param project the project to set
+ * @param theProjectToBeSet the {link {@link MavenProject project} to set
+ * @return {@link ProjectDeployerRequest} for chaining.
*/
- public ProjectDeployerRequest setProject( MavenProject project )
+ public ProjectDeployerRequest setProject( MavenProject theProjectToBeSet )
{
- this.project = project;
+ this.project = theProjectToBeSet;
return this;
}
@@ -104,11 +107,12 @@ public class ProjectDeployerRequest
}
/**
- * @param altDeploymentRepository the altDeploymentRepository to set
+ * @param theAltDeploymentRepositoryToBeSet the altDeploymentRepository to set
+ * @return {@link ProjectDeployerRequest} for chaining.
*/
- public ProjectDeployerRequest setAltDeploymentRepository( String altDeploymentRepository )
+ public ProjectDeployerRequest setAltDeploymentRepository( String theAltDeploymentRepositoryToBeSet )
{
- this.altDeploymentRepository = altDeploymentRepository;
+ this.altDeploymentRepository = theAltDeploymentRepositoryToBeSet;
return this;
}
@@ -121,11 +125,12 @@ public class ProjectDeployerRequest
}
/**
- * @param altSnapshotDeploymentRepository the altSnapshotDeploymentRepository to set
+ * @param theAltSnapshotDeploymentRepositoryToBeSet the altSnapshotDeploymentRepository to set
+ * @return {@link ProjectDeployerRequest} for chaining.
*/
- public ProjectDeployerRequest setAltSnapshotDeploymentRepository( String altSnapshotDeploymentRepository )
+ public ProjectDeployerRequest setAltSnapshotDeploymentRepository( String theAltSnapshotDeploymentRepositoryToBeSet )
{
- this.altSnapshotDeploymentRepository = altSnapshotDeploymentRepository;
+ this.altSnapshotDeploymentRepository = theAltSnapshotDeploymentRepositoryToBeSet;
return this;
}
@@ -138,11 +143,12 @@ public class ProjectDeployerRequest
}
/**
- * @param altReleaseDeploymentRepository the altReleaseDeploymentRepository to set
+ * @param theAltReleaseDeploymentRepositoryToBeSet the altReleaseDeploymentRepository to set
+ * @return {@link ProjectDeployerRequest} for chaining.
*/
- public ProjectDeployerRequest setAltReleaseDeploymentRepository( String altReleaseDeploymentRepository )
+ public ProjectDeployerRequest setAltReleaseDeploymentRepository( String theAltReleaseDeploymentRepositoryToBeSet )
{
- this.altReleaseDeploymentRepository = altReleaseDeploymentRepository;
+ this.altReleaseDeploymentRepository = theAltReleaseDeploymentRepositoryToBeSet;
return this;
}
}
Modified: maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/internal/DefaultProjectDeployer.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/internal/DefaultProjectDeployer.java?rev=1794194&r1=1794193&r2=1794194&view=diff
==============================================================================
--- maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/internal/DefaultProjectDeployer.java (original)
+++ maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/deploy/internal/DefaultProjectDeployer.java Sun May 7 12:27:57 2017
@@ -62,7 +62,7 @@ public class DefaultProjectDeployer
* @param request {@link ProjectDeployerRequest}
* @param artifactRepository {@link ArtifactRepository}
* @throws IllegalArgumentException in case of artifact is not correctly assigned.
- * @throws NoFileAssignedException
+ * @throws NoFileAssignedException In case no file has been assigned to main file.
*/
public void deploy( ProjectBuildingRequest buildingRequest, ProjectDeployerRequest request,
ArtifactRepository artifactRepository )
Modified: maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/install/ProjectInstallerRequest.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/install/ProjectInstallerRequest.java?rev=1794194&r1=1794193&r2=1794194&view=diff
==============================================================================
--- maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/install/ProjectInstallerRequest.java (original)
+++ maven/shared/trunk/maven-artifact-transfer/src/main/java/org/apache/maven/shared/project/install/ProjectInstallerRequest.java Sun May 7 12:27:57 2017
@@ -45,11 +45,12 @@ public class ProjectInstallerRequest
}
/**
- * @param createChecksum the createChecksum to set
+ * @param theCreateChecksumToBeSet the createChecksum to set
+ * @return {@link ProjectInstallerRequest} for chaining.
*/
- public ProjectInstallerRequest setCreateChecksum( boolean createChecksum )
+ public ProjectInstallerRequest setCreateChecksum( boolean theCreateChecksumToBeSet )
{
- this.createChecksum = createChecksum;
+ this.createChecksum = theCreateChecksumToBeSet;
return this;
}
@@ -62,11 +63,12 @@ public class ProjectInstallerRequest
}
/**
- * @param updateReleaseInfo the updateReleaseInfo to set
+ * @param theUpdateReleaseInfoToBeSet the updateReleaseInfo to set
+ * @return {@link ProjectInstallerRequest} for chaining.
*/
- public ProjectInstallerRequest setUpdateReleaseInfo( boolean updateReleaseInfo )
+ public ProjectInstallerRequest setUpdateReleaseInfo( boolean theUpdateReleaseInfoToBeSet )
{
- this.updateReleaseInfo = updateReleaseInfo;
+ this.updateReleaseInfo = theUpdateReleaseInfoToBeSet;
return this;
}
@@ -79,11 +81,12 @@ public class ProjectInstallerRequest
}
/**
- * @param project the project to set
+ * @param theProjectToBeSet the project to set
+ * @return {@link ProjectInstallerRequest} for chaining.
*/
- public ProjectInstallerRequest setProject( MavenProject project )
+ public ProjectInstallerRequest setProject( MavenProject theProjectToBeSet )
{
- this.project = project;
+ this.project = theProjectToBeSet;
return this;
}