001package org.apache.maven.settings.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 settings building.
024 *
025 * @author Benjamin Bentmann
026 */
027public interface SettingsProblemCollector
028{
029
030    /**
031     * Adds the specified problem.
032     *
033     * @param severity The severity of the problem, must not be {@code null}.
034     * @param message The detail message of the problem, may be {@code null}.
035     * @param line The one-based index of the line containing the problem or {@code -1} if unknown.
036     * @param column The one-based index of the column containing the problem or {@code -1} if unknown.
037     * @param cause The cause of the problem, may be {@code null}.
038     */
039    void add( SettingsProblem.Severity severity, String message, int line, int column, Exception cause );
040
041}