config/checkstyle/checkstyle.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2
   3 <!DOCTYPE module PUBLIC
   4     "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
   5     "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
   6
   7 <!--
   8     Checkstyle modules
   9     for Checkstyle 6.18 or later
  10
  11     [ http://checkstyle.sourceforge.net/ ]
  12
  13     Copyright(c) 2010 olyutorskii
  14 -->
  15
  16
  17 <module name="Checker">
  18
  19     <property name="charset" value="UTF-8" />
  20     <property name="localeCountry" value="JP" />
  21     <property name="localeLanguage" value="en" />
  22     <!--property name="localeLanguage" value="ja" /-->
  23     <property name="fileExtensions" value="java, xml, properties" />
  24     <property name="severity" value="error" />
  25
  26
  27     <!-- Filters -->
  28     <module name="SeverityMatchFilter" />
  29     <module name="SuppressionCommentFilter" />
  30     <module name="SuppressionFilter" />
  31     <module name="SuppressWarningsFilter" />
  32     <module name="SuppressWithNearbyCommentFilter" />
  33
  34
  35     <!-- Headers -->
  36     <module name="Header">
  37         <property name="header" value="&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; ?&gt;" />
  38         <property name="fileExtensions" value="xml" />
  39     </module>
  40     <module name="RegexpHeader">
  41         <property name="header" value="^/\*$\n^ \*( .*)?$\n^ \*/$\n" />
  42         <property name="multiLines" value="2" />
  43         <property name="fileExtensions" value="java" />
  44     </module>
  45
  46
  47     <!-- Javadoc Comments -->
  48     <module name="JavadocPackage" />
  49
  50
  51     <!-- Miscellaneous -->
  52     <module name="NewlineAtEndOfFile">
  53         <property name="fileExtensions" value="java" />
  54     </module>
  55     <module name="Translation" />
  56     <module name="UniqueProperties" />
  57
  58
  59     <!-- Regexp -->
  60     <module name="RegexpMultiline">
  61         <property name="format" value="[\u000b\f\u001a]" />
  62     </module>
  63     <module name="RegexpOnFilename" />
  64     <module name="RegexpSingleline">
  65         <property name="format" value="\s+$" />
  66     </module>
  67     <module name="RegexpSingleline">
  68         <!-- scm conflict -->
  69         <property name="format" value="&lt;&lt;&lt;&lt;&lt;" />
  70     </module>
  71
  72
  73     <!-- Size Violations -->
  74     <module name="FileLength" />
  75
  76
  77     <!-- Whitespace -->
  78     <module name="FileTabCharacter" />
  79
  80
  81     <module name="TreeWalker">
  82
  83         <property name="tabWidth" value="8"/>
  84         <property name="fileExtensions" value="java"/>
  85
  86         <module name="SuppressWarningsHolder" />
  87
  88
  89     <!-- Annotations -->
  90
  91         <module name="AnnotationLocation" />
  92         <module name="AnnotationUseStyle" />
  93         <module name="MissingDeprecated" />
  94         <module name="MissingOverride" />
  95         <module name="PackageAnnotation" />
  96         <module name="SuppressWarnings" />
  97         <module name="SuppressWarningsHolder" />
  98
  99
 100     <!-- Block Checks -->
 101
 102         <module name="AvoidNestedBlocks" />
 103         <module name="EmptyBlock" />
 104         <module name="EmptyCatchBlock" />
 105         <module name="LeftCurly" />
 106         <module name="NeedBraces">
 107             <property name="allowSingleLineStatement" value="true" />
 108         </module>
 109         <module name="RightCurly" />
 110
 111
 112     <!-- Class Design -->
 113
 114         <module name="DesignForExtension" />
 115         <module name="FinalClass" />
 116         <module name="HideUtilityClassConstructor" />
 117         <module name="InnerTypeLast" />
 118         <module name="InterfaceIsType" />
 119         <module name="MutableException" />
 120         <module name="OneTopLevelClass" />
 121         <module name="ThrowsCount" />
 122         <module name="VisibilityModifier" />
 123
 124
 125     <!-- Coding -->
 126
 127         <module name="ArrayTrailingComma" />
 128         <module name="AvoidInlineConditionals" />
 129         <module name="CovariantEquals" />
 130         <module name="DeclarationOrder" />
 131         <module name="DefaultComesLast" />
 132         <module name="EmptyStatement" />
 133         <module name="EqualsAvoidNull" />
 134         <module name="EqualsHashCode" />
 135         <module name="ExplicitInitialization" />
 136         <module name="FallThrough" />
 137         <module name="FinalLocalVariable" />
 138         <module name="HiddenField">
 139             <property name="ignoreConstructorParameter" value="true" />
 140             <property name="ignoreSetter" value="true" />
 141             <property name="setterCanReturnItsClass" value="true" />
 142             <property name="ignoreAbstractMethods" value="true" />
 143         </module>
 144         <module name="IllegalCatch" />
 145         <module name="IllegalInstantiation" />
 146         <module name="IllegalThrows" />
 147         <module name="IllegalToken">
 148             <property name="tokens" value="LITERAL_NATIVE" />
 149         </module>
 150         <module name="IllegalTokenText" />
 151         <module name="IllegalType" />
 152         <module name="InnerAssignment" />
 153         <module name="MagicNumber" />
 154         <module name="MissingCtor" />
 155         <module name="MissingSwitchDefault" />
 156         <module name="ModifiedControlVariable" />
 157         <module name="MultipleStringLiterals" />
 158         <module name="MultipleVariableDeclarations" />
 159         <module name="NestedForDepth" />
 160         <module name="NestedIfDepth" />
 161         <module name="NestedTryDepth" />
 162         <module name="NoClone" />
 163         <module name="NoFinalizer" />
 164         <module name="OneStatementPerLine" />
 165         <module name="OverloadMethodsDeclarationOrder" />
 166         <module name="PackageDeclaration" />
 167         <module name="ParameterAssignment" />
 168         <module name="RequireThis">
 169             <!--property name="checkMethods" value="false" /-->
 170         </module>
 171         <module name="ReturnCount" />
 172         <module name="SimplifyBooleanExpression" />
 173         <module name="SimplifyBooleanReturn" />
 174         <module name="StringLiteralEquality" />
 175         <module name="SuperClone" />
 176         <module name="SuperFinalize" />
 177         <module name="UnnecessaryParentheses" />
 178         <module name="VariableDeclarationUsageDistance" />
 179
 180
 181     <!-- Imports -->
 182
 183         <module name="AvoidStarImport" />
 184         <module name="AvoidStaticImport" />
 185         <module name="CustomImportOrder" />
 186         <module name="IllegalImport" />
 187         <module name="ImportControl" />
 188         <module name="ImportOrder" />
 189         <module name="RedundantImport" />
 190         <module name="UnusedImports" />
 191
 192
 193     <!-- Javadoc Comments -->
 194
 195         <module name="AtclauseOrder" />
 196         <module name="JavadocMethod" />
 197         <module name="JavadocParagraph" />
 198         <module name="JavadocStyle">
 199             <property
 200                 name="endOfSentenceFormat"
 201                 value="([。.?!][ \t\n\r\f&lt;])|([。.?!]$)" />
 202             <property name="checkEmptyJavadoc" value="true" />
 203             <property name="checkHtml" value="true" />
 204         </module>
 205         <module name="JavadocTagContinuationIndentation" />
 206         <module name="JavadocType" />
 207         <module name="JavadocVariable">
 208             <property name="scope" value="protected" />
 209         </module>
 210         <module name="NonEmptyAtclauseDescription" />
 211         <module name="SingleLineJavadoc" />
 212         <module name="SummaryJavadocCheck" />
 213         <module name="WriteTag" />
 214
 215
 216     <!-- Metrics -->
 217
 218         <module name="BooleanExpressionComplexity" />
 219         <module name="ClassDataAbstractionCoupling" />
 220         <module name="ClassFanOutComplexity" />
 221         <module name="CyclomaticComplexity" />
 222         <module name="JavaNCSS" />
 223         <module name="NPathComplexity" />
 224
 225
 226     <!-- Miscellaneous -->
 227
 228         <module name="ArrayTypeStyle" />
 229         <module name="AvoidEscapedUnicodeCharacters">
 230             <property name="allowEscapesForControlCharacters" value="true"/>
 231             <property name="allowByTailComment" value="true"/>
 232             <property name="allowIfAllCharactersEscaped" value="true"/>
 233             <property name="allowNonPrintableEscapes" value="true"/>
 234         </module>
 235         <module name="CommentsIndentation" />
 236         <module name="DescendantToken" />
 237         <module name="FileContentsHolder" />
 238         <module name="FinalParameters" />
 239         <module name="Indentation">
 240             <property name="caseIndent" value="0" />
 241         </module>
 242         <module name="OuterTypeFilename" />
 243         <module name="TodoComment">
 244             <property name="format" value="TODO" />
 245         </module>
 246         <module name="TrailingComment" />
 247         <module name="UncommentedMain" />
 248         <module name="UpperEll" />
 249
 250
 251     <!-- Modifiers -->
 252
 253         <module name="ModifierOrder" />
 254         <module name="RedundantModifier" />
 255
 256
 257     <!-- Naming Conventions -->
 258
 259         <module name="AbbreviationAsWordInName" />
 260         <module name="AbstractClassName" />
 261         <module name="CatchParameterName" />
 262         <module name="ClassTypeParameterName" />
 263         <module name="ConstantName" />
 264         <module name="InterfaceTypeParameterName" />
 265         <module name="LocalFinalVariableName" />
 266         <module name="LocalVariableName" />
 267         <module name="MemberName" />
 268         <module name="MethodName" />
 269         <module name="MethodTypeParameterName" />
 270         <module name="PackageName" />
 271         <module name="ParameterName" />
 272         <module name="StaticVariableName" />
 273         <module name="TypeName" />
 274
 275
 276     <!-- Regex -->
 277
 278         <module name="Regexp">
 279             <property name="format" value="@author" />
 280             <property name="illegalPattern" value="true" />
 281         </module>
 282         <module name="Regexp">
 283             <property name="format" value="^ \* Copyright\(c\)" />
 284         </module>
 285         <module name="Regexp">
 286             <property name="format" value="^ \* License : The MIT License" />
 287             <property name="duplicateLimit" value="1" />
 288         </module>
 289         <module name="RegexpSinglelineJava">
 290             <property name="format" value="\u0000" />
 291         </module>
 292
 293
 294     <!-- Size Violations -->
 295
 296         <module name="AnonInnerLength" />
 297         <module name="ExecutableStatementCount" />
 298         <module name="LineLength">
 299             <property name="max" value="78" />
 300         </module>
 301         <module name="MethodCount" />
 302         <module name="MethodLength" />
 303         <module name="OuterTypeNumber" />
 304         <module name="ParameterNumber" />
 305
 306
 307     <!-- Whitespace -->
 308
 309         <module name="EmptyForInitializerPad" />
 310         <module name="EmptyForIteratorPad" />
 311         <module name="EmptyLineSeparator">
 312             <property
 313                 name="tokens"
 314                 value="PACKAGE_DEF,
 315                        IMPORT,
 316                        CLASS_DEF,
 317                        INTERFACE_DEF,
 318                        ENUM_DEF,
 319                        STATIC_INIT,
 320                        INSTANCE_INIT,
 321                        METHOD_DEF,
 322                        CTOR_DEF,
 323                        "
 324             />
 325         </module>
 326         <module name="GenericWhitespace" />
 327         <module name="MethodParamPad">
 328             <property
 329                 name="tokens"
 330                 value="CTOR_DEF, LITERAL_NEW, METHOD_DEF, SUPER_CTOR_CALL"
 331             />
 332         </module>
 333         <module name="NoLineWrap" />
 334         <module name="NoWhitespaceAfter">
 335             <property name="allowLineBreaks" value="false" />
 336             <property name="tokens" value="INC, DEC, DOT" />
 337         </module>
 338         <module name="NoWhitespaceBefore">
 339             <property name="allowLineBreaks" value="false" />
 340             <property name="tokens" value="COMMA, POST_INC, POST_DEC" />
 341         </module>
 342         <module name="OperatorWrap" />
 343         <module name="ParenPad">
 344             <property name="option" value="nospace" />
 345             <property
 346                 name="tokens"
 347                 value="CTOR_CALL, METHOD_CALL, SUPER_CTOR_CALL"
 348             />
 349         </module>
 350         <module name="SeparatorWrap">
 351             <property name="tokens" value="DOT" />
 352             <property name="option" value="nl" />
 353         </module>
 354         <!-- *6.19* module name="SingleSpaceSeparator" /-->
 355         <module name="TypecastParenPad" />
 356         <module name="WhitespaceAfter" >
 357             <property name="tokens" value="COMMA, SEMI,"/>
 358         </module>
 359         <module name="WhitespaceAround">
 360             <property
 361                 name="tokens"
 362                 value="ASSIGN,
 363                        LAND, LOR,
 364                        BAND, BOR, BXOR, BSR,
 365                        BAND_ASSIGN, BOR_ASSIGN, BXOR_ASSIGN, BSR_ASSIGN,
 366                        SL, SR,
 367                        SL_ASSIGN, SR_ASSIGN,
 368                        MINUS, STAR, DIV, MOD,
 369                        PLUS_ASSIGN, MINUS_ASSIGN,
 370                        STAR_ASSIGN, DIV_ASSIGN, MOD_ASSIGN,
 371                        EQUAL, NOT_EQUAL, GT, GE, LT, LE,
 372                        "
 373             />
 374         </module>
 375
 376
 377     </module>
 378
 379
 380 </module>
 381
 382 <!-- EOF -->