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