You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by rf...@apache.org on 2020/06/20 09:33:40 UTC
[maven] 27/31: Rename interface and implementation
This is an automated email from the ASF dual-hosted git repository.
rfscholte pushed a commit to branch MNG-5760
in repository https://gitbox.apache.org/repos/asf/maven.git
commit 94b546997511a856ebeea2c6571311701104c4e3
Author: Maarten Mulders <ma...@infosupport.com>
AuthorDate: Wed Jun 17 14:43:41 2020 +0200
Rename interface and implementation
---
maven-core/src/main/java/org/apache/maven/DefaultMaven.java | 8 ++++----
.../{BuildResumer.java => BuildResumptionDataRepository.java} | 6 +++---
.../maven/execution/BuildResumptionPersistenceException.java | 2 +-
...uildResumer.java => DefaultBuildResumptionDataRepository.java} | 6 +++---
.../java/org/apache/maven/execution/MavenExecutionResult.java | 4 ++--
.../src/main/java/org/apache/maven/graph/DefaultGraphBuilder.java | 6 +++---
...merTest.java => DefaultBuildResumptionDataRepositoryTest.java} | 4 ++--
maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java | 6 +++---
8 files changed, 21 insertions(+), 21 deletions(-)
diff --git a/maven-core/src/main/java/org/apache/maven/DefaultMaven.java b/maven-core/src/main/java/org/apache/maven/DefaultMaven.java
index 5c7c9ea..ad5aad7 100644
--- a/maven-core/src/main/java/org/apache/maven/DefaultMaven.java
+++ b/maven-core/src/main/java/org/apache/maven/DefaultMaven.java
@@ -36,7 +36,7 @@ import javax.inject.Named;
import javax.inject.Singleton;
import org.apache.maven.artifact.ArtifactUtils;
-import org.apache.maven.execution.BuildResumer;
+import org.apache.maven.execution.BuildResumptionDataRepository;
import org.apache.maven.execution.BuildResumptionPersistenceException;
import org.apache.maven.execution.DefaultMavenExecutionResult;
import org.apache.maven.execution.ExecutionEvent;
@@ -103,7 +103,7 @@ public class DefaultMaven
private GraphBuilder graphBuilder;
@Inject
- private BuildResumer buildResumer;
+ private BuildResumptionDataRepository buildResumptionDataRepository;
@Override
public MavenExecutionResult execute( MavenExecutionRequest request )
@@ -327,7 +327,7 @@ public class DefaultMaven
session.getAllProjects().stream()
.filter( MavenProject::isExecutionRoot )
.findFirst()
- .ifPresent( buildResumer::removeResumptionData );
+ .ifPresent( buildResumptionDataRepository::removeResumptionData );
}
}
finally
@@ -378,7 +378,7 @@ public class DefaultMaven
{
try
{
- boolean persistenceResult = buildResumer.persistResumptionData( result, rootProject );
+ boolean persistenceResult = buildResumptionDataRepository.persistResumptionData( result, rootProject );
result.setCanResume( persistenceResult );
}
catch ( BuildResumptionPersistenceException e )
diff --git a/maven-core/src/main/java/org/apache/maven/execution/BuildResumer.java b/maven-core/src/main/java/org/apache/maven/execution/BuildResumptionDataRepository.java
similarity index 88%
rename from maven-core/src/main/java/org/apache/maven/execution/BuildResumer.java
rename to maven-core/src/main/java/org/apache/maven/execution/BuildResumptionDataRepository.java
index 8de72ca..8733819 100644
--- a/maven-core/src/main/java/org/apache/maven/execution/BuildResumer.java
+++ b/maven-core/src/main/java/org/apache/maven/execution/BuildResumptionDataRepository.java
@@ -22,11 +22,11 @@ package org.apache.maven.execution;
import org.apache.maven.project.MavenProject;
/**
- * This class describes most of the logic needed for the --resume / -r feature. Its goal is to ensure newer
- * builds of the same project that have the -r command-line flag skip successfully built projects during earlier
+ * Instances of this interface retrieve and store data for the --resume / -r feature. This data is used to ensure newer
+ * builds of the same project, that have the -r command-line flag, skip successfully built projects during earlier
* invocations of Maven.
*/
-public interface BuildResumer
+public interface BuildResumptionDataRepository
{
/**
* Persists any data needed to resume the build at a later point in time, using a new Maven invocation. This method
diff --git a/maven-core/src/main/java/org/apache/maven/execution/BuildResumptionPersistenceException.java b/maven-core/src/main/java/org/apache/maven/execution/BuildResumptionPersistenceException.java
index 2d2852f..1f9e802 100644
--- a/maven-core/src/main/java/org/apache/maven/execution/BuildResumptionPersistenceException.java
+++ b/maven-core/src/main/java/org/apache/maven/execution/BuildResumptionPersistenceException.java
@@ -21,7 +21,7 @@ package org.apache.maven.execution;
/**
* This exception will be thrown when something fails while persisting build resumption data.
- * @see BuildResumer#persistResumptionData
+ * @see BuildResumptionDataRepository#persistResumptionData
*/
public class BuildResumptionPersistenceException extends Exception
{
diff --git a/maven-core/src/main/java/org/apache/maven/execution/DefaultBuildResumer.java b/maven-core/src/main/java/org/apache/maven/execution/DefaultBuildResumptionDataRepository.java
similarity index 97%
rename from maven-core/src/main/java/org/apache/maven/execution/DefaultBuildResumer.java
rename to maven-core/src/main/java/org/apache/maven/execution/DefaultBuildResumptionDataRepository.java
index 84a6ded..e6815ce 100644
--- a/maven-core/src/main/java/org/apache/maven/execution/DefaultBuildResumer.java
+++ b/maven-core/src/main/java/org/apache/maven/execution/DefaultBuildResumptionDataRepository.java
@@ -44,18 +44,18 @@ import java.util.stream.Collectors;
import static java.util.Comparator.comparing;
/**
- * This implementation of {@link BuildResumer} persists information in a properties file. The file is stored
+ * This implementation of {@link BuildResumptionDataRepository} persists information in a properties file. The file is stored
* in the build output directory under the Maven execution root.
*/
@Named
@Singleton
-public class DefaultBuildResumer implements BuildResumer
+public class DefaultBuildResumptionDataRepository implements BuildResumptionDataRepository
{
private static final String RESUME_PROPERTIES_FILENAME = "resume.properties";
private static final String RESUME_FROM_PROPERTY = "resumeFrom";
private static final String EXCLUDED_PROJECTS_PROPERTY = "excludedProjects";
private static final String PROPERTY_DELIMITER = ", ";
- private static final Logger LOGGER = LoggerFactory.getLogger( DefaultBuildResumer.class );
+ private static final Logger LOGGER = LoggerFactory.getLogger( DefaultBuildResumptionDataRepository.class );
@Override
public boolean persistResumptionData( MavenExecutionResult result, MavenProject rootProject )
diff --git a/maven-core/src/main/java/org/apache/maven/execution/MavenExecutionResult.java b/maven-core/src/main/java/org/apache/maven/execution/MavenExecutionResult.java
index 285aab0..8a099bb 100644
--- a/maven-core/src/main/java/org/apache/maven/execution/MavenExecutionResult.java
+++ b/maven-core/src/main/java/org/apache/maven/execution/MavenExecutionResult.java
@@ -70,7 +70,7 @@ public interface MavenExecutionResult
/**
* Indicates whether or not the build could be resumed by a second invocation of Maven.
- * @see org.apache.maven.execution.BuildResumer
+ * @see BuildResumptionDataRepository
* @return <code>true</code> when it is possible to resume the build, <code>false</code> otherwise.
*/
boolean canResume();
@@ -78,7 +78,7 @@ public interface MavenExecutionResult
/**
* Indicate that the build can or cannot be resumed by a second invocation of Maven.
* @param canResume <code>true</code> when it is possible to resume the build, <code>false</code> otherwise.
- * @see org.apache.maven.execution.BuildResumer
+ * @see BuildResumptionDataRepository
* @see #canResume()
*/
void setCanResume( boolean canResume );
diff --git a/maven-core/src/main/java/org/apache/maven/graph/DefaultGraphBuilder.java b/maven-core/src/main/java/org/apache/maven/graph/DefaultGraphBuilder.java
index 1d19c03..07cb80e 100644
--- a/maven-core/src/main/java/org/apache/maven/graph/DefaultGraphBuilder.java
+++ b/maven-core/src/main/java/org/apache/maven/graph/DefaultGraphBuilder.java
@@ -38,7 +38,7 @@ import org.apache.maven.DefaultMaven;
import org.apache.maven.MavenExecutionException;
import org.apache.maven.ProjectCycleException;
import org.apache.maven.artifact.ArtifactUtils;
-import org.apache.maven.execution.BuildResumer;
+import org.apache.maven.execution.BuildResumptionDataRepository;
import org.apache.maven.execution.MavenExecutionRequest;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.execution.ProjectDependencyGraph;
@@ -75,7 +75,7 @@ public class DefaultGraphBuilder
protected ProjectBuilder projectBuilder;
@Inject
- private BuildResumer buildResumer;
+ private BuildResumptionDataRepository buildResumptionDataRepository;
@Override
public Result<ProjectDependencyGraph> build( MavenSession session )
@@ -354,7 +354,7 @@ public class DefaultGraphBuilder
.filter( MavenProject::isExecutionRoot )
.findFirst()
.ifPresent( rootProject ->
- buildResumer.applyResumptionData( request, rootProject ) );
+ buildResumptionDataRepository.applyResumptionData( request, rootProject ) );
}
}
diff --git a/maven-core/src/test/java/org/apache/maven/execution/DefaultBuildResumerTest.java b/maven-core/src/test/java/org/apache/maven/execution/DefaultBuildResumptionDataRepositoryTest.java
similarity index 97%
rename from maven-core/src/test/java/org/apache/maven/execution/DefaultBuildResumerTest.java
rename to maven-core/src/test/java/org/apache/maven/execution/DefaultBuildResumptionDataRepositoryTest.java
index 0664cb4..279fb11 100644
--- a/maven-core/src/test/java/org/apache/maven/execution/DefaultBuildResumerTest.java
+++ b/maven-core/src/test/java/org/apache/maven/execution/DefaultBuildResumptionDataRepositoryTest.java
@@ -38,9 +38,9 @@ import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.is;
@RunWith( MockitoJUnitRunner.class )
-public class DefaultBuildResumerTest
+public class DefaultBuildResumptionDataRepositoryTest
{
- private final DefaultBuildResumer buildResumer = new DefaultBuildResumer();
+ private final DefaultBuildResumptionDataRepository buildResumer = new DefaultBuildResumptionDataRepository();
private MavenExecutionResult result;
diff --git a/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java b/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java
index 5bf6b32..4136a1e 100644
--- a/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java
+++ b/maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java
@@ -48,7 +48,7 @@ import org.apache.maven.eventspy.internal.EventSpyDispatcher;
import org.apache.maven.exception.DefaultExceptionHandler;
import org.apache.maven.exception.ExceptionHandler;
import org.apache.maven.exception.ExceptionSummary;
-import org.apache.maven.execution.BuildResumer;
+import org.apache.maven.execution.BuildResumptionDataRepository;
import org.apache.maven.execution.DefaultMavenExecutionRequest;
import org.apache.maven.execution.ExecutionListener;
import org.apache.maven.execution.MavenExecutionRequest;
@@ -169,7 +169,7 @@ public class MavenCli
private Map<String, ConfigurationProcessor> configurationProcessors;
- private BuildResumer buildResumer;
+ private BuildResumptionDataRepository buildResumptionDataRepository;
public MavenCli()
{
@@ -708,7 +708,7 @@ public class MavenCli
dispatcher = (DefaultSecDispatcher) container.lookup( SecDispatcher.class, "maven" );
- buildResumer = container.lookup( BuildResumer.class );
+ buildResumptionDataRepository = container.lookup( BuildResumptionDataRepository.class );
return container;
}