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