1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20 package com.puppycrawl.tools.checkstyle.checks.coding;
21
22 import java.util.Objects;
23 import java.util.regex.Pattern;
24
25 import com.puppycrawl.tools.checkstyle.StatelessCheck;
26 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
27 import com.puppycrawl.tools.checkstyle.api.DetailAST;
28 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
29 import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
30
31
32
33
34
35
36
37
38
39 @StatelessCheck
40 public class IllegalTokenTextCheck
41 extends AbstractCheck {
42
43
44
45
46
47 public static final String MSG_KEY = "illegal.token.text";
48
49
50
51
52
53 private String message = "";
54
55
56 private String formatString = "^$";
57
58
59 private Pattern format = Pattern.compile(formatString);
60
61
62 private boolean ignoreCase;
63
64 @Override
65 public int[] getDefaultTokens() {
66 return CommonUtil.EMPTY_INT_ARRAY;
67 }
68
69 @Override
70 public int[] getAcceptableTokens() {
71 return new int[] {
72 TokenTypes.NUM_DOUBLE,
73 TokenTypes.NUM_FLOAT,
74 TokenTypes.NUM_INT,
75 TokenTypes.NUM_LONG,
76 TokenTypes.IDENT,
77 TokenTypes.COMMENT_CONTENT,
78 TokenTypes.STRING_LITERAL,
79 TokenTypes.CHAR_LITERAL,
80 TokenTypes.TEXT_BLOCK_CONTENT,
81 };
82 }
83
84 @Override
85 public int[] getRequiredTokens() {
86 return CommonUtil.EMPTY_INT_ARRAY;
87 }
88
89 @Override
90 public boolean isCommentNodesRequired() {
91 return true;
92 }
93
94 @Override
95 public void visitToken(DetailAST ast) {
96 final String text = ast.getText();
97 if (format.matcher(text).find()) {
98 String customMessage = message;
99 if (customMessage.isEmpty()) {
100 customMessage = MSG_KEY;
101 }
102 log(
103 ast,
104 customMessage,
105 formatString);
106 }
107 }
108
109
110
111
112
113
114
115
116
117 public void setMessage(String message) {
118 this.message = Objects.requireNonNullElse(message, "");
119 }
120
121
122
123
124
125
126
127 public void setFormat(String format) {
128 formatString = format;
129 updateRegexp();
130 }
131
132
133
134
135
136
137
138 public void setIgnoreCase(boolean caseInsensitive) {
139 ignoreCase = caseInsensitive;
140 updateRegexp();
141 }
142
143
144
145
146
147 private void updateRegexp() {
148 final int compileFlags;
149 if (ignoreCase) {
150 compileFlags = Pattern.CASE_INSENSITIVE;
151 }
152 else {
153 compileFlags = 0;
154 }
155 format = CommonUtil.createPattern(formatString, compileFlags);
156 }
157
158 }