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 /**
22 * Describes a problem that was encountered during settings building. A problem can either be an exception that was
23 * thrown or a simple string message. In addition, a problem carries a hint about its source, e.g. the settings file
24 * that exhibits the problem.
25 *
26 * @author Benjamin Bentmann
27 * @author Robert Scholte
28 */
29 public interface Problem {
30
31 /**
32 * The different severity levels for a problem, in decreasing order.
33 */
34 enum Severity {
35 FATAL, //
36 ERROR, //
37 WARNING //
38 }
39
40 /**
41 * Gets the hint about the source of the problem. While the syntax of this hint is unspecified and depends on the
42 * creator of the problem, the general expectation is that the hint provides sufficient information to the user to
43 * track the problem back to its origin. A concrete example for such a source hint can be the file path or URL from
44 * which the settings were read.
45 *
46 * @return The hint about the source of the problem or an empty string if unknown, never {@code null}.
47 */
48 String getSource();
49
50 /**
51 * Gets the one-based index of the line containing the problem. The line number should refer to some text file that
52 * is given by {@link #getSource()}.
53 *
54 * @return The one-based index of the line containing the problem or a non-positive value if unknown.
55 */
56 int getLineNumber();
57
58 /**
59 * Gets the one-based index of the column containing the problem. The column number should refer to some text file
60 * that is given by {@link #getSource()}.
61 *
62 * @return The one-based index of the column containing the problem or non-positive value if unknown.
63 */
64 int getColumnNumber();
65
66 /**
67 * Gets the location of the problem. The location is a user-friendly combination of the values from
68 * {@link #getSource()}, {@link #getLineNumber()} and {@link #getColumnNumber()}. The exact syntax of the returned
69 * value is undefined.
70 *
71 * @return The location of the problem, never {@code null}.
72 */
73 String getLocation();
74
75 /**
76 * Gets the exception that caused this problem (if any).
77 *
78 * @return The exception that caused this problem or {@code null} if not applicable.
79 */
80 Exception getException();
81
82 /**
83 * Gets the message that describes this problem.
84 *
85 * @return The message describing this problem, never {@code null}.
86 */
87 String getMessage();
88
89 /**
90 * Gets the severity level of this problem.
91 *
92 * @return The severity level of this problem, never {@code null}.
93 */
94 Severity getSeverity();
95 }