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