checkstyle.xml 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347
  1. <?xml version="1.0"?>
  2. <!DOCTYPE module PUBLIC
  3. "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
  4. "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
  5. <module name="er">
  6. <module name="SuppressionCommentFilter">
  7. <property name="offCommentFormat" value="CHECKSTYLE-OFF\: ([\w\|]+)"/>
  8. <property name="onCommentFormat" value="CHECKSTYLE-ON\: ([\w\|]+)"/>
  9. <property name="checkFormat" value="$1"/>
  10. </module>
  11. <module name="TreeWalker">
  12. <module name="FileContentsHolder"/>
  13. <module name="ArrayTypeStyle">
  14. <property name="javaStyle" value="true"/>
  15. <property name="severity" value="warning"/>
  16. </module>
  17. <module name="ModifierOrder">
  18. <property name="severity" value="warning"/>
  19. </module>
  20. <module name="RedundantModifier">
  21. <property name="severity" value="warning"/>
  22. </module>
  23. <module name="TodoComment">
  24. <property name="format" value="TODO"/>
  25. <property name="severity" value="info"/>
  26. </module>
  27. <module name="TodoComment">
  28. <property name="format" value="@todo"/>
  29. <property name="severity" value="info"/>
  30. </module>
  31. <module name="UpperEll">
  32. <property name="severity" value="error"/>
  33. </module>
  34. <module name="AvoidNestedBlocks">
  35. <property name="severity" value="warning"/>
  36. </module>
  37. <module name="EmptyBlock">
  38. <property name="severity" value="warning"/>
  39. </module>
  40. <module name="LeftCurly">
  41. <property name="maxLineLength" value="80"/>
  42. <property name="severity" value="warning"/>
  43. </module>
  44. <module name="NeedBraces">
  45. <property name="severity" value="error"/>
  46. </module>
  47. <module name="RightCurly">
  48. <property name="severity" value="warning"/>
  49. </module>
  50. <module name="CovariantEquals">
  51. <property name="severity" value="error"/>
  52. </module>
  53. <module name="DeclarationOrder">
  54. <property name="severity" value="warning"/>
  55. </module>
  56. <module name="DefaultComesLast">
  57. <property name="severity" value="error"/>
  58. </module>
  59. <module name="DoubleCheckedLocking">
  60. <property name="severity" value="error"/>
  61. </module>
  62. <module name="EmptyStatement">
  63. <property name="severity" value="error"/>
  64. </module>
  65. <module name="EqualsHashCode">
  66. <property name="severity" value="error"/>
  67. </module>
  68. <module name="FallThrough">
  69. <property name="severity" value="error"/>
  70. </module>
  71. <module name="FinalLocalVariable">
  72. <property name="severity" value="warning"/>
  73. <property name="tokens" value="VARIABLE_DEF"/>
  74. </module>
  75. <module name="HiddenField">
  76. <property name="ignoreConstructorParameter" value="true"/>
  77. <property name="ignoreSetter" value="true"/>
  78. <property name="severity" value="error"/>
  79. </module>
  80. <module name="IllegalCatch">
  81. <property name="severity" value="warning"/>
  82. </module>
  83. <module name="IllegalInstantiation">
  84. <property name="classes" value="java.lang.Boolean"/>
  85. <property name="severity" value="warning"/>
  86. </module>
  87. <module name="IllegalTokenText">
  88. <property name="format" value="^0[^lx]"/>
  89. <property name="ignoreCase" value="true"/>
  90. <property name="severity" value="error"/>
  91. <property name="tokens" value="NUM_INT,NUM_LONG"/>
  92. </module>
  93. <module name="IllegalType">
  94. <property name="format" value="!UNUSED!"/>
  95. <property name="ignoredMethodNames" value="getInitialContext,getEnvironment,getInstance"/>
  96. <property name="illegalClassNames" value="java.util.GregorianCalendar, java.util.LinkedHashMap, java.util.LinkedHashSet, java.util.TreeSet, java.util.TreeMap "/>
  97. <property name="severity" value="error"/>
  98. </module>
  99. <module name="InnerAssignment">
  100. <property name="severity" value="info"/>
  101. </module>
  102. <module name="JUnitTestCase">
  103. <property name="severity" value="error"/>
  104. </module>
  105. <module name="MagicNumber">
  106. <property name="severity" value="warning"/>
  107. </module>
  108. <module name="MissingSwitchDefault">
  109. <property name="severity" value="error"/>
  110. </module>
  111. <module name="MultipleVariableDeclarations">
  112. <property name="severity" value="warning"/>
  113. </module>
  114. <module name="NestedIfDepth">
  115. <property name="max" value="2"/>
  116. <property name="severity" value="error"/>
  117. </module>
  118. <module name="NestedTryDepth">
  119. <property name="severity" value="error"/>
  120. </module>
  121. <module name="PackageDeclaration">
  122. <property name="severity" value="error"/>
  123. </module>
  124. <module name="RedundantThrows">
  125. <property name="allowUnchecked" value="true"/>
  126. <property name="severity" value="error"/>
  127. </module>
  128. <module name="ReturnCount">
  129. <property name="max" value="3"/>
  130. <property name="severity" value="warning"/>
  131. </module>
  132. <module name="SimplifyBooleanExpression">
  133. <property name="severity" value="error"/>
  134. </module>
  135. <module name="SimplifyBooleanReturn">
  136. <property name="severity" value="error"/>
  137. </module>
  138. <module name="StringLiteralEquality">
  139. <property name="severity" value="error"/>
  140. </module>
  141. <module name="SuperClone">
  142. <property name="severity" value="error"/>
  143. </module>
  144. <module name="SuperFinalize">
  145. <property name="severity" value="error"/>
  146. </module>
  147. <module name="UnnecessaryParentheses">
  148. <property name="severity" value="info"/>
  149. </module>
  150. <module name="FinalClass">
  151. <property name="severity" value="error"/>
  152. </module>
  153. <module name="HideUtilityClassConstructor">
  154. <property name="severity" value="error"/>
  155. </module>
  156. <module name="InterfaceIsType">
  157. <property name="severity" value="error"/>
  158. </module>
  159. <module name="MutableException">
  160. <property name="severity" value="error"/>
  161. </module>
  162. <module name="ThrowsCount">
  163. <property name="max" value="2"/>
  164. <property name="severity" value="error"/>
  165. </module>
  166. <module name="VisibilityModifier">
  167. <property name="protectedAllowed" value="true"/>
  168. <property name="severity" value="error"/>
  169. </module>
  170. <module name="AvoidStarImport">
  171. <property name="severity" value="warning"/>
  172. </module>
  173. <module name="IllegalImport">
  174. <property name="severity" value="warning"/>
  175. </module>
  176. <module name="ImportOrder">
  177. <property name="groups" value="java,javax,org,net,com,uk" />
  178. <property name="ordered" value="true"/>
  179. <property name="severity" value="info"/>
  180. <property name="separated" value="true" />
  181. </module>
  182. <module name="RedundantImport">
  183. <property name="severity" value="warning"/>
  184. </module>
  185. <module name="UnusedImports">
  186. <property name="severity" value="warning"/>
  187. </module>
  188. <module name="Indentation">
  189. <property name="severity" value="info"/>
  190. </module>
  191. <module name="JavadocMethod">
  192. <property name="scope" value="private"/>
  193. <property name="severity" value="info"/>
  194. <property name="allowUndeclaredRTE" value="true"/>
  195. </module>
  196. <module name="JavadocMethod">
  197. <property name="scope" value="package"/>
  198. <property name="severity" value="warning"/>
  199. <property name="allowUndeclaredRTE" value="true"/>
  200. </module>
  201. <module name="JavadocStyle">
  202. <property name="checkEmptyJavadoc" value="true"/>
  203. <property name="scope" value="private"/>
  204. <property name="severity" value="info"/>
  205. </module>
  206. <module name="JavadocType">
  207. <property name="authorFormat" value="[A-Z][a-z]+ [A-Z][a-z]+"/>
  208. <property name="versionFormat" value="\$Id.*\$"/>
  209. <property name="scope" value="private"/>
  210. <property name="severity" value="error"/>
  211. </module>
  212. <module name="JavadocVariable">
  213. <property name="scope" value="protected"/>
  214. <property name="severity" value="error"/>
  215. </module>
  216. <module name="JavadocVariable">
  217. <property name="scope" value="package"/>
  218. <property name="severity" value="warning"/>
  219. </module>
  220. <module name="BooleanExpressionComplexity">
  221. <property name="max" value="7"/>
  222. <property name="severity" value="error"/>
  223. </module>
  224. <module name="BooleanExpressionComplexity">
  225. <property name="max" value="4"/>
  226. <property name="severity" value="info"/>
  227. </module>
  228. <module name="ClassDataAbstractionCoupling">
  229. <property name="max" value="30"/>
  230. <property name="severity" value="info"/>
  231. </module>
  232. <module name="ClassFanOutComplexity">
  233. <property name="max" value="40"/>
  234. <property name="severity" value="info"/>
  235. </module>
  236. <module name="CyclomaticComplexity">
  237. <property name="max" value="11"/>
  238. <property name="severity" value="info"/>
  239. </module>
  240. <module name="NPathComplexity">
  241. <property name="severity" value="warning"/>
  242. </module>
  243. <module name="ConstantName">
  244. <property name="severity" value="error"/>
  245. </module>
  246. <module name="LocalFinalVariableName">
  247. <property name="severity" value="error"/>
  248. <property name="tokens" value="VARIABLE_DEF" />
  249. </module>
  250. <module name="LocalVariableName">
  251. <property name="severity" value="error"/>
  252. </module>
  253. <module name="MemberName">
  254. <property name="severity" value="error"/>
  255. </module>
  256. <module name="MethodName">
  257. <property name="severity" value="error"/>
  258. </module>
  259. <module name="MethodParamPad">
  260. <property name="severity" value="warning"/>
  261. </module>
  262. <module name="PackageName">
  263. <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
  264. <property name="severity" value="error"/>
  265. </module>
  266. <module name="ParameterName">
  267. <property name="severity" value="error"/>
  268. </module>
  269. <module name="StaticVariableName">
  270. <property name="severity" value="error"/>
  271. </module>
  272. <module name="TypeName">
  273. <property name="severity" value="error"/>
  274. </module>
  275. <module name="AnonInnerLength">
  276. <property name="max" value="75"/>
  277. <property name="severity" value="warning"/>
  278. </module>
  279. <module name="ExecutableStatementCount">
  280. <property name="max" value="50"/>
  281. <property name="severity" value="warning"/>
  282. </module>
  283. <module name="FileLength">
  284. <property name="severity" value="warning"/>
  285. </module>
  286. <module name="LineLength">
  287. <property name="ignorePattern" value="\$Header"/>
  288. <property name="max" value="120"/>
  289. <property name="severity" value="info"/>
  290. <property name="tabWidth" value="8"/>
  291. </module>
  292. <module name="MethodLength">
  293. <property name="severity" value="warning"/>
  294. </module>
  295. <module name="ParameterNumber">
  296. <property name="max" value="6"/>
  297. <property name="severity" value="info"/>
  298. </module>
  299. <module name="ParameterNumber">
  300. <property name="max" value="12"/>
  301. <property name="severity" value="warning"/>
  302. </module>
  303. <module name="EmptyForInitializerPad">
  304. <property name="severity" value="warning"/>
  305. </module>
  306. <module name="EmptyForIteratorPad">
  307. <property name="severity" value="warning"/>
  308. </module>
  309. <module name="NoWhitespaceAfter">
  310. <property name="allowLineBreaks" value="true"/>
  311. <property name="severity" value="warning"/>
  312. <property name="tokens" value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS"/>
  313. </module>
  314. <module name="NoWhitespaceBefore">
  315. <property name="severity" value="warning"/>
  316. <property name="allowLineBreaks" value="true"/>
  317. <property name="tokens" value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS"/>
  318. </module>
  319. <module name="OperatorWrap">
  320. <property name="severity" value="warning"/>
  321. </module>
  322. <module name="ParenPad">
  323. <property name="severity" value="warning"/>
  324. <property name="tokens" value="CTOR_CALL, METHOD_CALL, SUPER_CTOR_CALL"/>
  325. </module>
  326. <!--
  327. <module name="TabCharacter">
  328. <property name="severity" value="warning"/>
  329. </module>
  330. -->
  331. <module name="TypecastParenPad">
  332. <property name="option" value="nospace"/>
  333. <property name="severity" value="warning"/>
  334. </module>
  335. <module name="WhitespaceAfter">
  336. <property name="severity" value="warning"/>
  337. <property name="tokens" value="COMMA, SEMI"/>
  338. </module>
  339. <module name="WhitespaceAround">
  340. <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, LCURLY, LE, LITERAL_ASSERT, 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, RCURLY, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN, TYPE_EXTENSION_AND, WILDCARD_TYPE"/>
  341. <property name="severity" value="warning"/>
  342. </module>
  343. </module>
  344. </module>