1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.building;
20
21 import java.util.List;
22
23 /**
24 * Collects problems that are encountered during settings building.
25 *
26 * @author Benjamin Bentmann
27 * @author Robert Scholte
28 */
29 public interface ProblemCollector {
30
31 /**
32 * Adds the specified problem.
33 * Either message or exception is required
34 *
35 * @param severity The severity of the problem, must not be {@code null}.
36 * @param message The detail message of the problem, may be {@code null}.
37 * @param line The one-based index of the line containing the problem or {@code -1} if unknown.
38 * @param column The one-based index of the column containing the problem or {@code -1} if unknown.
39 * @param cause The cause of the problem, may be {@code null}.
40 */
41 void add(Problem.Severity severity, String message, int line, int column, Exception cause);
42
43 /**
44 * The next messages will be bound to this source. When calling this method again, previous messages keep
45 * their source, but the next messages will use the new source.
46 *
47 * @param source a source
48 */
49 void setSource(String source);
50
51 /**
52 *
53 * @return the collected Problems, never {@code null}
54 */
55 List<Problem> getProblems();
56 }