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.19(7.4) 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
  87     <!-- Annotations -->
  88
  89         <module name="AnnotationLocation" />
  90         <module name="AnnotationUseStyle" />
  91         <module name="MissingDeprecated" />
  92         <module name="MissingOverride" />
  93         <module name="PackageAnnotation" />
  94         <module name="SuppressWarnings" />
  95         <module name="SuppressWarningsHolder" />
  96
  97
  98     <!-- Block Checks -->
  99
 100         <module name="AvoidNestedBlocks" />
 101         <module name="EmptyBlock" />
 102         <module name="EmptyCatchBlock" />
 103         <module name="LeftCurly" />
 104         <module name="NeedBraces">
 105             <property name="allowSingleLineStatement" value="true" />
 106         </module>
 107         <module name="RightCurly" />
 108
 109
 110     <!-- Class Design -->
 111
 112         <module name="DesignForExtension" />
 113         <module name="FinalClass" />
 114         <module name="HideUtilityClassConstructor" />
 115         <module name="InnerTypeLast" />
 116         <module name="InterfaceIsType" />
 117         <module name="MutableException" />
 118         <module name="OneTopLevelClass" />
 119         <module name="ThrowsCount" />
 120         <module name="VisibilityModifier" />
 121
 122
 123     <!-- Coding -->
 124
 125         <module name="ArrayTrailingComma" />
 126         <module name="AvoidInlineConditionals" />
 127         <module name="CovariantEquals" />
 128         <module name="DeclarationOrder" />
 129         <module name="DefaultComesLast" />
 130         <module name="EmptyStatement" />
 131         <module name="EqualsAvoidNull" />
 132         <module name="EqualsHashCode" />
 133         <module name="ExplicitInitialization" />
 134         <module name="FallThrough" />
 135         <module name="FinalLocalVariable" />
 136         <module name="HiddenField">
 137             <property name="ignoreConstructorParameter" value="true" />
 138             <property name="ignoreSetter" value="true" />
 139             <property name="setterCanReturnItsClass" value="true" />
 140             <property name="ignoreAbstractMethods" value="true" />
 141         </module>
 142         <module name="IllegalCatch" />
 143         <module name="IllegalInstantiation" />
 144         <module name="IllegalThrows" />
 145         <module name="IllegalToken">
 146             <property name="tokens" value="LITERAL_NATIVE" />
 147         </module>
 148         <module name="IllegalTokenText" />
 149         <module name="IllegalType" />
 150         <module name="InnerAssignment" />
 151         <module name="MagicNumber" />
 152         <module name="MissingCtor" />
 153         <module name="MissingSwitchDefault" />
 154         <module name="ModifiedControlVariable" />
 155         <module name="MultipleStringLiterals" />
 156         <module name="MultipleVariableDeclarations" />
 157         <module name="NestedForDepth" />
 158         <module name="NestedIfDepth" />
 159         <module name="NestedTryDepth" />
 160         <module name="NoClone" />
 161         <module name="NoFinalizer" />
 162         <module name="OneStatementPerLine" />
 163         <module name="OverloadMethodsDeclarationOrder" />
 164         <module name="PackageDeclaration" />
 165         <module name="ParameterAssignment" />
 166         <module name="RequireThis">
 167             <!--property name="checkMethods" value="false" /-->
 168         </module>
 169         <module name="ReturnCount" />
 170         <module name="SimplifyBooleanExpression" />
 171         <module name="SimplifyBooleanReturn" />
 172         <module name="StringLiteralEquality" />
 173         <module name="SuperClone" />
 174         <module name="SuperFinalize" />
 175         <module name="UnnecessaryParentheses" />
 176         <module name="VariableDeclarationUsageDistance" />
 177
 178
 179     <!-- Imports -->
 180
 181         <module name="AvoidStarImport" />
 182         <module name="AvoidStaticImport" />
 183         <module name="CustomImportOrder" />
 184         <module name="IllegalImport" />
 185         <module name="ImportControl" />
 186         <module name="ImportOrder" />
 187         <module name="RedundantImport" />
 188         <module name="UnusedImports" />
 189
 190
 191     <!-- Javadoc Comments -->
 192
 193         <module name="AtclauseOrder" />
 194         <module name="JavadocMethod" />
 195         <module name="JavadocParagraph" />
 196         <module name="JavadocStyle">
 197             <property
 198                 name="endOfSentenceFormat"
 199                 value="([。.?!][ \t\n\r\f&lt;])|([。.?!]$)" />
 200             <property name="checkEmptyJavadoc" value="true" />
 201             <property name="checkHtml" value="true" />
 202         </module>
 203         <module name="JavadocTagContinuationIndentation" />
 204         <module name="JavadocType" />
 205         <module name="JavadocVariable">
 206             <property name="scope" value="protected" />
 207         </module>
 208         <module name="NonEmptyAtclauseDescription" />
 209         <module name="SingleLineJavadoc" />
 210         <module name="SummaryJavadocCheck" />
 211         <module name="WriteTag" />
 212
 213
 214     <!-- Metrics -->
 215
 216         <module name="BooleanExpressionComplexity" />
 217         <module name="ClassDataAbstractionCoupling" />
 218         <module name="ClassFanOutComplexity" />
 219         <module name="CyclomaticComplexity" />
 220         <module name="JavaNCSS" />
 221         <module name="NPathComplexity" />
 222
 223
 224     <!-- Miscellaneous -->
 225
 226         <module name="ArrayTypeStyle" />
 227         <module name="AvoidEscapedUnicodeCharacters">
 228             <property name="allowEscapesForControlCharacters" value="true"/>
 229             <property name="allowByTailComment" value="true"/>
 230             <property name="allowIfAllCharactersEscaped" value="true"/>
 231             <property name="allowNonPrintableEscapes" value="true"/>
 232         </module>
 233         <module name="CommentsIndentation" />
 234         <module name="DescendantToken" />
 235         <module name="FileContentsHolder" />
 236         <module name="FinalParameters" />
 237         <module name="Indentation">
 238             <property name="caseIndent" value="0" />
 239         </module>
 240         <module name="OuterTypeFilename" />
 241         <module name="TodoComment">
 242             <property name="format" value="TODO" />
 243         </module>
 244         <module name="TrailingComment" />
 245         <module name="UncommentedMain" />
 246         <module name="UpperEll" />
 247
 248
 249     <!-- Modifiers -->
 250
 251         <module name="ModifierOrder" />
 252         <module name="RedundantModifier" />
 253
 254
 255     <!-- Naming Conventions -->
 256
 257         <module name="AbbreviationAsWordInName" />
 258         <module name="AbstractClassName" />
 259         <module name="CatchParameterName" />
 260         <module name="ClassTypeParameterName" />
 261         <module name="ConstantName" />
 262         <module name="InterfaceTypeParameterName" />
 263         <module name="LocalFinalVariableName" />
 264         <module name="LocalVariableName" />
 265         <module name="MemberName" />
 266         <module name="MethodName" />
 267         <module name="MethodTypeParameterName" />
 268         <module name="PackageName" />
 269         <module name="ParameterName" />
 270         <module name="StaticVariableName" />
 271         <module name="TypeName" />
 272
 273
 274     <!-- Regex -->
 275
 276         <module name="Regexp">
 277             <property name="format" value="@author" />
 278             <property name="illegalPattern" value="true" />
 279         </module>
 280         <module name="Regexp">
 281             <property name="format" value="^ \* Copyright\(c\)" />
 282         </module>
 283         <module name="Regexp">
 284             <property name="format" value="^ \* License : The MIT License" />
 285             <property name="duplicateLimit" value="1" />
 286         </module>
 287         <module name="RegexpSinglelineJava">
 288             <property name="format" value="\u0000" />
 289         </module>
 290
 291
 292     <!-- Size Violations -->
 293
 294         <module name="AnonInnerLength" />
 295         <module name="ExecutableStatementCount" />
 296         <module name="LineLength">
 297             <property name="max" value="78" />
 298         </module>
 299         <module name="MethodCount" />
 300         <module name="MethodLength" />
 301         <module name="OuterTypeNumber" />
 302         <module name="ParameterNumber" />
 303
 304
 305     <!-- Whitespace -->
 306
 307         <module name="EmptyForInitializerPad" />
 308         <module name="EmptyForIteratorPad" />
 309         <module name="EmptyLineSeparator">
 310             <property
 311                 name="tokens"
 312                 value="PACKAGE_DEF,
 313                        IMPORT,
 314                        CLASS_DEF,
 315                        INTERFACE_DEF,
 316                        ENUM_DEF,
 317                        STATIC_INIT,
 318                        INSTANCE_INIT,
 319                        METHOD_DEF,
 320                        CTOR_DEF,
 321                        "
 322             />
 323         </module>
 324         <module name="GenericWhitespace" />
 325         <module name="MethodParamPad">
 326             <property
 327                 name="tokens"
 328                 value="CTOR_DEF, LITERAL_NEW, METHOD_DEF, SUPER_CTOR_CALL"
 329             />
 330         </module>
 331         <module name="NoLineWrap" />
 332         <module name="NoWhitespaceAfter">
 333             <property name="allowLineBreaks" value="false" />
 334             <property name="tokens" value="INC, DEC, DOT" />
 335         </module>
 336         <module name="NoWhitespaceBefore">
 337             <property name="allowLineBreaks" value="false" />
 338             <property name="tokens" value="COMMA, POST_INC, POST_DEC" />
 339         </module>
 340         <module name="OperatorWrap" />
 341         <module name="ParenPad">
 342             <property name="option" value="nospace" />
 343             <property
 344                 name="tokens"
 345                 value="CTOR_CALL, METHOD_CALL, SUPER_CTOR_CALL"
 346             />
 347         </module>
 348         <module name="SeparatorWrap">
 349             <property name="tokens" value="DOT" />
 350             <property name="option" value="nl" />
 351         </module>
 352         <module name="SingleSpaceSeparator" />
 353         <module name="TypecastParenPad" />
 354         <module name="WhitespaceAfter" >
 355             <property name="tokens" value="COMMA, SEMI,"/>
 356         </module>
 357         <module name="WhitespaceAround">
 358             <property
 359                 name="tokens"
 360                 value="ASSIGN,
 361                        LAND, LOR,
 362                        BAND, BOR, BXOR, BSR,
 363                        BAND_ASSIGN, BOR_ASSIGN, BXOR_ASSIGN, BSR_ASSIGN,
 364                        SL, SR,
 365                        SL_ASSIGN, SR_ASSIGN,
 366                        MINUS, STAR, DIV, MOD,
 367                        PLUS_ASSIGN, MINUS_ASSIGN,
 368                        STAR_ASSIGN, DIV_ASSIGN, MOD_ASSIGN,
 369                        EQUAL, NOT_EQUAL, GT, GE, LT, LE,
 370                        "
 371             />
 372         </module>
 373
 374
 375     </module>
 376
 377
 378 </module>
 379
 380 <!-- EOF -->