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