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