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