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 java.util.List;
22
23 import org.apache.maven.project.DependencyResolutionResult;
24 import org.apache.maven.project.MavenProject;
25
26 /**
27 * @author Jason van Zyl
28 */
29 public interface MavenExecutionResult {
30 MavenExecutionResult setProject(MavenProject project);
31
32 MavenProject getProject();
33
34 MavenExecutionResult setTopologicallySortedProjects(List<MavenProject> projects);
35
36 /**
37 * @return the sorted list, or an empty list if there are no projects.
38 */
39 List<MavenProject> getTopologicallySortedProjects();
40
41 MavenExecutionResult setDependencyResolutionResult(DependencyResolutionResult result);
42
43 DependencyResolutionResult getDependencyResolutionResult();
44
45 // for each exception
46 // - knowing what artifacts are missing
47 // - project building exception
48 // - invalid project model exception: list of markers
49 // - xmlpull parser exception
50 List<Throwable> getExceptions();
51
52 MavenExecutionResult addException(Throwable e);
53
54 boolean hasExceptions();
55
56 /**
57 * Gets the build summary for the specified project.
58 *
59 * @param project The project to get the build summary for, must not be {@code null}.
60 * @return The build summary for the project or {@code null} if the project has not been built (yet).
61 */
62 BuildSummary getBuildSummary(MavenProject project);
63
64 /**
65 * Add the specified build summary.
66 *
67 * @param summary The build summary to add, must not be {@code null}.
68 */
69 void addBuildSummary(BuildSummary summary);
70
71 /**
72 * Indicates whether or not the build could be resumed by a second invocation of Maven.
73 * @see BuildResumptionDataRepository
74 * @return <code>true</code> when it is possible to resume the build, <code>false</code> otherwise.
75 */
76 boolean canResume();
77
78 /**
79 * Indicate that the build can or cannot be resumed by a second invocation of Maven.
80 * @param canResume <code>true</code> when it is possible to resume the build, <code>false</code> otherwise.
81 * @see BuildResumptionDataRepository
82 * @see #canResume()
83 */
84 void setCanResume(boolean canResume);
85 }