View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.execution;
20  
21  import org.apache.maven.project.MavenProject;
22  
23  /**
24   * Instances of this interface retrieve and store data for the --resume / -r feature. This data is used to ensure newer
25   * builds of the same project, that have the -r command-line flag, skip successfully built projects during earlier
26   * invocations of Maven.
27   */
28  public interface BuildResumptionDataRepository {
29      /**
30       * Persists any data needed to resume the build at a later point in time, using a new Maven invocation. This method
31       * may also decide it is not needed or meaningful to persist such data, and return <code>false</code> to indicate
32       * so.
33       *
34       * @param rootProject The root project that is being built.
35       * @param buildResumptionData Information needed to resume the build.
36       * @throws BuildResumptionPersistenceException When an error occurs while persisting data.
37       */
38      void persistResumptionData(MavenProject rootProject, BuildResumptionData buildResumptionData)
39              throws BuildResumptionPersistenceException;
40  
41      /**
42       * Uses previously stored resumption data to enrich an existing execution request.
43       * @param request The execution request that will be enriched.
44       * @param rootProject The root project that is being built.
45       */
46      void applyResumptionData(MavenExecutionRequest request, MavenProject rootProject);
47  
48      /**
49       * Removes previously stored resumption data.
50       * @param rootProject The root project that is being built.
51       */
52      void removeResumptionData(MavenProject rootProject);
53  }