001 package org.apache.maven.model.building;
002
003 /*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements. See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership. The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License. You may obtain a copy of the License at
011 *
012 * http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied. See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022 /**
023 * Describes a problem that was encountered during model building. A problem can either be an exception that was thrown
024 * or a simple string message. In addition, a problem carries a hint about its source, e.g. the POM file that exhibits
025 * the problem.
026 *
027 * @author Benjamin Bentmann
028 */
029 public interface ModelProblem
030 {
031
032 /**
033 * The different severity levels for a problem, in decreasing order.
034 */
035 enum Severity
036 {
037
038 FATAL, //
039 ERROR, //
040 WARNING //
041
042 }
043
044 enum Version
045 {
046 //based on ModeBuildingResult.validationLevel
047 BASE,
048 V20,
049 V30,
050 V31
051 }
052
053 /**
054 * Gets the hint about the source of the problem. While the syntax of this hint is unspecified and depends on the
055 * creator of the problem, the general expectation is that the hint provides sufficient information to the user to
056 * track the problem back to its origin. A concrete example for such a source hint can be the file path or URL from
057 * which a POM was read.
058 *
059 * @return The hint about the source of the problem or an empty string if unknown, never {@code null}.
060 */
061 String getSource();
062
063 /**
064 * Gets the one-based index of the line containing the problem. The line number should refer to some text file that
065 * is given by {@link #getSource()}.
066 *
067 * @return The one-based index of the line containing the problem or a non-positive value if unknown.
068 */
069 int getLineNumber();
070
071 /**
072 * Gets the one-based index of the column containing the problem. The column number should refer to some text file
073 * that is given by {@link #getSource()}.
074 *
075 * @return The one-based index of the column containing the problem or non-positive value if unknown.
076 */
077 int getColumnNumber();
078
079 /**
080 * Gets the identifier of the model from which the problem originated. While the general form of this identifier is
081 * <code>groupId:artifactId:version</code> the returned identifier need not be complete. The identifier is derived
082 * from the information that is available at the point the problem occurs and as such merely serves as a best effort
083 * to provide information to the user to track the problem back to its origin.
084 *
085 * @return The identifier of the model from which the problem originated or an empty string if unknown, never
086 * {@code null}.
087 */
088 String getModelId();
089
090 /**
091 * Gets the exception that caused this problem (if any).
092 *
093 * @return The exception that caused this problem or {@code null} if not applicable.
094 */
095 Exception getException();
096
097 /**
098 * Gets the message that describes this problem.
099 *
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
117 }