checkstyle.xml 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357
  1. <?xml version="1.0"?>
  2. <!DOCTYPE module PUBLIC
  3. "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
  4. "https://checkstyle.org/dtds/configuration_1_3.dtd">
  5. <module name = "Checker">
  6. <property name="charset" value="UTF-8"/>
  7. <property name="severity" value="error"/>
  8. <property name="fileExtensions" value="java"/>
  9. <!-- See https://checkstyle.org/config_filefilters.html -->
  10. <module name="BeforeExecutionExclusionFileFilter">
  11. <property name="fileNamePattern" value=".*dataobject |.*Test.*$"/>
  12. </module>
  13. <module name="TreeWalker">
  14. <module name="EmptyLineSeparator">
  15. <property name="allowMultipleEmptyLines" value="false"/>
  16. <property name="tokens" value="METHOD_DEF"/>
  17. </module>
  18. </module>
  19. <module name="SuppressionFilter">
  20. <property name="file" value="check/checkstyle/suppressions.xml"/>
  21. <property name="optional" value="true"/>
  22. </module>
  23. <module name="SuppressWithPlainTextCommentFilter">
  24. <property name="offCommentFormat" value="CHECKSTYLE OFF"/>
  25. <property name="onCommentFormat" value="CHECKSTYLE ON"/>
  26. </module>
  27. <module name="FileTabCharacter">
  28. <property name="eachLine" value="true"/>
  29. </module>
  30. <module name="LineLength">
  31. <property name="fileExtensions" value="java"/>
  32. <property name="max" value="150"/>
  33. <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
  34. </module>
  35. <module name="RegexpSingleline">
  36. <property name="format" value="&lt;&lt;&lt;&lt;&lt;&lt;&lt;"/>
  37. <property name="message" value="Merge conflicts unresolved."/>
  38. </module>
  39. <module name="RegexpSingleline">
  40. <property name="format" value="\s+$"/>
  41. <property name="message" value="Trailing whitespace found."/>
  42. <property name="fileExtensions" value=".java"/>
  43. </module>
  44. <module name="TreeWalker">
  45. <!-- filter -->
  46. <module name="SuppressWithNearbyCommentFilter">
  47. <property name="commentFormat" value="CHECKSTYLE IGNORE THIS LINE"/>
  48. </module>
  49. <!-- Annotations -->
  50. <module name="AnnotationLocation">
  51. <property name="id" value="AnnotationLocationMostCases"/>
  52. <property name="tokens"
  53. value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF,
  54. RECORD_DEF, COMPACT_CTOR_DEF"/>
  55. </module>
  56. <module name="AnnotationLocation">
  57. <property name="id" value="AnnotationLocationVariables"/>
  58. <property name="tokens" value="VARIABLE_DEF"/>
  59. <property name="allowSamelineMultipleAnnotations" value="true"/>
  60. </module>
  61. <module name="MissingOverride"/>
  62. <!-- Block Checks -->
  63. <module name="EmptyBlock">
  64. <property name="option" value="TEXT"/>
  65. <property name="tokens"
  66. value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
  67. </module>
  68. <module name="EmptyCatchBlock">
  69. <property name="exceptionVariableName" value="expected"/>
  70. </module>
  71. <module name="NeedBraces">
  72. <property name="tokens"
  73. value="LITERAL_DO, LITERAL_ELSE, LITERAL_FOR, LITERAL_IF, LITERAL_WHILE"/>
  74. </module>
  75. <module name="LeftCurly">
  76. <property name="tokens"
  77. value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF,
  78. INTERFACE_DEF, LAMBDA, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT,
  79. LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF,
  80. LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF,
  81. OBJBLOCK, STATIC_INIT, RECORD_DEF, COMPACT_CTOR_DEF"/>
  82. </module>
  83. <module name="RightCurly">
  84. <property name="id" value="RightCurlySame"/>
  85. <property name="tokens"
  86. value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE,
  87. LITERAL_DO"/>
  88. </module>
  89. <module name="RightCurly">
  90. <property name="id" value="RightCurlyAlone"/>
  91. <property name="option" value="alone"/>
  92. <property name="tokens"
  93. value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,
  94. INSTANCE_INIT, ANNOTATION_DEF, ENUM_DEF, INTERFACE_DEF, RECORD_DEF,
  95. COMPACT_CTOR_DEF"/>
  96. </module>
  97. <module name="SuppressionXpathSingleFilter">
  98. <!-- suppresion is required till https://github.com/checkstyle/checkstyle/issues/7541 -->
  99. <property name="id" value="RightCurlyAlone"/>
  100. <property name="query" value="//RCURLY[parent::SLIST[count(./*)=1]
  101. or preceding-sibling::*[last()][self::LCURLY]]"/>
  102. </module>
  103. <!-- Class Design -->
  104. <module name="OneTopLevelClass"/>
  105. <!-- Coding -->
  106. <!-- <module name="DeclarationOrder"/>-->
  107. <module name="FallThrough"/>
  108. <module name="IllegalTokenText">
  109. <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
  110. <property name="format"
  111. 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)"/>
  112. <property name="message"
  113. value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
  114. </module>
  115. <module name="MissingSwitchDefault"/>
  116. <module name="MultipleVariableDeclarations"/>
  117. <module name="NoFinalizer"/>
  118. <module name="OneStatementPerLine"/>
  119. <module name="OverloadMethodsDeclarationOrder"/>
  120. <module name="StringLiteralEquality"/>
  121. <module name="UnusedLocalVariable"/>
  122. <!-- Headers -->
  123. <!-- Imports -->
  124. <module name="AvoidStarImport"/>
  125. <module name="RedundantImport"/>
  126. <module name="UnusedImports"/>
  127. <module name="EmptyStatement"/>
  128. <!-- Disallow the use of commons-lang -->
  129. <module name="Regexp">
  130. <property name="format" value="org\.apache\.commons\.lang\."/>
  131. <property name="illegalPattern" value="true"/>
  132. <property name="message" value="Use commons-lang3 instead of commons-lang."/>
  133. </module>
  134. <!-- Metrics -->
  135. <!-- Miscellaneous -->
  136. <module name="ArrayTypeStyle"/>
  137. <module name="AvoidEscapedUnicodeCharacters">
  138. <property name="allowEscapesForControlCharacters" value="true"/>
  139. <property name="allowByTailComment" value="true"/>
  140. <property name="allowNonPrintableEscapes" value="true"/>
  141. </module>
  142. <module name="CommentsIndentation">
  143. <property name="tokens" value="SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN"/>
  144. </module>
  145. <!-- <module name="Indentation">-->
  146. <!-- <property name="basicOffset" value="4"/>-->
  147. <!-- <property name="braceAdjustment" value="0"/>-->
  148. <!-- <property name="caseIndent" value="4"/>-->
  149. <!-- <property name="throwsIndent" value="4"/>-->
  150. <!-- <property name="lineWrappingIndentation" value="4"/>-->
  151. <!-- <property name="arrayInitIndent" value="4"/>-->
  152. <!-- </module>-->
  153. <module name="OuterTypeFilename"/>
  154. <module name="UpperEll"/>
  155. <!-- Modifiers -->
  156. <module name="ModifierOrder"/>
  157. <!-- Naming Conventions -->
  158. <module name="AbbreviationAsWordInName">
  159. <property name="ignoreFinal" value="false"/>
  160. <property name="allowedAbbreviationLength" value="4"/>
  161. <property name="tokens"
  162. value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF,
  163. PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, PATTERN_VARIABLE_DEF, RECORD_DEF,
  164. RECORD_COMPONENT_DEF"/>
  165. </module>
  166. <module name="CatchParameterName">
  167. <property name="format" value="^([a-z0-9][a-zA-Z0-9]*)?$"/>
  168. <message key="name.invalidPattern"
  169. value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
  170. </module>
  171. <module name="ClassTypeParameterName">
  172. <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*$)"/>
  173. <message key="name.invalidPattern"
  174. value="Class type name ''{0}'' must match pattern ''{1}''."/>
  175. </module>
  176. <module name="InterfaceTypeParameterName">
  177. <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*$)"/>
  178. <message key="name.invalidPattern"
  179. value="Interface type name ''{0}'' must match pattern ''{1}''."/>
  180. </module>
  181. <module name="LambdaParameterName">
  182. <property name="format" value="^([a-z][a-zA-Z0-9]*)?$"/>
  183. <message key="name.invalidPattern"
  184. value="Lambda parameter name ''{0}'' must match pattern ''{1}''."/>
  185. </module>
  186. <module name="LocalVariableName">
  187. <property name="format" value="^([a-z0-9][a-zA-Z0-9]*)?$"/>
  188. <message key="name.invalidPattern"
  189. value="Local variable name ''{0}'' must match pattern ''{1}''."/>
  190. </module>
  191. <module name="MemberName">
  192. <property name="format" value="^([a-z][a-zA-Z0-9]*)?$"/>
  193. <message key="name.invalidPattern"
  194. value="Member name ''{0}'' must match pattern ''{1}''."/>
  195. </module>
  196. <module name="MethodName">
  197. <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
  198. <message key="name.invalidPattern"
  199. value="Method name ''{0}'' must match pattern ''{1}''."/>
  200. </module>
  201. <module name="MethodTypeParameterName">
  202. <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*$)"/>
  203. <message key="name.invalidPattern"
  204. value="Method type name ''{0}'' must match pattern ''{1}''."/>
  205. </module>
  206. <module name="PackageName">
  207. <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
  208. <message key="name.invalidPattern"
  209. value="Package name ''{0}'' must match pattern ''{1}''."/>
  210. </module>
  211. <module name="ParameterName">
  212. <property name="format" value="^([a-z0-9][a-zA-Z0-9]*)?$"/>
  213. <message key="name.invalidPattern"
  214. value="Parameter name ''{0}'' must match pattern ''{1}''."/>
  215. </module>
  216. <module name="PatternVariableName">
  217. <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
  218. <message key="name.invalidPattern"
  219. value="Pattern variable name ''{0}'' must match pattern ''{1}''."/>
  220. </module>
  221. <module name="RecordComponentName">
  222. <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
  223. <message key="name.invalidPattern"
  224. value="Record component name ''{0}'' must match pattern ''{1}''."/>
  225. </module>
  226. <module name="RecordTypeParameterName">
  227. <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*$)"/>
  228. <message key="name.invalidPattern"
  229. value="Record type name ''{0}'' must match pattern ''{1}''."/>
  230. </module>
  231. <module name="TypeName">
  232. <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
  233. ANNOTATION_DEF, RECORD_DEF"/>
  234. <message key="name.invalidPattern"
  235. value="Type name ''{0}'' must match pattern ''{1}''."/>
  236. </module>
  237. <!-- Regexp -->
  238. <!-- Size Violations -->
  239. <!-- Whitespace -->
  240. <module name="GenericWhitespace">
  241. <message key="ws.followed"
  242. value="GenericWhitespace ''{0}'' is followed by whitespace."/>
  243. <message key="ws.preceded"
  244. value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
  245. <message key="ws.illegalFollow"
  246. value="GenericWhitespace ''{0}'' should followed by whitespace."/>
  247. <message key="ws.notPreceded"
  248. value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
  249. </module>
  250. <module name="MethodParamPad">
  251. <property name="tokens"
  252. value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF,
  253. SUPER_CTOR_CALL, ENUM_CONSTANT_DEF, RECORD_DEF"/>
  254. </module>
  255. <module name="NoLineWrap">
  256. <property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT"/>
  257. </module>
  258. <module name="NoWhitespaceBefore">
  259. <property name="tokens"
  260. value="COMMA, SEMI, POST_INC, POST_DEC, DOT,
  261. LABELED_STAT, METHOD_REF"/>
  262. <property name="allowLineBreaks" value="true"/>
  263. </module>
  264. <module name="NoWhitespaceBeforeCaseDefaultColon"/>
  265. <module name="OperatorWrap">
  266. <property name="option" value="NL"/>
  267. <property name="tokens"
  268. value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,
  269. LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF,
  270. TYPE_EXTENSION_AND "/>
  271. </module>
  272. <module name="ParenPad">
  273. <property name="tokens"
  274. value="ANNOTATION, ANNOTATION_FIELD_DEF, CTOR_CALL, CTOR_DEF, DOT, ENUM_CONSTANT_DEF,
  275. EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW,
  276. LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL,
  277. METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA,
  278. RECORD_DEF"/>
  279. </module>
  280. <module name="SeparatorWrap">
  281. <property name="id" value="SeparatorWrapDot"/>
  282. <property name="tokens" value="DOT"/>
  283. <property name="option" value="nl"/>
  284. </module>
  285. <module name="SeparatorWrap">
  286. <property name="id" value="SeparatorWrapComma"/>
  287. <property name="tokens" value="COMMA"/>
  288. <property name="option" value="EOL"/>
  289. </module>
  290. <module name="SeparatorWrap">
  291. <!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/259 -->
  292. <property name="id" value="SeparatorWrapEllipsis"/>
  293. <property name="tokens" value="ELLIPSIS"/>
  294. <property name="option" value="EOL"/>
  295. </module>
  296. <module name="SeparatorWrap">
  297. <!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/258 -->
  298. <property name="id" value="SeparatorWrapArrayDeclarator"/>
  299. <property name="tokens" value="ARRAY_DECLARATOR"/>
  300. <property name="option" value="EOL"/>
  301. </module>
  302. <module name="SeparatorWrap">
  303. <property name="id" value="SeparatorWrapMethodRef"/>
  304. <property name="tokens" value="METHOD_REF"/>
  305. <property name="option" value="nl"/>
  306. </module>
  307. <module name="SingleSpaceSeparator"/>
  308. <module name="WhitespaceAfter">
  309. <property name="tokens"
  310. value="COMMA, SEMI, TYPECAST, LITERAL_IF, LITERAL_ELSE,
  311. LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, DO_WHILE"/>
  312. </module>
  313. <module name="WhitespaceAround">
  314. <property name="allowEmptyConstructors" value="true"/>
  315. <property name="allowEmptyLambdas" value="true"/>
  316. <property name="allowEmptyMethods" value="true"/>
  317. <property name="allowEmptyTypes" value="true"/>
  318. <property name="allowEmptyLoops" value="true"/>
  319. <property name="ignoreEnhancedForColon" value="false"/>
  320. <property name="tokens"
  321. value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR,
  322. BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND,
  323. LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY,
  324. LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED,
  325. LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN,
  326. NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR,
  327. SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND"/>
  328. <message key="ws.notFollowed"
  329. 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)"/>
  330. <message key="ws.notPreceded"
  331. value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
  332. </module>
  333. <!-- filter -->
  334. <!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter -->
  335. <module name="SuppressionXpathFilter">
  336. <property name="file" value="${org.checkstyle.google.suppressionxpathfilter.config}"
  337. default="checkstyle-xpath-suppressions.xml" />
  338. <property name="optional" value="true"/>
  339. </module>
  340. </module>
  341. </module>