001package org.apache.maven.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
022import java.util.List;
023
024/**
025 * Collects problems that are encountered during settings building.
026 *
027 * @author Benjamin Bentmann
028 * @author Robert Scholte
029 */
030public interface ProblemCollector
031{
032
033    /**
034     * Adds the specified problem.
035     * Either message or exception is required
036     *
037     * @param severity The severity of the problem, must not be {@code null}.
038     * @param message The detail message of the problem, may be {@code null}.
039     * @param line The one-based index of the line containing the problem or {@code -1} if unknown.
040     * @param column The one-based index of the column containing the problem or {@code -1} if unknown.
041     * @param cause The cause of the problem, may be {@code null}.
042     */
043    void add( Problem.Severity severity, String message, int line, int column, Exception cause );
044    
045    /**
046     * The next messages will be bound to this source. When calling this method again, previous messages keep
047     * their source, but the next messages will use the new source.
048     * 
049     * @param source
050     */
051    void setSource( String source );
052    
053    /**
054     * 
055     * @return the collected Problems, never {@code null}
056     */
057    List<Problem> getProblems();
058
059}