1+ <!DOCTYPE module SYSTEM "http://checkstyle.sourceforge.net/dtds/configuration_1_3.dtd">
2+ <!--
3+ Checkstyle configuration that checks the Google coding conventions from Google Java Style
4+ that can be found at https://google.github.io/styleguide/javaguide.html.
5+
6+ Checkstyle is very configurable. Be sure to read the documentation at
7+ http://checkstyle.sf.net (or in your downloaded distribution).
8+
9+ To completely disable a check, just comment it out or delete it from the file.
10+
11+ Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
12+ -->
13+ <module name =" Checker" >
14+ <property name =" charset" value =" UTF-8" />
15+ <property name =" severity" value =" warning" />
16+ <property name =" fileExtensions" value =" java, properties, xml" />
17+ <!-- Checks for whitespace -->
18+ <!-- See http://checkstyle.sf.net/config_whitespace.html -->
19+ <module name =" FileTabCharacter" >
20+ <property name =" eachLine" value =" true" />
21+ </module >
22+ <module name =" TreeWalker" >
23+ <module name =" OuterTypeFilename" />
24+ <module name =" IllegalTokenText" >
25+ <property name =" tokens" value =" STRING_LITERAL, CHAR_LITERAL" />
26+ <property name =" format" 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)" />
27+ <property name =" message" value =" Consider using special escape sequence instead of octal value or Unicode escaped value." />
28+ </module >
29+ <module name =" AvoidEscapedUnicodeCharacters" >
30+ <property name =" allowEscapesForControlCharacters" value =" true" />
31+ <property name =" allowByTailComment" value =" true" />
32+ <property name =" allowNonPrintableEscapes" value =" true" />
33+ </module >
34+ <module name =" LineLength" >
35+ <property name =" max" value =" 180" />
36+ <property name =" ignorePattern" value =" ^package.*|^import.*|a href|href|http://|https://|ftp://" />
37+ </module >
38+ <!-- <module name="AvoidStarImport"/>-->
39+ <module name =" OneTopLevelClass" />
40+ <module name =" NoLineWrap" />
41+ <module name =" EmptyBlock" >
42+ <property name =" option" value =" TEXT" />
43+ <property name =" tokens" value =" LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH" />
44+ </module >
45+ <module name =" NeedBraces" />
46+ <module name =" LeftCurly" />
47+ <module name =" RightCurly" >
48+ <property name =" id" value =" RightCurlySame" />
49+ <property name =" tokens" value =" LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_DO" />
50+ </module >
51+ <module name =" RightCurly" >
52+ <property name =" id" value =" RightCurlyAlone" />
53+ <property name =" option" value =" alone" />
54+ <property name =" tokens" value =" CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT, INSTANCE_INIT" />
55+ </module >
56+ <module name =" WhitespaceAround" >
57+ <property name =" allowEmptyConstructors" value =" true" />
58+ <property name =" allowEmptyMethods" value =" true" />
59+ <property name =" allowEmptyTypes" value =" true" />
60+ <property name =" allowEmptyLoops" value =" true" />
61+ <message key =" ws.notFollowed" 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)" />
62+ <message key =" ws.notPreceded" value =" WhitespaceAround: ''{0}'' is not preceded with whitespace." />
63+ </module >
64+ <module name =" OneStatementPerLine" />
65+ <module name =" MultipleVariableDeclarations" />
66+ <module name =" ArrayTypeStyle" />
67+ <module name =" MissingSwitchDefault" />
68+ <module name =" FallThrough" />
69+ <module name =" UpperEll" />
70+ <module name =" ModifierOrder" />
71+ <module name =" EmptyLineSeparator" >
72+ <property name =" allowNoEmptyLineBetweenFields" value =" true" />
73+ </module >
74+ <module name =" SeparatorWrap" >
75+ <property name =" id" value =" SeparatorWrapDot" />
76+ <property name =" tokens" value =" DOT" />
77+ <property name =" option" value =" nl" />
78+ </module >
79+ <module name =" SeparatorWrap" >
80+ <property name =" id" value =" SeparatorWrapComma" />
81+ <property name =" tokens" value =" COMMA" />
82+ <property name =" option" value =" EOL" />
83+ </module >
84+ <module name =" SeparatorWrap" >
85+ <!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/258 -->
86+ <property name =" id" value =" SeparatorWrapEllipsis" />
87+ <property name =" tokens" value =" ELLIPSIS" />
88+ <property name =" option" value =" EOL" />
89+ </module >
90+ <module name =" SeparatorWrap" >
91+ <!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/259 -->
92+ <property name =" id" value =" SeparatorWrapArrayDeclarator" />
93+ <property name =" tokens" value =" ARRAY_DECLARATOR" />
94+ <property name =" option" value =" EOL" />
95+ </module >
96+ <module name =" SeparatorWrap" >
97+ <property name =" id" value =" SeparatorWrapMethodRef" />
98+ <property name =" tokens" value =" METHOD_REF" />
99+ <property name =" option" value =" nl" />
100+ </module >
101+ <module name =" PackageName" >
102+ <property name =" format" value =" ^[a-z]+(\.[a-z][a-z0-9]*)*$" />
103+ <message key =" name.invalidPattern" value =" Package name ''{0}'' must match pattern ''{1}''." />
104+ </module >
105+ <module name =" TypeName" >
106+ <message key =" name.invalidPattern" value =" Type name ''{0}'' must match pattern ''{1}''." />
107+ </module >
108+ <module name =" MemberName" >
109+ <property name =" format" value =" ^[a-z][a-z0-9][a-zA-Z0-9]*$" />
110+ <message key =" name.invalidPattern" value =" Member name ''{0}'' must match pattern ''{1}''." />
111+ </module >
112+ <module name =" ParameterName" >
113+ <property name =" format" value =" ^[a-z]([a-z0-9][a-zA-Z0-9]*)?$" />
114+ <message key =" name.invalidPattern" value =" Parameter name ''{0}'' must match pattern ''{1}''." />
115+ </module >
116+ <module name =" CatchParameterName" >
117+ <property name =" format" value =" ^[a-z]([a-z0-9][a-zA-Z0-9]*)?$" />
118+ <message key =" name.invalidPattern" value =" Catch parameter name ''{0}'' must match pattern ''{1}''." />
119+ </module >
120+ <module name =" LocalVariableName" >
121+ <property name =" tokens" value =" VARIABLE_DEF" />
122+ <property name =" format" value =" ^[a-z]([a-z0-9][a-zA-Z0-9]*)?$" />
123+ <message key =" name.invalidPattern" value =" Local variable name ''{0}'' must match pattern ''{1}''." />
124+ </module >
125+ <module name =" ClassTypeParameterName" >
126+ <property name =" format" value =" (^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
127+ <message key =" name.invalidPattern" value =" Class type name ''{0}'' must match pattern ''{1}''." />
128+ </module >
129+ <module name =" MethodTypeParameterName" >
130+ <property name =" format" value =" (^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
131+ <message key =" name.invalidPattern" value =" Method type name ''{0}'' must match pattern ''{1}''." />
132+ </module >
133+ <module name =" InterfaceTypeParameterName" >
134+ <property name =" format" value =" (^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
135+ <message key =" name.invalidPattern" value =" Interface type name ''{0}'' must match pattern ''{1}''." />
136+ </module >
137+ <module name =" NoFinalizer" />
138+ <module name =" GenericWhitespace" >
139+ <message key =" ws.followed" value =" GenericWhitespace ''{0}'' is followed by whitespace." />
140+ <message key =" ws.preceded" value =" GenericWhitespace ''{0}'' is preceded with whitespace." />
141+ <message key =" ws.illegalFollow" value =" GenericWhitespace ''{0}'' should followed by whitespace." />
142+ <message key =" ws.notPreceded" value =" GenericWhitespace ''{0}'' is not preceded with whitespace." />
143+ </module >
144+ <module name =" Indentation" >
145+ <property name =" basicOffset" value =" 4" />
146+ <property name =" braceAdjustment" value =" 0" />
147+ <property name =" caseIndent" value =" 4" />
148+ <property name =" throwsIndent" value =" 8" />
149+ <property name =" lineWrappingIndentation" value =" 4" />
150+ <property name =" arrayInitIndent" value =" 4" />
151+ </module >
152+ <module name =" AbbreviationAsWordInName" >
153+ <property name =" ignoreFinal" value =" false" />
154+ <property name =" allowedAbbreviationLength" value =" 1" />
155+ </module >
156+ <module name =" OverloadMethodsDeclarationOrder" />
157+ <module name =" VariableDeclarationUsageDistance" />
158+ <!-- <module name="CustomImportOrder">-->
159+ <!-- <property name="sortImportsInGroupAlphabetically" value="true"/>-->
160+ <!-- <property name="separateLineBetweenGroups" value="true"/>-->
161+ <!-- <property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>-->
162+ <!-- </module>-->
163+ <module name =" MethodParamPad" />
164+ <module name =" ParenPad" />
165+ <module name =" OperatorWrap" >
166+ <property name =" option" value =" NL" />
167+ <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, METHOD_REF " />
168+ </module >
169+ <module name =" AnnotationLocation" >
170+ <property name =" id" value =" AnnotationLocationMostCases" />
171+ <property name =" tokens" value =" CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF" />
172+ </module >
173+ <module name =" AnnotationLocation" >
174+ <property name =" id" value =" AnnotationLocationVariables" />
175+ <property name =" tokens" value =" VARIABLE_DEF" />
176+ <property name =" allowSamelineMultipleAnnotations" value =" true" />
177+ </module >
178+ <module name =" NonEmptyAtclauseDescription" />
179+ <module name =" JavadocTagContinuationIndentation" />
180+ <!-- <module name="JavadocParagraph"/>-->
181+ <module name =" SummaryJavadoc" >
182+ <property name =" forbiddenSummaryFragments" value =" ^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )" />
183+ </module >
184+ <module name =" AtclauseOrder" >
185+ <property name =" tagOrder" value =" @param, @return, @throws, @deprecated" />
186+ <property name =" target" value =" CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF" />
187+ </module >
188+ <module name =" JavadocMethod" >
189+ <property name =" scope" value =" public" />
190+ <property name =" allowMissingParamTags" value =" true" />
191+ <property name =" allowMissingThrowsTags" value =" true" />
192+ <property name =" allowMissingReturnTag" value =" true" />
193+ <property name =" minLineCount" value =" 2" />
194+ <property name =" allowedAnnotations" value =" Override, Test" />
195+ <property name =" allowThrowsTagsForSubclasses" value =" true" />
196+ </module >
197+ <module name =" MethodName" >
198+ <property name =" format" value =" ^[a-z][a-z0-9][a-zA-Z0-9_]*$" />
199+ <message key =" name.invalidPattern" value =" Method name ''{0}'' must match pattern ''{1}''." />
200+ </module >
201+ <module name =" SingleLineJavadoc" >
202+ <property name =" ignoreInlineTags" value =" false" />
203+ </module >
204+ <module name =" EmptyCatchBlock" >
205+ <property name =" exceptionVariableName" value =" expected" />
206+ </module >
207+ <module name =" CommentsIndentation" />
208+ </module >
209+ </module >
0 commit comments