View Javadoc
1   package org.apache.maven.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  import java.util.List;
23  
24  /**
25   * Collects problems that are encountered during settings building.
26   *
27   * @author Benjamin Bentmann
28   * @author Robert Scholte
29   */
30  public interface ProblemCollector
31  {
32  
33      /**
34       * Adds the specified problem.
35       * Either message or exception is required
36       *
37       * @param severity The severity of the problem, must not be {@code null}.
38       * @param message The detail message of the problem, may be {@code null}.
39       * @param line The one-based index of the line containing the problem or {@code -1} if unknown.
40       * @param column The one-based index of the column containing the problem or {@code -1} if unknown.
41       * @param cause The cause of the problem, may be {@code null}.
42       */
43      void add( Problem.Severity severity, String message, int line, int column, Exception cause );
44      
45      /**
46       * The next messages will be bound to this source. When calling this method again, previous messages keep
47       * their source, but the next messages will use the new source.
48       * 
49       * @param source
50       */
51      void setSource( String source );
52      
53      /**
54       * 
55       * @return the collected Problems, never {@code null}
56       */
57      List<Problem> getProblems();
58  
59  }