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