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
|
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2015 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.coding;
import java.util.regex.Pattern;
import org.apache.commons.lang3.ArrayUtils;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck;
import com.puppycrawl.tools.checkstyle.utils.TokenUtils;
/**
* <p>
* Checks for illegal token text.
* </p>
* <p> An example of how to configure the check to forbid String literals
* containing {@code "a href"} is:
* </p>
* <pre>
* <module name="IllegalTokenText">
* <property name="tokens" value="STRING_LITERAL"/>
* <property name="format" value="a href"/>
* </module>
* </pre>
* <p> An example of how to configure the check to forbid leading zeros in an
* integer literal, other than zero and a hex literal is:
* </p>
* <pre>
* <module name="IllegalTokenText">
* <property name="tokens" value="NUM_INT,NUM_LONG"/>
* <property name="format" value="^0[^lx]"/>
* <property name="ignoreCase" value="true"/>
* </module>
* </pre>
* @author Rick Giles
*/
public class IllegalTokenTextCheck
extends AbstractFormatCheck {
/**
* A key is pointing to the warning message text in "messages.properties"
* file.
*/
public static final String MSG_KEY = "illegal.token.text";
/**
* Custom message for report if illegal regexp found
* ignored if empty.
*/
private String message = "";
/**
* Instantiates a new instance.
*/
public IllegalTokenTextCheck() {
// the empty language
super("$^");
}
@Override
public int[] getDefaultTokens() {
return ArrayUtils.EMPTY_INT_ARRAY;
}
@Override
public int[] getAcceptableTokens() {
return TokenUtils.getAllTokenIds();
}
@Override
public int[] getRequiredTokens() {
return ArrayUtils.EMPTY_INT_ARRAY;
}
@Override
public void visitToken(DetailAST ast) {
final String text = ast.getText();
if (getRegexp().matcher(text).find()) {
String customMessage = message;
if (customMessage.isEmpty()) {
customMessage = MSG_KEY;
}
log(
ast.getLineNo(),
ast.getColumnNo(),
customMessage,
getFormat());
}
}
/**
* Setter for message property.
* @param message custom message which should be used
* to report about violations.
*/
public void setMessage(String message) {
if (message == null) {
this.message = "";
}
else {
this.message = message;
}
}
/**
* Set whether or not the match is case sensitive.
* @param caseInsensitive true if the match is case insensitive.
*/
public void setIgnoreCase(boolean caseInsensitive) {
if (caseInsensitive) {
setCompileFlags(Pattern.CASE_INSENSITIVE);
}
}
}
|
