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.api.services;
20
21 import org.apache.maven.api.annotations.Nonnull;
22
23 /**
24 * Describes a problem that was encountered during model building. A problem can either be an exception that was thrown
25 * or a simple string message. In addition, a problem carries a hint about its source, e.g. the POM file that exhibits
26 * the problem.
27 *
28 */
29 public interface ModelProblem extends BuilderProblem {
30
31 /**
32 * Enumeration of model versions that can be validated.
33 * These versions correspond to different levels of validation that can be applied
34 * during model building, based on the POM schema version.
35 * <p>
36 * The validation levels are cumulative, with higher versions including all validations
37 * from lower versions plus additional checks specific to that version.
38 */
39 enum Version {
40 /**
41 * Base validation level that applies to all POM versions.
42 * Includes fundamental structural validations.
43 */
44 BASE,
45
46 /**
47 * Validation for Maven 2.0 POM format.
48 */
49 V20,
50
51 /**
52 * Validation for Maven 3.0 POM format.
53 */
54 V30,
55
56 /**
57 * Validation for Maven 3.1 POM format.
58 */
59 V31,
60
61 /**
62 * Validation for Maven 4.0 POM format.
63 */
64 V40,
65
66 /**
67 * Validation for Maven 4.1 POM format.
68 */
69 V41
70 }
71
72 /**
73 * Gets the identifier of the model from which the problem originated. The identifier is derived from the
74 * information that is available at the point the problem occurs and as such merely serves as best effort
75 * to provide information to the user to track the problem back to its origin.
76 *
77 * @return The identifier of the model from which the problem originated or an empty string if unknown, never
78 * {@code null}.
79 */
80 @Nonnull
81 String getModelId();
82
83 /**
84 * Gets the applicable maven version/validation level of this problem
85 * @return The version, never {@code null}.
86 */
87 @Nonnull
88 Version getVersion();
89 }