checkstyle.xml

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
    "-//Puppy Crawl//DTD Check Configuration 1.2//EN" "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">




<module name="Checker">

    <property name="severity" value="error" />

    <!-- miscellaneous -->
    <module name="NewlineAtEndOfFile">
        <property name="lineSeparator" value="lf" />
        <property name="fileExtensions" value="java,xml,jsp" />
    </module>
    <module name="Translation" />

    <!-- size violations -->
    <module name="FileLength" />

    <!-- Duplicate code -->
    <!--
   <module name="StrictDuplicateCode">
       <property name="min" value="100" />
   </module>
    -->

    <!-- Regexp -->
    <module name="RegexpSingleline">
        <property name="format" value="\s+$" />
        <property name="message" value="Line has trailing spaces." />
        <property name="fileExtensions" value="java, xml, jsp" />
    </module>


    <!-- Whitespace -->
    <module name="FileTabCharacter" >
        <property name="fileExtensions" value="java, xml, jsp" />
    </module>

    <module name="TreeWalker">
        <!-- enable the suppression filters -->
        <module name="FileContentsHolder" />

        <!-- annotations -->
        <module name="AnnotationUseStyle" />
        <module name="MissingOverride" />


        <!-- block check -->
        <module name="EmptyBlock" />
        <module name="LeftCurly" />
        <module name="NeedBraces" />
        <module name="RightCurly" />
        <module name="AvoidNestedBlocks" />


        <!-- class design -->
        <module name="VisibilityModifier" />
        <module name="FinalClass" />
        <module name="InterfaceIsType" />
        <module name="HideUtilityClassConstructor" />
        <!-- <module name="DesignForExtension" /> -->
        <module name="MutableException">
            <property name="format" value="^.*Exception$" />
        </module>
        <module name="ThrowsCount">
            <property name="max" value="5" />
        </module>
        <module name="InnerTypeLast" />


        <!-- coding -->
        <module name="ArrayTrailingComma" />
        <!-- <module name="AvoidInlineConditionals"/> we like these -->
        <module name="CovariantEquals" />
        <module name="EmptyStatement" />
        <!-- <module name="EqualsAvoidNull"/> yoda speak it is -->
        <module name="EqualsHashCode" />
        <!-- <module name="FinalLocalVariable" /> -->
        <module name="HiddenField">
            <property name="ignoreConstructorParameter" value="true" />
            <property name="ignoreSetter" value="true" />
        </module>
        <module name="IllegalInstantiation" />
        <!-- <module name="IllegalToken" /> increments, decrements are ok -->
        <module name="InnerAssignment" />
        <!-- too painful for hashcode/equals auto-generated methods
        <module name="MagicNumber" >
            <property name="ignoreAnnotation" value="true" />
        </module>
        -->
        <module name="MissingSwitchDefault" />
        <module name="ModifiedControlVariable" />
        <module name="SimplifyBooleanExpression" />
        <module name="SimplifyBooleanReturn" />
        <module name="StringLiteralEquality" />
        <module name="NestedForDepth">
            <property name="max" value="3" />
        </module>
        <module name="NestedIfDepth">
            <property name="max" value="3" />
        </module>
        <module name="NestedTryDepth">
            <property name="max" value="2" />
        </module>
        <module name="NoFinalizer" />
        <module name="SuperClone" />
        <module name="SuperFinalize" />
        <module name="IllegalCatch" />
        <module name="IllegalThrows" />
        <module name="PackageDeclaration" />
        <module name="ReturnCount">
            <property name="max" value="5" />
        </module>
        <module name="IllegalType" >
            <property name="tokens" value="PARAMETER_DEF, METHOD_DEF"/>
        </module>
        <module name="DeclarationOrder" />
        <module name="ParameterAssignment" />
        <module name="ExplicitInitialization" />
        <module name="DefaultComesLast" />
        <!-- <module name="MissingCtor" /> default constructors are ok -->
        <module name="FallThrough" />
        <!-- <module name="MultipleStringLiterals"/> -->
        <module name="MultipleVariableDeclarations" />
        <!-- <module name="RequireThis"> -->
        <module name="UnnecessaryParentheses" />
        <module name="OneStatementPerLine" />

        <!-- Headers -->
        <!-- no checks required -->


        <!-- imports -->
        <!-- due to a "feature" netbeans introduced in 7.1, imports get turned into star with no way to turn it off
        <module name="AvoidStarImport" />
        -->
        <module name="IllegalImport">
            <property name="illegalPkgs" value="sun, org.apache.commons.logging, org.apache.log4j" />
        </module>
        <module name="RedundantImport" />
        <module name="UnusedImports" />
        <!-- <module name="ImportOrder"> leave this to code formatter -->


        <!-- Javadoc -->
        <module name="JavadocType">
            <property name="scope" value="public" />
        </module>
        <module name="JavadocMethod">
            <property name="scope" value="protected" />
            <property name="allowMissingPropertyJavadoc" value="true" />
        </module>
        <module name="JavadocVariable">
            <property name="scope" value="public" />
            <property name="excludeScope" value="private" />
        </module>

        <module name="JavadocStyle">
            <property name="scope" value="protected" />
        </module>


        <!-- metrics -->
        <module name="BooleanExpressionComplexity">
            <property name="max" value="5" />
        </module>
        <!-- <module name="ClassDataAbstractionCoupling" /> -->
        <!-- <module name="ClassFanOutComplexity"> <property name="max" value="15" /> </module> <module name="CyclomaticComplexity"> <property name="max" value="15"
        /> </module> <module name="NPathComplexity"> <property name="max" value="20" /> </module> <module name="JavaNCSS" /> -->

        <!-- miscellaneous -->
        <!-- <module name="TodoComment" /> -->
        <module name="UncommentedMain" >
            <property name="excludedClasses" value="Launcher$"/>
        </module>
        <module name="UpperEll" />
        <module name="ArrayTypeStyle" />
        <!-- <module name="FinalParameters"/> not enforced -->
        <!-- <module name="Indentation" /> -->
        <!-- <module name="TrailingComment" /> we are ok with these -->
        <module name="Regexp">
            <property name="format" value="buffer\.append\(cardNumber\)\;" />
            <property name="message" value="Credit Card numbers should not be logged." />
            <property name="illegalPattern" value="true" />
        </module>
        <module name="Regexp">
            <property name="format" value="buffer\.append\(securityNumber\)\;" />
            <property name="message" value="Credit Card security numbers should not be logged." />
            <property name="illegalPattern" value="true" />
        </module>
        <module name="OuterTypeFilename" />


        <!-- modifiers -->
        <module name="ModifierOrder" />
        <module name="RedundantModifier" />


        <!-- naming conventions -->
        <!-- <module name="AbstractClassName" /> -->
        <module name="ClassTypeParameterName" />
        <module name="ConstantName" />
        <module name="LocalFinalVariableName" />
        <module name="LocalVariableName" />
        <module name="MemberName" />
        <module name="MethodName" />
        <module name="MethodTypeParameterName" />
        <module name="PackageName" />
        <module name="ParameterName" />
        <module name="StaticVariableName" />
        <module name="TypeName" />


        <!-- size violations -->
        <module name="ExecutableStatementCount">
            <property name="max" value="80" />
        </module>
        <module name="LineLength">
            <property name="max" value="160" />
        </module>
        <module name="MethodLength">
            <property name="countEmpty" value="false" />
        </module>
        <module name="AnonInnerLength">
            <property name="max" value="200" />
        </module>
        <module name="ParameterNumber" />
        <module name="OuterTypeNumber" />
        <!-- if/when the code can exclude getters and setters we will re-instate this
       <module name="MethodCount">
           <property name="maxTotal" value="80" />
       </module>
        -->


        <!-- white space -->
        <module name="GenericWhitespace" />
        <module name="EmptyForInitializerPad" />
        <module name="EmptyForIteratorPad" />
        <module name="MethodParamPad" />
        <!-- Check everything except ARRAY_INIT -->
        <module name="NoWhitespaceAfter">
            <property name="tokens" value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS" />
        </module>

        <module name="NoWhitespaceBefore" />
        <module name="OperatorWrap" />
        <module name="ParenPad" />
        <module name="TypecastParenPad" />
        <module name="WhitespaceAfter" />
        <!-- legacy checkstyle 4 config - everything but GENERIC_END <module name="WhitespaceAfter"> <property name="tokens" value="COMMA, SEMI, TYPECAST" /> </module> -->
        <module name="WhitespaceAround" />
        <!-- legacy checkstyle 4 config - everything but GENERIC_START, GENERIC_END, WILDCARD_TYPE, RCURLY <module name="WhitespaceAround"> <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, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN, TYPE_EXTENSION_AND" /> </module> -->

    </module>

    <!-- we want to switch off bits of checkstyle for tests. Eclipse is not happy using the suppression file -->
    <module name="SuppressionCommentFilter">
        <!-- <property name="checkFormat" value="(JavadocMethod|MagicNumber|ParameterNumber)" /> -->
    </module>
    <module name="SuppressionCommentFilter">
        <property name="checkFormat" value="LineLength" />
        <property name="offCommentFormat" value="CHECKSTYLE\:LENGTH_OFF" />
        <property name="onCommentFormat" value="CHECKSTYLE\:LENGTH_ON" />
    </module>
    <module name="SuppressionCommentFilter">
        <property name="offCommentFormat" value="CSOFF\: ([\w\|]+)" />
        <property name="onCommentFormat" value="CSON\: ([\w\|]+)" />
        <property name="checkFormat" value="$1" />
    </module>
</module>