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.io.Serial;
22
23 import org.apache.maven.api.annotations.Experimental;
24
25 /**
26 * The Exception class throw by the {@link ProjectBuilder} service.
27 *
28 * @since 4.0.0
29 */
30 @Experimental
31 public class ModelBuilderException extends MavenException {
32
33 @Serial
34 private static final long serialVersionUID = -1865447022070650896L;
35
36 private final ModelBuilderResult result;
37
38 /**
39 * Creates a new exception from the specified interim result and its associated problems.
40 *
41 * @param result The interim result, may be {@code null}.
42 */
43 public ModelBuilderException(ModelBuilderResult result) {
44 super(result.toString());
45 this.result = result;
46 }
47
48 /**
49 * Gets the interim result of the model building up to the point where it failed.
50 *
51 * @return The interim model building result or {@code null} if not available.
52 */
53 public ModelBuilderResult getResult() {
54 return result;
55 }
56
57 /**
58 * Gets the identifier of the POM whose effective model could not be built. The general format of the identifier is
59 * {@code <groupId>:<artifactId>:<version>} but some of these coordinates may still be unknown at the point the
60 * exception is thrown so this information is merely meant to assist the user.
61 *
62 * @return The identifier of the POM or an empty string if not known, never {@code null}.
63 */
64 public String getModelId() {
65 if (result == null) {
66 return "";
67 } else if (result.getEffectiveModel() != null) {
68 return result.getEffectiveModel().getId();
69 } else if (result.getRawModel() != null) {
70 return result.getRawModel().getId();
71 } else if (result.getFileModel() != null) {
72 return result.getFileModel().getId();
73 } else {
74 return "";
75 }
76 }
77
78 /**
79 * Gets the problems that caused this exception.
80 *
81 * @return The problems that caused this exception, never {@code null}.
82 */
83 public ProblemCollector<ModelProblem> getProblemCollector() {
84 if (result == null) {
85 return ProblemCollector.empty();
86 }
87 return result.getProblemCollector();
88 }
89 }