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