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