View Javadoc
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.model.building;
20  
21  /**
22   * Collects problems that are encountered during model building. The primary purpose of this component is to account for
23   * the fact that the problem reporter has/should not have information about the calling context and hence cannot provide
24   * an expressive source hint for the model problem. Instead, the source hint is configured by the model builder before
25   * it delegates to other components that potentially encounter problems. Then, the problem reporter can focus on
26   * providing a simple error message, leaving the donkey work of creating a nice model problem to this component.
27   *
28   */
29  public interface ModelProblemCollector {
30  
31      /**
32       * Adds the specified problem.
33       *
34       * @param req must not be null
35       */
36      void add(ModelProblemCollectorRequest req);
37  }