FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
DataflowJavaSDK/checkstyle.xml at master · dweitzman/DataflowJavaSDK · GitHub
dweitzman
DataflowJavaSDK
Repository navigation
Code
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
DataflowJavaSDK
/
checkstyle.xml
Copy path
More file actions
More file actions
Latest commit
History
History
History
458 lines (381 loc) · 16.7 KB
Breadcrumbs
DataflowJavaSDK
/
checkstyle.xml
Copy path
File metadata and controls
458 lines (381 loc) · 16.7 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
<?
xml
version
=
"
1.0
"
encoding
=
"
UTF-8
"
?>
<!--
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~ Copyright (C) 2015 Google Inc.
~
~ Licensed under the Apache License, Version 2.0 (the "License"); you may not
~ use this file except in compliance with the License. You may obtain a copy of
~ the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing, software
~ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
~ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
~ License for the specific language governing permissions and limitations under
~ the License.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-->
<!
DOCTYPE
module
PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<!--
This is a checkstyle configuration file. For descriptions of
what the following rules do, please see the checkstyle configuration
page at http://checkstyle.sourceforge.net/config.html
-->
<
module
name
=
"
Checker
"
>
<
module
name
=
"
RegexpSingleline
"
>
<!--
Requires a Google copyright notice in each file.
Code intended to be open-sourced may have a multi-line copyright
notice, so that this required text appears on the second line:
<pre>
/*
* Copyright 2015 Google Inc.
*
* (details of open-source license...)
</pre>
-->
<
property
name
=
"
format
"
value
=
"
^(//| \*) Copyright (\([cC]\) )?[\d]{4}(\-[\d]{4})? (Google Inc\.|The Google Cloud Dataflow.*Authors).*$
"
/>
<
property
name
=
"
minimum
"
value
=
"
1
"
/>
<
property
name
=
"
maximum
"
value
=
"
10
"
/>
<
property
name
=
"
message
"
value
=
"
Google copyright is missing or malformed.
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
FileTabCharacter
"
>
<!--
Checks that there are no tab characters in the file.
-->
</
module
>
<
module
name
=
"
NewlineAtEndOfFile
"
/>
<
module
name
=
"
RegexpSingleline
"
>
<!--
Checks that TODOs don't have stuff in parenthesis, e.g., username.
-->
<
property
name
=
"
format
"
value
=
"
((//.*)|(\*.*))TODO\(
"
/>
<
property
name
=
"
message
"
value
=
"
TODO comments must not include usernames.
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
RegexpSingleline
"
>
<
property
name
=
"
format
"
value
=
"
[ \t]+$
"
/>
<
property
name
=
"
message
"
value
=
"
Trailing whitespace
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
RegexpSingleline
"
>
<!--
Checks that FIXME is not used in comments.
-->
<
property
name
=
"
format
"
value
=
"
((//.*)|(\*.*))FIXME
"
/>
<
property
name
=
"
message
"
value
=
'
FIXME should not appear in comments.
'
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
RegexpSingleline
"
>
<!--
Checks that XXX is not used in comments.
-->
<
property
name
=
"
format
"
value
=
"
((//.*)|(\*.*))XXX
"
/>
<
property
name
=
"
message
"
value
=
'
XXX should not appear in comments.
'
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
RegexpSingleline
"
>
<!--
Checks that Throwables.propagate is not used.
-->
<
property
name
=
"
format
"
value
=
"
Throwables.propagate\(
"
/>
<
property
name
=
"
message
"
value
=
'
Throwables.propagate is deprecated.
'
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<!--
Allow use of comment to suppress javadocstyle
-->
<
module
name
=
"
SuppressionCommentFilter
"
>
<
property
name
=
"
offCommentFormat
"
value
=
"
CHECKSTYLE.OFF\: ([\w\|]+)
"
/>
<
property
name
=
"
onCommentFormat
"
value
=
"
CHECKSTYLE.ON\: ([\w\|]+)
"
/>
<
property
name
=
"
checkFormat
"
value
=
"
$1
"
/>
</
module
>
<!--
All Java AST specific tests live under TreeWalker module.
-->
<
module
name
=
"
TreeWalker
"
>
<
module
name
=
"
TodoComment
"
>
<
metadata
name
=
"
com.atlassw.tools.eclipse.checkstyle.comment
"
value
=
"
Author tags not allowed
"
/>
<
property
name
=
"
format
"
value
=
"
@author
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<!--
IMPORT CHECKS
-->
<
module
name
=
"
RedundantImport
"
>
<!--
Checks for redundant import statements.
-->
<
property
name
=
"
severity
"
value
=
"
error
"
/>
<
message
key
=
"
import.redundancy
"
value
=
"
Redundant import {0}.
"
/>
</
module
>
<
module
name
=
"
ImportOrder
"
>
<!--
Checks for out of order import statements.
-->
<
property
name
=
"
severity
"
value
=
"
error
"
/>
<
property
name
=
"
groups
"
value
=
"
com.google,android,com,io,Jama,junit,net,org,sun,java,javax
"
/>
<!--
This ensures that static imports go first.
-->
<
property
name
=
"
option
"
value
=
"
top
"
/>
<
property
name
=
"
tokens
"
value
=
"
STATIC_IMPORT, IMPORT
"
/>
<
message
key
=
"
import.ordering
"
value
=
"
Import {0} appears after other imports that it should precede
"
/>
</
module
>
<
module
name
=
"
AvoidStarImport
"
>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
IllegalImport
"
>
<
property
name
=
"
illegalPkgs
"
value
=
"
avro.shaded, com.google.api.client.repackaged, com.google.appengine.repackaged, org.apache.beam
"
/>
</
module
>
<
module
name
=
"
RedundantModifier
"
>
<!--
Checks for redundant modifiers on various symbol definitions.
See: http://checkstyle.sourceforge.net/config_modifier.html#RedundantModifier
-->
<
property
name
=
"
tokens
"
value
=
"
METHOD_DEF, VARIABLE_DEF, ANNOTATION_FIELD_DEF, INTERFACE_DEF, CLASS_DEF, ENUM_DEF
"
/>
</
module
>
<!--
IllegalImport cannot blacklist classes, and c.g.api.client.util is used for some shaded
code and some useful code. So we need to fall back to Regexp.
-->
<
module
name
=
"
RegexpSinglelineJava
"
>
<
property
name
=
"
format
"
value
=
"
com\.google\.api\.client\.util\.(ByteStreams|Charsets|Collections2|Joiner|Lists|Maps|Objects|Preconditions|Sets|Strings|Throwables)
"
/>
</
module
>
<!--
Require static importing from Preconditions.
-->
<
module
name
=
"
RegexpSinglelineJava
"
>
<
property
name
=
"
format
"
value
=
"
^import com.google.common.base.Preconditions;$
"
/>
<
property
name
=
"
message
"
value
=
"
Static import functions from Guava Preconditions
"
/>
</
module
>
<
module
name
=
"
UnusedImports
"
>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
<
property
name
=
"
processJavadoc
"
value
=
"
true
"
/>
<
message
key
=
"
import.unused
"
value
=
"
Unused import: {0}.
"
/>
</
module
>
<!--
JAVADOC CHECKS
-->
<!--
Checks for Javadoc comments.
-->
<!--
See http://checkstyle.sf.net/config_javadoc.html
-->
<
module
name
=
"
JavadocMethod
"
>
<
property
name
=
"
scope
"
value
=
"
protected
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
<
property
name
=
"
allowMissingJavadoc
"
value
=
"
true
"
/>
<
property
name
=
"
allowMissingParamTags
"
value
=
"
true
"
/>
<
property
name
=
"
allowMissingReturnTag
"
value
=
"
true
"
/>
<
property
name
=
"
allowMissingThrowsTags
"
value
=
"
true
"
/>
<
property
name
=
"
allowThrowsTagsForSubclasses
"
value
=
"
true
"
/>
<
property
name
=
"
allowUndeclaredRTE
"
value
=
"
true
"
/>
</
module
>
<!--
Check that paragraph tags are used correctly in Javadoc.
-->
<
module
name
=
"
JavadocParagraph
"
/>
<
module
name
=
"
JavadocType
"
>
<
property
name
=
"
scope
"
value
=
"
protected
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
<
property
name
=
"
allowMissingParamTags
"
value
=
"
true
"
/>
</
module
>
<
module
name
=
"
JavadocStyle
"
>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
<
property
name
=
"
checkHtml
"
value
=
"
true
"
/>
</
module
>
<!--
NAMING CHECKS
-->
<!--
Item 38 - Adhere to generally accepted naming conventions
-->
<
module
name
=
"
PackageName
"
>
<!--
Validates identifiers for package names against the
supplied expression.
-->
<!--
Here the default checkstyle rule restricts package name parts to
seven characters, this is not in line with common practice at Google.
-->
<
property
name
=
"
format
"
value
=
"
^[a-z]+(\.[a-z][a-z0-9]{1,})*$
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
TypeNameCheck
"
>
<!--
Validates static, final fields against the
expression "^[A-Z][a-zA-Z0-9]*$".
-->
<
metadata
name
=
"
altname
"
value
=
"
TypeName
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
ConstantNameCheck
"
>
<!--
Validates non-private, static, final fields against the supplied
public/package final fields "^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$".
-->
<
metadata
name
=
"
altname
"
value
=
"
ConstantName
"
/>
<
property
name
=
"
applyToPublic
"
value
=
"
true
"
/>
<
property
name
=
"
applyToProtected
"
value
=
"
true
"
/>
<
property
name
=
"
applyToPackage
"
value
=
"
true
"
/>
<
property
name
=
"
applyToPrivate
"
value
=
"
false
"
/>
<
property
name
=
"
format
"
value
=
"
^([A-Z][A-Z0-9]*(_[A-Z0-9]+)*|FLAG_.*)$
"
/>
<
message
key
=
"
name.invalidPattern
"
value
=
"
Variable ''{0}'' should be in ALL_CAPS (if it is a constant) or be private (otherwise).
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
StaticVariableNameCheck
"
>
<!--
Validates static, non-final fields against the supplied
expression "^[a-z][a-zA-Z0-9]*_?$".
-->
<
metadata
name
=
"
altname
"
value
=
"
StaticVariableName
"
/>
<
property
name
=
"
applyToPublic
"
value
=
"
true
"
/>
<
property
name
=
"
applyToProtected
"
value
=
"
true
"
/>
<
property
name
=
"
applyToPackage
"
value
=
"
true
"
/>
<
property
name
=
"
applyToPrivate
"
value
=
"
true
"
/>
<
property
name
=
"
format
"
value
=
"
^[a-z][a-zA-Z0-9]*_?$
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
MemberNameCheck
"
>
<!--
Validates non-static members against the supplied expression.
-->
<
metadata
name
=
"
altname
"
value
=
"
MemberName
"
/>
<
property
name
=
"
applyToPublic
"
value
=
"
true
"
/>
<
property
name
=
"
applyToProtected
"
value
=
"
true
"
/>
<
property
name
=
"
applyToPackage
"
value
=
"
true
"
/>
<
property
name
=
"
applyToPrivate
"
value
=
"
true
"
/>
<
property
name
=
"
format
"
value
=
"
^[a-z][a-zA-Z0-9]*$
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
MethodNameCheck
"
>
<!--
Validates identifiers for method names.
-->
<
metadata
name
=
"
altname
"
value
=
"
MethodName
"
/>
<
property
name
=
"
format
"
value
=
"
^[a-z][a-zA-Z0-9]*(_[a-zA-Z0-9]+)*$
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
ParameterName
"
>
<!--
Validates identifiers for method parameters against the
expression "^[a-z][a-zA-Z0-9]*$".
-->
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
LocalFinalVariableName
"
>
<!--
Validates identifiers for local final variables against the
expression "^[a-z][a-zA-Z0-9]*$".
-->
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
LocalVariableName
"
>
<!--
Validates identifiers for local variables against the
expression "^[a-z][a-zA-Z0-9]*$".
-->
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<!--
Type parameters must be either one of the four blessed letters
T, K, V, W, X or else be capital-case terminated with a T,
such as MyGenericParameterT
-->
<
module
name
=
"
ClassTypeParameterName
"
>
<
property
name
=
"
format
"
value
=
"
^(((T|K|V|W|X)[0-9]*)|([A-Z][a-z][a-zA-Z]*T))$
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
MethodTypeParameterName
"
>
<
property
name
=
"
format
"
value
=
"
^(((T|K|V|W|X)[0-9]*)|([A-Z][a-z][a-zA-Z]*T))$
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
InterfaceTypeParameterName
"
>
<
property
name
=
"
format
"
value
=
"
^(((T|K|V|W|X)[0-9]*)|([A-Z][a-z][a-zA-Z]*T))$
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<!--
LENGTH and CODING CHECKS
-->
<
module
name
=
"
LineLength
"
>
<!--
Checks if a line is too long.
-->
<
property
name
=
"
max
"
value
=
"
${com.puppycrawl.tools.checkstyle.checks.sizes.LineLength.max}
"
default
=
"
100
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
<!--
The default ignore pattern exempts the following elements:
- import statements
- long URLs inside comments
-->
<
property
name
=
"
ignorePattern
"
value
=
"
${com.puppycrawl.tools.checkstyle.checks.sizes.LineLength.ignorePattern}
"
default
=
"
^(package .*;\s*)|(import .*;\s*)|( *\* .*https?://.*)$
"
/>
</
module
>
<
module
name
=
"
LeftCurly
"
>
<!--
Checks for placement of the left curly brace ('{').
-->
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
RightCurly
"
>
<!--
Checks right curlies on CATCH, ELSE, and TRY blocks are on
the same line. e.g., the following example is fine:
<pre>
if {
...
} else
</pre>
-->
<!--
This next example is not fine:
<pre>
if {
...
}
else
</pre>
-->
<
property
name
=
"
option
"
value
=
"
same
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<!--
Checks for braces around if and else blocks
-->
<
module
name
=
"
NeedBraces
"
>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
<
property
name
=
"
tokens
"
value
=
"
LITERAL_IF, LITERAL_ELSE, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO
"
/>
</
module
>
<
module
name
=
"
UpperEll
"
>
<!--
Checks that long constants are defined with an upper ell.
-->
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
FallThrough
"
>
<!--
Warn about falling through to the next case statement. Similar to
javac -Xlint:fallthrough, but the check is suppressed if a single-line comment
on the last non-blank line preceding the fallen-into case contains 'fall through' (or
some other variants that we don't publicized to promote consistency).
-->
<
property
name
=
"
reliefPattern
"
value
=
"
fall through|Fall through|fallthru|Fallthru|falls through|Falls through|fallthrough|Fallthrough|No break|NO break|no break|continue on
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<!--
MODIFIERS CHECKS
-->
<
module
name
=
"
ModifierOrder
"
>
<!--
Warn if modifier order is inconsistent with JLS3 8.1.1, 8.3.1, and
8.4.3. The prescribed order is:
public, protected, private, abstract, static, final, transient, volatile,
synchronized, native, strictfp
-->
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<!--
WHITESPACE CHECKS
-->
<
module
name
=
"
WhitespaceAround
"
>
<!--
Checks that various tokens are surrounded by whitespace.
This includes most binary operators and keywords followed
by regular or curly braces.
-->
<
property
name
=
"
tokens
"
value
=
"
ASSIGN, BAND, BAND_ASSIGN, BOR,
BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN,
EQUAL, GE, GT, LAND, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE,
LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN,
LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS,
MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION,
SL, SL_ASSIGN, SR_ASSIGN, STAR, STAR_ASSIGN
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
WhitespaceAfter
"
>
<!--
Checks that commas, semicolons and typecasts are followed by
whitespace.
-->
<
property
name
=
"
tokens
"
value
=
"
COMMA, SEMI, TYPECAST
"
/>
</
module
>
<
module
name
=
"
NoWhitespaceAfter
"
>
<!--
Checks that there is no whitespace after various unary operators.
Linebreaks are allowed.
-->
<
property
name
=
"
tokens
"
value
=
"
BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS,
UNARY_PLUS
"
/>
<
property
name
=
"
allowLineBreaks
"
value
=
"
true
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
NoWhitespaceBefore
"
>
<!--
Checks that there is no whitespace before various unary operators.
Linebreaks are allowed.
-->
<
property
name
=
"
tokens
"
value
=
"
SEMI, DOT, POST_DEC, POST_INC
"
/>
<
property
name
=
"
allowLineBreaks
"
value
=
"
true
"
/>
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<
module
name
=
"
OperatorWrap
"
>
<!--
Checks that operators like + and ? appear at newlines rather than
at the end of the previous line.
-->
<
property
name
=
"
option
"
value
=
"
NL
"
/>
<
property
name
=
"
tokens
"
value
=
"
BAND, BOR, BSR, BXOR, DIV, EQUAL,
GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD,
NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR
"
/>
</
module
>
<
module
name
=
"
ParenPad
"
>
<!--
Checks that there is no whitespace before close parens or after
open parens.
-->
<
property
name
=
"
severity
"
value
=
"
error
"
/>
</
module
>
<!--
Required to support SuppressWarningsComment
-->
<
module
name
=
"
FileContentsHolder
"
/>
</
module
>
</
module
>
Back
|
FazBrowse Home
|
New Git URL