001package org.apache.maven.model.building;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022/**
023 * Collects problems that are encountered during model building. The primary purpose of this component is to account for
024 * the fact that the problem reporter has/should not have information about the calling context and hence cannot provide
025 * an expressive source hint for the model problem. Instead, the source hint is configured by the model builder before
026 * it delegates to other components that potentially encounter problems. Then, the problem reporter can focus on
027 * providing a simple error message, leaving the donkey work of creating a nice model problem to this component.
028 *
029 * @author Benjamin Bentmann
030 */
031public interface ModelProblemCollector
032{
033
034    /**
035     * Adds the specified problem.
036     *
037     * @param req must not be null
038     */
039    void add( ModelProblemCollectorRequest req );
040
041}