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.project;
20
21 import java.io.File;
22 import java.util.List;
23
24 import org.apache.maven.model.building.ModelProblem;
25
26 /**
27 * Collects the output of the project builder.
28 *
29 * @author Benjamin Bentmann
30 */
31 public interface ProjectBuildingResult {
32
33 /**
34 * Gets the identifier of the project that could not be built. The general format of the identifier is {@code
35 * <groupId>:<artifactId>:<version>} but some of these coordinates may still be unknown at the point the exception
36 * is thrown so this information is merely meant to assist the user.
37 *
38 * @return The identifier of the project or an empty string if not known, never {@code null}.
39 */
40 String getProjectId();
41
42 /**
43 * Gets the POM file from which the project was built.
44 *
45 * @return The POM file or {@code null} if unknown.
46 */
47 File getPomFile();
48
49 /**
50 * Gets the project that was built.
51 *
52 * @return The project that was built or {@code null} if an error occurred and this result accompanies a
53 * {@link ProjectBuildingException}.
54 */
55 MavenProject getProject();
56
57 /**
58 * Gets the problems that were encountered during the project building.
59 *
60 * @return The problems that were encountered during the project building, can be empty but never {@code null}.
61 */
62 List<ModelProblem> getProblems();
63
64 /**
65 * Gets the result of the dependency resolution for the project.
66 *
67 * @return The result of the dependency resolution for the project or {@code null} if the project dependencies were
68 * not requested.
69 */
70 DependencyResolutionResult getDependencyResolutionResult();
71 }