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
|
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2017 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.filters;
import java.util.Collections;
import java.util.Objects;
import java.util.Set;
import com.puppycrawl.tools.checkstyle.api.AuditEvent;
import com.puppycrawl.tools.checkstyle.api.AutomaticBean;
import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
import com.puppycrawl.tools.checkstyle.api.ExternalResourceHolder;
import com.puppycrawl.tools.checkstyle.api.Filter;
import com.puppycrawl.tools.checkstyle.api.FilterSet;
import com.puppycrawl.tools.checkstyle.utils.FilterUtils;
/**
* <p>
* This filter accepts AuditEvents according to file, check, line, and
* column, as specified in a suppression file.
* </p>
* @author Rick Giles
* @author <a href="mailto:piotr.listkiewicz@gmail.com">liscju</a>
* @noinspection NonFinalFieldReferenceInEquals, NonFinalFieldReferencedInHashCode
*/
public class SuppressionFilter extends AutomaticBean implements Filter, ExternalResourceHolder {
/** Filename of supression file. */
private String file;
/** Tells whether config file existence is optional. */
private boolean optional;
/** Set of individual suppresses. */
private FilterSet filters = new FilterSet();
/**
* Sets name of the supression file.
* @param fileName name of the suppressions file.
*/
public void setFile(String fileName) {
file = fileName;
}
/**
* Sets whether config file existence is optional.
* @param optional tells if config file existence is optional.
*/
public void setOptional(boolean optional) {
this.optional = optional;
}
@Override
public boolean accept(AuditEvent event) {
return filters.accept(event);
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null || getClass() != obj.getClass()) {
return false;
}
final SuppressionFilter suppressionFilter = (SuppressionFilter) obj;
return Objects.equals(filters, suppressionFilter.filters);
}
@Override
public int hashCode() {
return Objects.hash(filters);
}
@Override
protected void finishLocalSetup() throws CheckstyleException {
if (file != null) {
if (optional) {
if (FilterUtils.isFileExists(file)) {
filters = SuppressionsLoader.loadSuppressions(file);
}
else {
filters = new FilterSet();
}
}
else {
filters = SuppressionsLoader.loadSuppressions(file);
}
}
}
@Override
public Set<String> getExternalResourceLocations() {
return Collections.singleton(file);
}
}
|
