2 <!DOCTYPE module PUBLIC
3 "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
4 "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
5 <module name="Checker">
6 <property name="charset" value="UTF-8"/>
7 <property name="severity" value="warning"/>
8 <property name="fileExtensions" value="java, properties, xml"/>
10 <!-- Excludes all 'module-info.java' files -->
11 <!-- See https://checkstyle.org/config_filefilters.html -->
12 <module name="BeforeExecutionExclusionFileFilter">
13 <property name="fileNamePattern" value="module\-info\.java$" />
15 <!-- https://checkstyle.org/config_filters.html#SuppressionFilter -->
16 <module name="SuppressionFilter">
17 <property name="file" value="${org.checkstyle.google.suppressionfilter.config}"
18 default="checkstyle-suppressions.xml" />
19 <property name="optional" value="true" />
22 <!-- Checks for whitespace -->
23 <!-- See http://checkstyle.org/config_whitespace.html -->
24 <module name="FileTabCharacter">
25 <property name="eachLine" value="true" />
28 <module name="LineLength">
29 <property name="fileExtensions" value="java" />
30 <property name="max" value="120" />
31 <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://" />
34 <module name="TreeWalker">
35 <module name="FinalLocalVariable">
36 <property name="tokens" value="VARIABLE_DEF,PARAMETER_DEF"/>
37 <property name="validateEnhancedForLoopVariable" value="true"/>
39 <module name="OuterTypeFilename" />
40 <module name="IllegalTokenText">
41 <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL" />
42 <property name="format"
43 value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)" />
44 <property name="message"
45 value="Consider using special escape sequence instead of octal value or Unicode escaped value." />
47 <module name="AvoidEscapedUnicodeCharacters">
48 <property name="allowEscapesForControlCharacters" value="true" />
49 <property name="allowByTailComment" value="true" />
50 <property name="allowNonPrintableEscapes" value="true" />
52 <module name="AvoidStarImport" />
53 <module name="OneTopLevelClass" />
54 <module name="NoLineWrap">
55 <property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT" />
57 <module name="EmptyBlock">
58 <property name="option" value="TEXT" />
59 <property name="tokens"
60 value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH" />
62 <module name="NeedBraces">
63 <property name="tokens" value="LITERAL_DO, LITERAL_ELSE, LITERAL_FOR, LITERAL_IF, LITERAL_WHILE" />
65 <module name="LeftCurly">
66 <property name="tokens"
67 value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF,
68 INTERFACE_DEF, LAMBDA, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT,
69 LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF,
70 LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF,
71 OBJBLOCK, STATIC_INIT" />
73 <module name="RightCurly">
74 <property name="id" value="RightCurlySame" />
75 <property name="tokens"
76 value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE,
79 <module name="RightCurly">
80 <property name="id" value="RightCurlyAlone" />
81 <property name="option" value="alone" />
82 <property name="tokens"
83 value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,
84 INSTANCE_INIT, ANNOTATION_DEF, ENUM_DEF" />
86 <module name="SuppressionXpathSingleFilter">
87 <!-- suppresion is required till https://github.com/checkstyle/checkstyle/issues/7541 -->
88 <property name="id" value="RightCurlyAlone" />
89 <property name="query"
90 value="//RCURLY[parent::SLIST[count(./*)=1]
91 or preceding-sibling::*[last()][self::LCURLY]]" />
93 <module name="WhitespaceAfter">
94 <property name="tokens"
95 value="COMMA, SEMI, TYPECAST, LITERAL_IF, LITERAL_ELSE,
96 LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, DO_WHILE" />
98 <module name="WhitespaceAround">
99 <property name="allowEmptyConstructors" value="true" />
100 <property name="allowEmptyLambdas" value="true" />
101 <property name="allowEmptyMethods" value="true" />
102 <property name="allowEmptyTypes" value="true" />
103 <property name="allowEmptyLoops" value="true" />
104 <property name="tokens"
105 value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR,
106 BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND,
107 LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY,
108 LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED,
109 LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN,
110 NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR,
111 SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND" />
112 <message key="ws.notFollowed"
113 value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)" />
114 <message key="ws.notPreceded" value="WhitespaceAround: ''{0}'' is not preceded with whitespace." />
116 <module name="OneStatementPerLine" />
117 <module name="MultipleVariableDeclarations" />
118 <module name="ArrayTypeStyle" />
119 <module name="MissingSwitchDefault" />
120 <module name="FallThrough" />
121 <module name="UpperEll" />
122 <module name="ModifierOrder" />
123 <module name="EmptyLineSeparator">
124 <property name="tokens"
125 value="PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
126 STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF" />
127 <property name="allowNoEmptyLineBetweenFields" value="true" />
129 <module name="SeparatorWrap">
130 <property name="id" value="SeparatorWrapDot" />
131 <property name="tokens" value="DOT" />
132 <property name="option" value="nl" />
134 <module name="SeparatorWrap">
135 <property name="id" value="SeparatorWrapComma" />
136 <property name="tokens" value="COMMA" />
137 <property name="option" value="EOL" />
139 <module name="SeparatorWrap">
140 <!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/258 -->
141 <property name="id" value="SeparatorWrapEllipsis" />
142 <property name="tokens" value="ELLIPSIS" />
143 <property name="option" value="EOL" />
145 <module name="SeparatorWrap">
146 <!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/259 -->
147 <property name="id" value="SeparatorWrapArrayDeclarator" />
148 <property name="tokens" value="ARRAY_DECLARATOR" />
149 <property name="option" value="EOL" />
151 <module name="SeparatorWrap">
152 <property name="id" value="SeparatorWrapMethodRef" />
153 <property name="tokens" value="METHOD_REF" />
154 <property name="option" value="nl" />
156 <module name="PackageName">
157 <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
158 <message key="name.invalidPattern" value="Package name ''{0}'' must match pattern ''{1}''." />
160 <module name="TypeName">
161 <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF" />
162 <message key="name.invalidPattern" value="Type name ''{0}'' must match pattern ''{1}''." />
164 <module name="MemberName">
165 <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$" />
166 <message key="name.invalidPattern" value="Member name ''{0}'' must match pattern ''{1}''." />
168 <module name="ParameterName">
169 <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$" />
170 <message key="name.invalidPattern" value="Parameter name ''{0}'' must match pattern ''{1}''." />
172 <module name="LambdaParameterName">
173 <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$" />
174 <message key="name.invalidPattern" value="Lambda parameter name ''{0}'' must match pattern ''{1}''." />
176 <module name="CatchParameterName">
177 <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$" />
178 <message key="name.invalidPattern" value="Catch parameter name ''{0}'' must match pattern ''{1}''." />
180 <module name="LocalVariableName">
181 <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$" />
182 <message key="name.invalidPattern" value="Local variable name ''{0}'' must match pattern ''{1}''." />
184 <module name="ClassTypeParameterName">
185 <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
186 <message key="name.invalidPattern" value="Class type name ''{0}'' must match pattern ''{1}''." />
188 <module name="MethodTypeParameterName">
189 <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
190 <message key="name.invalidPattern" value="Method type name ''{0}'' must match pattern ''{1}''." />
192 <module name="InterfaceTypeParameterName">
193 <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
194 <message key="name.invalidPattern" value="Interface type name ''{0}'' must match pattern ''{1}''." />
196 <module name="NoFinalizer" />
197 <module name="GenericWhitespace">
198 <message key="ws.followed" value="GenericWhitespace ''{0}'' is followed by whitespace." />
199 <message key="ws.preceded" value="GenericWhitespace ''{0}'' is preceded with whitespace." />
200 <message key="ws.illegalFollow" value="GenericWhitespace ''{0}'' should followed by whitespace." />
201 <message key="ws.notPreceded" value="GenericWhitespace ''{0}'' is not preceded with whitespace." />
203 <module name="Indentation">
204 <property name="basicOffset" value="4" />
205 <property name="braceAdjustment" value="0" />
206 <property name="caseIndent" value="4" />
207 <property name="throwsIndent" value="4" />
208 <property name="lineWrappingIndentation" value="4" />
209 <property name="arrayInitIndent" value="4" />
211 <module name="AbbreviationAsWordInName">
212 <property name="ignoreFinal" value="false" />
213 <property name="allowedAbbreviationLength" value="1" />
214 <property name="tokens"
215 value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF,
216 PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF" />
218 <module name="OverloadMethodsDeclarationOrder" />
219 <module name="VariableDeclarationUsageDistance" />
220 <module name="CustomImportOrder">
221 <property name="sortImportsInGroupAlphabetically" value="true" />
222 <property name="separateLineBetweenGroups" value="true" />
223 <property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE" />
224 <property name="tokens" value="IMPORT, STATIC_IMPORT, PACKAGE_DEF" />
226 <module name="MethodParamPad">
227 <property name="tokens"
228 value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF,
229 SUPER_CTOR_CALL, ENUM_CONSTANT_DEF" />
231 <module name="NoWhitespaceBefore">
232 <property name="tokens"
233 value="COMMA, SEMI, POST_INC, POST_DEC, DOT, ELLIPSIS,
234 LABELED_STAT, METHOD_REF" />
235 <property name="allowLineBreaks" value="true" />
237 <module name="ParenPad">
238 <property name="tokens"
239 value="ANNOTATION, ANNOTATION_FIELD_DEF, CTOR_CALL, CTOR_DEF, DOT, ENUM_CONSTANT_DEF,
240 EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW,
241 LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL,
242 METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA" />
244 <module name="OperatorWrap">
245 <property name="option" value="NL" />
246 <property name="tokens"
247 value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,
248 LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF " />
250 <module name="AnnotationLocation">
251 <property name="id" value="AnnotationLocationMostCases" />
252 <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF" />
254 <module name="AnnotationLocation">
255 <property name="id" value="AnnotationLocationVariables" />
256 <property name="tokens" value="VARIABLE_DEF" />
257 <property name="allowSamelineMultipleAnnotations" value="true" />
259 <module name="NonEmptyAtclauseDescription" />
260 <module name="InvalidJavadocPosition" />
261 <module name="JavadocTagContinuationIndentation" />
262 <module name="SummaryJavadoc">
263 <property name="forbiddenSummaryFragments"
264 value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )" />
266 <module name="JavadocParagraph" />
267 <module name="AtclauseOrder">
268 <property name="tagOrder" value="@param, @return, @throws, @deprecated" />
269 <property name="target"
270 value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF" />
272 <module name="JavadocMethod">
273 <property name="scope" value="public" />
274 <property name="allowMissingParamTags" value="true" />
275 <property name="allowMissingReturnTag" value="true" />
276 <property name="allowedAnnotations" value="Override, Test" />
277 <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF" />
279 <module name="MissingJavadocMethod">
280 <property name="scope" value="public" />
281 <property name="minLineCount" value="2" />
282 <property name="allowedAnnotations" value="Override, Test" />
283 <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF" />
284 <property name="ignoreMethodNamesRegex" value="^(test|before|after)[a-zA-Z0-9_]*$" />
286 <module name="MethodName">
287 <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$" />
288 <message key="name.invalidPattern" value="Method name ''{0}'' must match pattern ''{1}''." />
290 <module name="SingleLineJavadoc">
291 <property name="ignoreInlineTags" value="false" />
293 <module name="EmptyCatchBlock">
294 <property name="exceptionVariableName" value="expected" />
296 <module name="CommentsIndentation">
297 <property name="tokens" value="SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN" />
299 <!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter -->
300 <module name="SuppressionXpathFilter">
301 <property name="file" value="${org.checkstyle.google.suppressionxpathfilter.config}"
302 default="checkstyle-xpath-suppressions.xml" />
303 <property name="optional" value="true" />
305 <module name="UnusedImports"/>