1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
package org.apache.maven.model.building;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.model.Model;
/**
* Describes a problem that was encountered during model building. A problem can either be an exception that was thrown
* or a simple string message. In addition, a problem carries a hint about its source, e.g. the POM file that exhibits
* the problem.
*
* @author Benjamin Bentmann
*/
public class DefaultModelProblem
implements ModelProblem
{
private final String source;
private final int lineNumber;
private final int columnNumber;
private final String modelId;
private final String message;
private final Exception exception;
private final Severity severity;
private final Version version;
/**
* Creates a new problem with the specified message and exception.
*
* @param message The message describing the problem, may be {@code null}.
* @param severity The severity level of the problem, may be {@code null} to default to
* {@link ModelProblem.Severity#ERROR}.
* @param source The source of the problem, may be {@code null}.
* @param lineNumber The one-based index of the line containing the error or {@code -1} if unknown.
* @param columnNumber The one-based index of the column containing the error or {@code -1} if unknown.
* @param exception The exception that caused this problem, may be {@code null}.
*/
//mkleint: does this need to be public?
public DefaultModelProblem( String message, Severity severity, Version version, Model source, int lineNumber,
int columnNumber, Exception exception )
{
this( message, severity, version, ModelProblemUtils.toPath( source ), lineNumber, columnNumber,
ModelProblemUtils.toId( source ), exception );
}
/**
* Creates a new problem with the specified message and exception.
*
* @param message The message describing the problem, may be {@code null}.
* @param severity The severity level of the problem, may be {@code null} to default to
* {@link ModelProblem.Severity#ERROR}.
* @param version The version since the problem is relevant
* @param source A hint about the source of the problem like a file path, may be {@code null}.
* @param lineNumber The one-based index of the line containing the problem or {@code -1} if unknown.
* @param columnNumber The one-based index of the column containing the problem or {@code -1} if unknown.
* @param modelId The identifier of the model that exhibits the problem, may be {@code null}.
* @param exception The exception that caused this problem, may be {@code null}.
*/
//mkleint: does this need to be public?
public DefaultModelProblem( String message, Severity severity, Version version, String source, int lineNumber,
int columnNumber, String modelId, Exception exception )
{
this.message = message;
this.severity = ( severity != null ) ? severity : Severity.ERROR;
this.source = ( source != null ) ? source : "";
this.lineNumber = lineNumber;
this.columnNumber = columnNumber;
this.modelId = ( modelId != null ) ? modelId : "";
this.exception = exception;
this.version = version;
}
@Override
public String getSource()
{
return source;
}
@Override
public int getLineNumber()
{
return lineNumber;
}
@Override
public int getColumnNumber()
{
return columnNumber;
}
@Override
public String getModelId()
{
return modelId;
}
@Override
public Exception getException()
{
return exception;
}
@Override
public String getMessage()
{
String msg;
if ( message != null && message.length() > 0 )
{
msg = message;
}
else
{
msg = exception.getMessage();
if ( msg == null )
{
msg = "";
}
}
return msg;
}
@Override
public Severity getSeverity()
{
return severity;
}
@Override
public Version getVersion()
{
return version;
}
@Override
public String toString()
{
StringBuilder buffer = new StringBuilder( 128 );
buffer.append( "[" ).append( getSeverity() ).append( "] " );
buffer.append( getMessage() );
buffer.append( " @ " ).append( ModelProblemUtils.formatLocation( this, null ) );
return buffer.toString();
}
}
|
