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.model.building;
20  
21  /**
22   * Describes a problem that was encountered during model building. A problem can either be an exception that was thrown
23   * or a simple string message. In addition, a problem carries a hint about its source, e.g. the POM file that exhibits
24   * the problem.
25   *
26   */
27  public interface ModelProblem {
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       * Version
40       */
41      enum Version {
42          // based on ModeBuildingResult.validationLevel
43          BASE,
44          V20,
45          V30,
46          V31,
47          V40
48      }
49  
50      /**
51       * Gets the hint about the source of the problem. While the syntax of this hint is unspecified and depends on the
52       * creator of the problem, the general expectation is that the hint provides sufficient information to the user to
53       * track the problem back to its origin. A concrete example for such a source hint can be the file path or URL from
54       * which a POM was read.
55       *
56       * @return The hint about the source of the problem or an empty string if unknown, never {@code null}.
57       */
58      String getSource();
59  
60      /**
61       * Gets the one-based index of the line containing the problem. The line number should refer to some text file that
62       * is given by {@link #getSource()}.
63       *
64       * @return The one-based index of the line containing the problem or a non-positive value if unknown.
65       */
66      int getLineNumber();
67  
68      /**
69       * Gets the one-based index of the column containing the problem. The column number should refer to some text file
70       * that is given by {@link #getSource()}.
71       *
72       * @return The one-based index of the column containing the problem or non-positive value if unknown.
73       */
74      int getColumnNumber();
75  
76      /**
77       * Gets the identifier of the model from which the problem originated. While the general form of this identifier is
78       * <code>groupId:artifactId:version</code> the returned identifier need not be complete. The identifier is derived
79       * from the information that is available at the point the problem occurs and as such merely serves as a best effort
80       * to provide information to the user to track the problem back to its origin.
81       *
82       * @return The identifier of the model from which the problem originated or an empty string if unknown, never
83       *         {@code null}.
84       */
85      String getModelId();
86  
87      /**
88       * Gets the exception that caused this problem (if any).
89       *
90       * @return The exception that caused this problem or {@code null} if not applicable.
91       */
92      Exception getException();
93  
94      /**
95       * Gets the message that describes this problem.
96       *
97       * @return The message describing this problem, never {@code null}.
98       */
99      String getMessage();
100 
101     /**
102      * Gets the severity level of this problem.
103      *
104      * @return The severity level of this problem, never {@code null}.
105      */
106     Severity getSeverity();
107 
108     /**
109      * Gets the applicable maven version/validation level of this problem
110      * @return The version, never {@code null}.
111      */
112     Version getVersion();
113 }