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