blob: b82985bbd354d6c3dec929b773b849ce48e5dc47 (
plain)
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
|
////////////////////////////////////////////////////////////////////////////////
// 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.checks.regexp;
import com.puppycrawl.tools.checkstyle.StatelessCheck;
import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.utils.CommonUtils;
/**
* Implementation of a check that looks for a single line in Java files.
* Supports ignoring comments for matches.
* @author Oliver Burn
*/
@StatelessCheck
public class RegexpSinglelineJavaCheck extends AbstractCheck {
/** The format of the regular expression to match. */
private String format = "$.";
/** The message to report for a match. */
private String message;
/** The minimum number of matches required per file. */
private int minimum;
/** The maximum number of matches required per file. */
private int maximum;
/** Whether to ignore case when matching. */
private boolean ignoreCase;
/** Suppress comments. **/
private boolean ignoreComments;
@Override
public int[] getDefaultTokens() {
return getAcceptableTokens();
}
@Override
public int[] getAcceptableTokens() {
return CommonUtils.EMPTY_INT_ARRAY;
}
@Override
public int[] getRequiredTokens() {
return getAcceptableTokens();
}
@Override
public void beginTree(DetailAST rootAST) {
MatchSuppressor suppressor = null;
if (ignoreComments) {
suppressor = new CommentSuppressor(getFileContents());
}
final DetectorOptions options = DetectorOptions.newBuilder()
.reporter(this)
.compileFlags(0)
.suppressor(suppressor)
.format(format)
.message(message)
.minimum(minimum)
.maximum(maximum)
.ignoreCase(ignoreCase)
.build();
final SinglelineDetector detector = new SinglelineDetector(options);
detector.processLines(getFileContents().getText());
}
/**
* Set the format of the regular expression to match.
* @param format the format of the regular expression to match.
*/
public void setFormat(String format) {
this.format = format;
}
/**
* Set the message to report for a match.
* @param message the message to report for a match.
*/
public void setMessage(String message) {
this.message = message;
}
/**
* Set the minimum number of matches required per file.
* @param minimum the minimum number of matches required per file.
*/
public void setMinimum(int minimum) {
this.minimum = minimum;
}
/**
* Set the maximum number of matches required per file.
* @param maximum the maximum number of matches required per file.
*/
public void setMaximum(int maximum) {
this.maximum = maximum;
}
/**
* Set whether to ignore case when matching.
* @param ignoreCase whether to ignore case when matching.
*/
public void setIgnoreCase(boolean ignoreCase) {
this.ignoreCase = ignoreCase;
}
/**
* Set whether to ignore comments when matching.
* @param ignore whether to ignore comments when matching.
*/
public void setIgnoreComments(boolean ignore) {
ignoreComments = ignore;
}
}
|
