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.api.services;
20
21 import java.nio.file.Path;
22 import java.util.Collection;
23 import java.util.Optional;
24 import org.apache.maven.api.Project;
25 import org.apache.maven.api.annotations.Experimental;
26 import org.apache.maven.api.annotations.Nonnull;
27
28 /**
29 * Result of a project build call.
30 *
31 * @since 4.0
32 */
33 @Experimental
34 public interface ProjectBuilderResult {
35
36 /**
37 * Gets the identifier of the project that could not be built. The general format of the identifier is {@code
38 * <groupId>:<artifactId>:<version>} but some of these coordinates may still be unknown at the point the exception
39 * is thrown so this information is merely meant to assist the user.
40 *
41 * @return the identifier of the project or an empty string if not known, never {@code null}
42 */
43 @Nonnull
44 String getProjectId();
45
46 /**
47 * Gets the POM file from which the project was built.
48 *
49 * @return the optional POM file
50 */
51 @Nonnull
52 Optional<Path> getPomFile();
53
54 /**
55 * Gets the project that was built.
56 *
57 * @return The project that was built or {@code null} if an error occurred and this result accompanies a
58 * {@link ProjectBuilderException}.
59 */
60 @Nonnull
61 Optional<Project> getProject();
62
63 /**
64 * Gets the problems that were encountered during the project building.
65 *
66 * @return the problems that were encountered during the project building, can be empty but never {@code null}
67 */
68 @Nonnull
69 Collection<BuilderProblem> getProblems();
70
71 /**
72 * Gets the result of the dependency resolution for the project.
73 *
74 * @return the result of the dependency resolution for the project
75 */
76 @Nonnull
77 Optional<DependencyCollectorResult> getDependencyResolverResult();
78 }