Consistently renamed methods in interfaces
ProjectDeployer from deployProject() into deploy().
ProjectInstaller from installProject() into install().
git-svn-id: https://svn.apache.org/repos/asf/maven/shared/trunk@1761800 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployer.java b/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployer.java
index d08a1b7..dbbebd0 100644
--- a/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployer.java
+++ b/src/main/java/org/apache/maven/shared/project/deploy/ProjectDeployer.java
@@ -56,19 +56,20 @@
* appropriate remote repository.
*
* <pre class="java">
- * ..
+ * @Parameter( defaultValue = "${session}", required=true, readonly = true)
* MavenSession session;
+ * @Parameter( defaultValue = "${project}", required=true, readonly = true)
* MavenProject project;
* ..
- * @Inject
+ * @Component
* ProjectDeployer deployer;
*
- * ProjectBuildingRequest pbr =
- * new ProjectBuildingRequest()
- * .setProject (project)
- * .setUpdateReleaseInfo( true );
- *
- * deployer.deploy (session.getProjectBuildingRequest(), pbr, artifactRepository);
+ * ProjectDeployerRequest pdr =
+ * new ProjectDeployerRequest()
+ * .setProject (project)
+ * .setUpdateReleaseInfo( true );
+ *
+ * deployer.deploy (session.getProjectBuildingRequest(), pdr, artifactRepository);
* </pre>
*
* @param buildingRequest {@link ProjectBuildingRequest}
@@ -77,7 +78,7 @@
* @throws IOException In case of problems related to checksums.
* @throws NoFileAssignedException In case of missing file which has not been assigned to project.
*/
- void deployProject( ProjectBuildingRequest buildingRequest, ProjectDeployerRequest request,
+ void deploy( ProjectBuildingRequest buildingRequest, ProjectDeployerRequest request,
ArtifactRepository artifactRepository )
throws IOException, NoFileAssignedException;
diff --git a/src/main/java/org/apache/maven/shared/project/deploy/internal/DefaultProjectDeployer.java b/src/main/java/org/apache/maven/shared/project/deploy/internal/DefaultProjectDeployer.java
index 47a411c..bac0e9b 100644
--- a/src/main/java/org/apache/maven/shared/project/deploy/internal/DefaultProjectDeployer.java
+++ b/src/main/java/org/apache/maven/shared/project/deploy/internal/DefaultProjectDeployer.java
@@ -42,8 +42,9 @@
/**
* This will deploy a whole project into the appropriate remote repository.
*
- * @author Karl Heinz Marbaise <a href="mailto:khmarbaise@apache.org">khmarbaise@apache.org</a> Most of the code is
- * taken from maven-dependency-plugin.
+ * @author Karl Heinz Marbaise <a href="mailto:khmarbaise@apache.org">khmarbaise@apache.org</a>
+ *
+ * Most of the code is taken from maven-deploy-plugin.
*/
@Component( role = ProjectDeployer.class )
public class DefaultProjectDeployer
@@ -61,13 +62,12 @@
* @param request {@link ProjectDeployerRequest}
* @param artifactRepository {@link ArtifactRepository}
* @throws IllegalArgumentException in case of artifact is not correctly assigned.
- * @throws NoFileAssignedException
+ * @throws NoFileAssignedException
*/
- public void deployProject( ProjectBuildingRequest buildingRequest, ProjectDeployerRequest request,
- ArtifactRepository artifactRepository )
+ public void deploy( ProjectBuildingRequest buildingRequest, ProjectDeployerRequest request,
+ ArtifactRepository artifactRepository )
throws IOException, NoFileAssignedException
{
- List<Artifact> deployableArtifacts = new ArrayList<Artifact>();
Artifact artifact = request.getProject().getArtifact();
String packaging = request.getProject().getPackaging();
@@ -98,6 +98,7 @@
try
{
+ List<Artifact> deployableArtifacts = new ArrayList<Artifact>();
if ( isPomArtifact )
{
deployableArtifacts.add( artifact );
diff --git a/src/main/java/org/apache/maven/shared/project/install/ProjectInstaller.java b/src/main/java/org/apache/maven/shared/project/install/ProjectInstaller.java
index 28719a9..626bcf3 100644
--- a/src/main/java/org/apache/maven/shared/project/install/ProjectInstaller.java
+++ b/src/main/java/org/apache/maven/shared/project/install/ProjectInstaller.java
@@ -37,6 +37,25 @@
* This will install a single project which may contain several artifacts. Those artifacts will be installed into
* the appropriate repository.
*
+ * <pre class="java">
+ * @Parameter( defaultValue = "${session}", required=true, readonly = true)
+ * MavenSession session;
+ * @Parameter( defaultValue = "${project}", required=true, readonly = true)
+ * MavenProject project;
+ * ..
+ * @Component
+ * ProjectInstaller installer;
+ *
+ * ProjectInstallerRequest pir =
+ * new ProjectInstallerRequest()
+ * .setProject( mavenProject )
+ * .setCreateChecksum( false )
+ * .setUpdateReleaseInfo( false );
+ *
+ * installer.install (session.getProjectBuildingRequest(), pir, artifactRepository);
+ * </pre>
+ *
+ *
* @param projectBuildingRequest {@link ProjectBuildingRequest}
* @param projectInstallerRequest {@link ProjectInstallerRequest}
* @param artifactRepository {@link ArtifactRepository}
@@ -44,7 +63,7 @@
* @throws ArtifactInstallerException In case of problems to install artifacts.
* @throws NoFileAssignedException If no file has been assigned to the project.
*/
- void installProject( ProjectBuildingRequest projectBuildingRequest, ProjectInstallerRequest projectInstallerRequest,
+ void install( ProjectBuildingRequest projectBuildingRequest, ProjectInstallerRequest projectInstallerRequest,
ArtifactRepository artifactRepository )
throws IOException, ArtifactInstallerException, NoFileAssignedException;
diff --git a/src/main/java/org/apache/maven/shared/project/install/internal/DefaultProjectInstaller.java b/src/main/java/org/apache/maven/shared/project/install/internal/DefaultProjectInstaller.java
index acf56aa..0891fb6 100644
--- a/src/main/java/org/apache/maven/shared/project/install/internal/DefaultProjectInstaller.java
+++ b/src/main/java/org/apache/maven/shared/project/install/internal/DefaultProjectInstaller.java
@@ -68,7 +68,7 @@
/**
* {@inheritDoc}
*/
- public void installProject( ProjectBuildingRequest buildingRequest, ProjectInstallerRequest request,
+ public void install( ProjectBuildingRequest buildingRequest, ProjectInstallerRequest request,
ArtifactRepository artifactRepository )
throws IOException, ArtifactInstallerException, NoFileAssignedException
{
diff --git a/src/main/java/org/apache/maven/shared/project/install/internal/DualDigester.java b/src/main/java/org/apache/maven/shared/project/install/internal/DualDigester.java
index 4902bc9..000bf65 100644
--- a/src/main/java/org/apache/maven/shared/project/install/internal/DualDigester.java
+++ b/src/main/java/org/apache/maven/shared/project/install/internal/DualDigester.java
@@ -37,7 +37,10 @@
*
* @author Kristian Rosenvold
*/
-public class DualDigester
+//TODO: Think about this class if we could use the ChecksumUtils class of
+// aether-util ? I think we need to go via reflection.
+//
+class DualDigester
{
private final MessageDigest md5 = getDigester( "MD5" );