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 * Version
33 */
34 enum Version {
35 // based on ModeBuildingResult.validationLevel
36 BASE,
37 V20,
38 V30,
39 V31,
40 V40,
41 V41
42 }
43
44 /**
45 * Gets the identifier of the model from which the problem originated. The identifier is derived from the
46 * information that is available at the point the problem occurs and as such merely serves as best effort
47 * to provide information to the user to track the problem back to its origin.
48 *
49 * @return The identifier of the model from which the problem originated or an empty string if unknown, never
50 * {@code null}.
51 */
52 @Nonnull
53 String getModelId();
54
55 /**
56 * Gets the applicable maven version/validation level of this problem
57 * @return The version, never {@code null}.
58 */
59 @Nonnull
60 Version getVersion();
61 }