View Javadoc

1   package org.apache.maven.settings.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 settings building.
24   * 
25   * @author Benjamin Bentmann
26   */
27  public interface SettingsProblemCollector
28  {
29  
30      /**
31       * Adds the specified problem.
32       * 
33       * @param severity The severity of the problem, must not be {@code null}.
34       * @param message The detail message of the problem, may be {@code null}.
35       * @param line The one-based index of the line containing the problem or {@code -1} if unknown.
36       * @param column The one-based index of the column containing the problem or {@code -1} if unknown.
37       * @param cause The cause of the problem, may be {@code null}.
38       */
39      void add( SettingsProblem.Severity severity, String message, int line, int column, Exception cause );
40  
41  }