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.util.List;
22
23 import org.apache.maven.api.model.InputLocation;
24 import org.apache.maven.api.model.Model;
25
26 /**
27 * Collects problems that are encountered during model building. The primary purpose of this component is to account for
28 * the fact that the problem reporter has/should not have information about the calling context and hence cannot provide
29 * an expressive source hint for the model problem. Instead, the source hint is configured by the model builder before
30 * it delegates to other components that potentially encounter problems. Then, the problem reporter can focus on
31 * providing a simple error message, leaving the donkey work of creating a nice model problem to this component.
32 *
33 */
34 public interface ModelProblemCollector {
35
36 /**
37 * The collected problems.
38 * @return a list of model problems encountered, never {@code null}
39 */
40 List<ModelProblem> getProblems();
41
42 boolean hasErrors();
43
44 boolean hasFatalErrors();
45
46 default void add(BuilderProblem.Severity severity, ModelProblem.Version version, String message) {
47 add(severity, version, message, null, null);
48 }
49
50 default void add(
51 BuilderProblem.Severity severity, ModelProblem.Version version, String message, InputLocation location) {
52 add(severity, version, message, location, null);
53 }
54
55 default void add(
56 BuilderProblem.Severity severity, ModelProblem.Version version, String message, Exception exception) {
57 add(severity, version, message, null, exception);
58 }
59
60 void add(
61 BuilderProblem.Severity severity,
62 ModelProblem.Version version,
63 String message,
64 InputLocation location,
65 Exception exception);
66
67 void add(ModelProblem problem);
68
69 ModelBuilderException newModelBuilderException();
70
71 void setSource(String location);
72
73 void setSource(Model model);
74
75 String getSource();
76
77 void setRootModel(Model model);
78
79 Model getRootModel();
80 }