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