-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
RegexpSinglelineCheck.java
179 lines (165 loc) · 5.64 KB
/
RegexpSinglelineCheck.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
///////////////////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
// Copyright (C) 2001-2023 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.checks.regexp;
import java.io.File;
import com.puppycrawl.tools.checkstyle.PropertyType;
import com.puppycrawl.tools.checkstyle.StatelessCheck;
import com.puppycrawl.tools.checkstyle.XdocsPropertyType;
import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
import com.puppycrawl.tools.checkstyle.api.FileText;
/**
* <p>
* Checks that a specified pattern matches a single-line in any file type.
* </p>
* <p>
* Rationale: This check can be used to prototype checks and to find common bad
* practice such as calling {@code ex.printStacktrace()},
* {@code System.out.println()}, {@code System.exit()}, etc.
* </p>
* <ul>
* <li>
* Property {@code fileExtensions} - Specify the file type extension of files to process.
* Type is {@code java.lang.String[]}.
* Default value is {@code ""}.
* </li>
* <li>
* Property {@code format} - Specify the format of the regular expression to match.
* Type is {@code java.util.regex.Pattern}.
* Default value is {@code "$."}.
* </li>
* <li>
* Property {@code ignoreCase} - Control whether to ignore case when searching.
* Type is {@code boolean}.
* Default value is {@code false}.
* </li>
* <li>
* Property {@code maximum} - Specify the maximum number of matches required in each file.
* Type is {@code int}.
* Default value is {@code 0}.
* </li>
* <li>
* Property {@code message} - Specify the message which is used to notify about
* violations, if empty then default (hard-coded) message is used.
* Type is {@code java.lang.String}.
* Default value is {@code null}.
* </li>
* <li>
* Property {@code minimum} - Specify the minimum number of matches required in each file.
* Type is {@code int}.
* Default value is {@code 0}.
* </li>
* </ul>
* <p>
* Parent is {@code com.puppycrawl.tools.checkstyle.Checker}
* </p>
* <p>
* Violation Message Keys:
* </p>
* <ul>
* <li>
* {@code regexp.exceeded}
* </li>
* <li>
* {@code regexp.minimum}
* </li>
* </ul>
*
* @since 5.0
*/
@StatelessCheck
public class RegexpSinglelineCheck extends AbstractFileSetCheck {
/** Specify the format of the regular expression to match. */
@XdocsPropertyType(PropertyType.PATTERN)
private String format = "$.";
/**
* Specify the message which is used to notify about violations,
* if empty then default (hard-coded) message is used.
*/
private String message;
/** Specify the minimum number of matches required in each file. */
private int minimum;
/** Specify the maximum number of matches required in each file. */
private int maximum;
/** Control whether to ignore case when searching. */
private boolean ignoreCase;
/** The detector to use. */
private SinglelineDetector detector;
@Override
public void beginProcessing(String charset) {
final DetectorOptions options = DetectorOptions.newBuilder()
.reporter(this)
.format(format)
.message(message)
.minimum(minimum)
.maximum(maximum)
.ignoreCase(ignoreCase)
.build();
detector = new SinglelineDetector(options);
}
@Override
protected void processFiltered(File file, FileText fileText) {
detector.processLines(fileText);
}
/**
* Setter to specify the format of the regular expression to match.
*
* @param format the format of the regular expression to match.
* @since 5.0
*/
public void setFormat(String format) {
this.format = format;
}
/**
* Setter to specify the message which is used to notify about violations,
* if empty then default (hard-coded) message is used.
*
* @param message the message to report for a match.
* @since 5.0
*/
public void setMessage(String message) {
this.message = message;
}
/**
* Setter to specify the minimum number of matches required in each file.
*
* @param minimum the minimum number of matches required in each file.
* @since 5.0
*/
public void setMinimum(int minimum) {
this.minimum = minimum;
}
/**
* Setter to specify the maximum number of matches required in each file.
*
* @param maximum the maximum number of matches required in each file.
* @since 5.0
*/
public void setMaximum(int maximum) {
this.maximum = maximum;
}
/**
* Setter to control whether to ignore case when searching.
*
* @param ignoreCase whether to ignore case when searching.
* @since 5.0
*/
public void setIgnoreCase(boolean ignoreCase) {
this.ignoreCase = ignoreCase;
}
}