View Javadoc

1   package org.apache.maven.model.building;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  /**
23   * Collects problems that are encountered during model building. The primary purpose of this component is to account for
24   * the fact that the problem reporter has/should not have information about the calling context and hence cannot provide
25   * an expressive source hint for the model problem. Instead, the source hint is configured by the model builder before
26   * it delegates to other components that potentially encounter problems. Then, the problem reporter can focus on
27   * providing a simple error message, leaving the donkey work of creating a nice model problem to this component.
28   * 
29   * @author Benjamin Bentmann
30   */
31  public interface ModelProblemCollector
32  {
33  
34      /**
35       * Adds the specified problem.
36       * 
37       * @param req must not be null
38       */
39      void add( ModelProblemCollectorRequest req );
40  
41  }