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