-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
Violation.java
446 lines (408 loc) · 16.3 KB
/
Violation.java
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
///////////////////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
// Copyright (C) 2001-2022 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
///////////////////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.api;
import java.io.Serializable;
import java.text.MessageFormat;
import java.util.Arrays;
import java.util.Locale;
import java.util.Objects;
import com.puppycrawl.tools.checkstyle.LocalizedMessage;
/**
* Represents a violation that can be localised. The translations come from
* message.properties files. The underlying implementation uses
* java.text.MessageFormat.
*
* @noinspection SerializableHasSerializationMethods, ClassWithTooManyConstructors
* @noinspectionreason SerializableHasSerializationMethods - we do not serialize this class
* @noinspectionreason ClassWithTooManyConstructors - immutable nature of class requires a
* bunch of constructors
*/
public final class Violation
implements Comparable<Violation>, Serializable {
/** A unique serial version identifier. */
private static final long serialVersionUID = 5675176836184862150L;
/** The default severity level if one is not specified. */
private static final SeverityLevel DEFAULT_SEVERITY = SeverityLevel.ERROR;
/** The line number. **/
private final int lineNo;
/** The column number. **/
private final int columnNo;
/** The column char index. **/
private final int columnCharIndex;
/** The token type constant. See {@link TokenTypes}. **/
private final int tokenType;
/** The severity level. **/
private final SeverityLevel severityLevel;
/** The id of the module generating the violation. */
private final String moduleId;
/** Key for the violation format. **/
private final String key;
/**
* Arguments for MessageFormat.
*
* @noinspection NonSerializableFieldInSerializableClass
* @noinspectionreason NonSerializableFieldInSerializableClass - usage of
* 'Serializable' for this api class
* is considered as mistake now, but we do not break api without
* good reason
*/
private final Object[] args;
/** Name of the resource bundle to get violations from. **/
private final String bundle;
/** Class of the source for this Violation. */
private final Class<?> sourceClass;
/** A custom violation overriding the default violation from the bundle. */
private final String customMessage;
/**
* Creates a new {@code Violation} instance.
*
* @param lineNo line number associated with the violation
* @param columnNo column number associated with the violation
* @param columnCharIndex column char index associated with the violation
* @param tokenType token type of the event associated with violation. See {@link TokenTypes}
* @param bundle resource bundle name
* @param key the key to locate the translation
* @param args arguments for the translation
* @param severityLevel severity level for the violation
* @param moduleId the id of the module the violation is associated with
* @param sourceClass the Class that is the source of the violation
* @param customMessage optional custom violation overriding the default
* @noinspection ConstructorWithTooManyParameters
* @noinspectionreason ConstructorWithTooManyParameters - immutable class requires a large
* number of arguments
*/
// -@cs[ParameterNumber] Class is immutable, we need that amount of arguments.
public Violation(int lineNo,
int columnNo,
int columnCharIndex,
int tokenType,
String bundle,
String key,
Object[] args,
SeverityLevel severityLevel,
String moduleId,
Class<?> sourceClass,
String customMessage) {
this.lineNo = lineNo;
this.columnNo = columnNo;
this.columnCharIndex = columnCharIndex;
this.tokenType = tokenType;
this.key = key;
if (args == null) {
this.args = null;
}
else {
this.args = Arrays.copyOf(args, args.length);
}
this.bundle = bundle;
this.severityLevel = severityLevel;
this.moduleId = moduleId;
this.sourceClass = sourceClass;
this.customMessage = customMessage;
}
/**
* Creates a new {@code Violation} instance.
*
* @param lineNo line number associated with the violation
* @param columnNo column number associated with the violation
* @param tokenType token type of the event associated with violation. See {@link TokenTypes}
* @param bundle resource bundle name
* @param key the key to locate the translation
* @param args arguments for the translation
* @param severityLevel severity level for the violation
* @param moduleId the id of the module the violation is associated with
* @param sourceClass the Class that is the source of the violation
* @param customMessage optional custom violation overriding the default
* @noinspection ConstructorWithTooManyParameters
* @noinspectionreason ConstructorWithTooManyParameters - immutable class requires a large
* number of arguments
*/
// -@cs[ParameterNumber] Class is immutable, we need that amount of arguments.
public Violation(int lineNo,
int columnNo,
int tokenType,
String bundle,
String key,
Object[] args,
SeverityLevel severityLevel,
String moduleId,
Class<?> sourceClass,
String customMessage) {
this(lineNo, columnNo, columnNo, tokenType, bundle, key, args, severityLevel, moduleId,
sourceClass, customMessage);
}
/**
* Creates a new {@code Violation} instance.
*
* @param lineNo line number associated with the violation
* @param columnNo column number associated with the violation
* @param bundle resource bundle name
* @param key the key to locate the translation
* @param args arguments for the translation
* @param severityLevel severity level for the violation
* @param moduleId the id of the module the violation is associated with
* @param sourceClass the Class that is the source of the violation
* @param customMessage optional custom violation overriding the default
* @noinspection ConstructorWithTooManyParameters
* @noinspectionreason ConstructorWithTooManyParameters - immutable class requires a large
* number of arguments
*/
// -@cs[ParameterNumber] Class is immutable, we need that amount of arguments.
public Violation(int lineNo,
int columnNo,
String bundle,
String key,
Object[] args,
SeverityLevel severityLevel,
String moduleId,
Class<?> sourceClass,
String customMessage) {
this(lineNo, columnNo, 0, bundle, key, args, severityLevel, moduleId, sourceClass,
customMessage);
}
/**
* Creates a new {@code Violation} instance.
*
* @param lineNo line number associated with the violation
* @param columnNo column number associated with the violation
* @param bundle resource bundle name
* @param key the key to locate the translation
* @param args arguments for the translation
* @param moduleId the id of the module the violation is associated with
* @param sourceClass the Class that is the source of the violation
* @param customMessage optional custom violation overriding the default
* @noinspection ConstructorWithTooManyParameters
* @noinspectionreason ConstructorWithTooManyParameters - immutable class requires a large
* number of arguments
*/
// -@cs[ParameterNumber] Class is immutable, we need that amount of arguments.
public Violation(int lineNo,
int columnNo,
String bundle,
String key,
Object[] args,
String moduleId,
Class<?> sourceClass,
String customMessage) {
this(lineNo,
columnNo,
bundle,
key,
args,
DEFAULT_SEVERITY,
moduleId,
sourceClass,
customMessage);
}
/**
* Creates a new {@code Violation} instance.
*
* @param lineNo line number associated with the violation
* @param bundle resource bundle name
* @param key the key to locate the translation
* @param args arguments for the translation
* @param severityLevel severity level for the violation
* @param moduleId the id of the module the violation is associated with
* @param sourceClass the source class for the violation
* @param customMessage optional custom violation overriding the default
* @noinspection ConstructorWithTooManyParameters
* @noinspectionreason ConstructorWithTooManyParameters - immutable class requires a large
* number of arguments
*/
// -@cs[ParameterNumber] Class is immutable, we need that amount of arguments.
public Violation(int lineNo,
String bundle,
String key,
Object[] args,
SeverityLevel severityLevel,
String moduleId,
Class<?> sourceClass,
String customMessage) {
this(lineNo, 0, bundle, key, args, severityLevel, moduleId,
sourceClass, customMessage);
}
/**
* Creates a new {@code Violation} instance. The column number
* defaults to 0.
*
* @param lineNo line number associated with the violation
* @param bundle name of a resource bundle that contains audit event violations
* @param key the key to locate the translation
* @param args arguments for the translation
* @param moduleId the id of the module the violation is associated with
* @param sourceClass the name of the source for the violation
* @param customMessage optional custom violation overriding the default
*/
public Violation(
int lineNo,
String bundle,
String key,
Object[] args,
String moduleId,
Class<?> sourceClass,
String customMessage) {
this(lineNo, 0, bundle, key, args, DEFAULT_SEVERITY, moduleId,
sourceClass, customMessage);
}
/**
* Gets the line number.
*
* @return the line number
*/
public int getLineNo() {
return lineNo;
}
/**
* Gets the column number.
*
* @return the column number
*/
public int getColumnNo() {
return columnNo;
}
/**
* Gets the column char index.
*
* @return the column char index
*/
public int getColumnCharIndex() {
return columnCharIndex;
}
/**
* Gets the token type.
*
* @return the token type
*/
public int getTokenType() {
return tokenType;
}
/**
* Gets the severity level.
*
* @return the severity level
*/
public SeverityLevel getSeverityLevel() {
return severityLevel;
}
/**
* Returns id of module.
*
* @return the module identifier.
*/
public String getModuleId() {
return moduleId;
}
/**
* Returns the violation key to locate the translation, can also be used
* in IDE plugins to map audit event violations to corrective actions.
*
* @return the violation key
*/
public String getKey() {
return key;
}
/**
* Gets the name of the source for this Violation.
*
* @return the name of the source for this Violation
*/
public String getSourceName() {
return sourceClass.getName();
}
/**
* Indicates whether some other object is "equal to" this one.
* Suppression on enumeration is needed so code stays consistent.
*
* @noinspection EqualsCalledOnEnumConstant
* @noinspectionreason EqualsCalledOnEnumConstant - enumeration is needed to keep
* code consistent
*/
// -@cs[CyclomaticComplexity] equals - a lot of fields to check.
@Override
public boolean equals(Object object) {
if (this == object) {
return true;
}
if (object == null || getClass() != object.getClass()) {
return false;
}
final Violation violation = (Violation) object;
return Objects.equals(lineNo, violation.lineNo)
&& Objects.equals(columnNo, violation.columnNo)
&& Objects.equals(columnCharIndex, violation.columnCharIndex)
&& Objects.equals(tokenType, violation.tokenType)
&& Objects.equals(severityLevel, violation.severityLevel)
&& Objects.equals(moduleId, violation.moduleId)
&& Objects.equals(key, violation.key)
&& Objects.equals(bundle, violation.bundle)
&& Objects.equals(sourceClass, violation.sourceClass)
&& Objects.equals(customMessage, violation.customMessage)
&& Arrays.equals(args, violation.args);
}
@Override
public int hashCode() {
return Objects.hash(lineNo, columnNo, columnCharIndex, tokenType, severityLevel, moduleId,
key, bundle, sourceClass, customMessage, Arrays.hashCode(args));
}
////////////////////////////////////////////////////////////////////////////
// Interface Comparable methods
////////////////////////////////////////////////////////////////////////////
@Override
public int compareTo(Violation other) {
final int result;
if (lineNo == other.lineNo) {
if (columnNo == other.columnNo) {
if (Objects.equals(moduleId, other.moduleId)) {
result = getViolation().compareTo(other.getViolation());
}
else if (moduleId == null) {
result = -1;
}
else if (other.moduleId == null) {
result = 1;
}
else {
result = moduleId.compareTo(other.moduleId);
}
}
else {
result = Integer.compare(columnNo, other.columnNo);
}
}
else {
result = Integer.compare(lineNo, other.lineNo);
}
return result;
}
/**
* Gets the translated violation.
*
* @return the translated violation
*/
public String getViolation() {
final String violation;
if (customMessage != null) {
violation = new MessageFormat(customMessage, Locale.ROOT).format(args);
}
else {
violation = new LocalizedMessage(bundle, sourceClass, key, args).getMessage();
}
return violation;
}
}