openesb-components/contrib-fort/rules4jbi/etc/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">

    <!-- TODO: allow -->
    <!--module name="PackageHtml"/-->

    <module name="NewlineAtEndOfFile"/>

    <!-- Checks that property files contain the same keys -->
    <!--module name="Translation"/-->

    <!-- idendifies headers as duplication; let CPD handle this -->
    <!--module name="StrictDuplicateCode"/-->
    
    <module name="TreeWalker">
        <property name="tabWidth" value="4"/>

        
        <!-- Checks for Javadoc comments -->
        <module name="JavadocStyle">
            <property name="checkEmptyJavadoc" value="true"/>
        </module>
        <module name="JavadocType">
            <property name="authorFormat" value="^Milan Fort \(http://www\.milanfort\.com/\)$"/>
            <property name="versionFormat" value="^\$Revision.*\$ \$Date.*\$$"/>
        </module>
        <!--module name="JavadocVariable"/-->
        <!--module name="JavadocMethod"/-->

        
        <!-- Checks for naming conventions -->
        <module name="AbstractClassName"/>
        <module name="ConstantName"/>
        <module name="LocalFinalVariableName"/>
        <module name="LocalVariableName">
            <property name="format" value="^e$"/>
            <property name="tokens" value="PARAMETER_DEF"/>
        </module>        
        <module name="MemberName"/>
        <module name="MethodName"/>
        <module name="PackageName">
            <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
        </module>        
        <module name="ParameterName"/>
        <module name="StaticVariableName"/>
        <module name="TypeName"/>


        <!-- Checks for Headers -->
        <module name="RegexpHeader">
            <property name="headerFile" value="${checkstyle.header.file}"/>
        </module>

        
        <!-- Checks for imports -->
        <module name="AvoidStarImport"/>
        <module name="IllegalImport"/> <!-- defaults to sun.* packages -->
        <module name="RedundantImport"/>
        <module name="UnusedImports"/>
        <module name="ImportOrder">
            <property name="groups" value="java, javax, org.w3c, nu.xom, com.google, net.jcip, edu.umd,
                                           org.openesb.components.rules4jbi.shared,
                                           org.openesb.components.rules4jbi.engine"/>
            <property name="ordered" value="true"/>
            <property name="separated" value="true"/>
        </module>
        

        <!-- Checks for size violations -->
        <module name="FileLength"/>
        <module name="LineLength">
            <property name="max" value="130"/>
        </module>        
        <module name="MethodLength"/>
        <module name="AnonInnerLength">
            <property name="max" value="25"/>
        </module>
        <module name="ParameterNumber"/>
        
        
        <!-- Checks for whitespace -->
        <module name="EmptyForIteratorPad"/>
        <module name="MethodParamPad"/>
        <module name="NoWhitespaceAfter"/>
        <module name="NoWhitespaceBefore"/>
        <module name="NoWhitespaceBefore">
            <property name="tokens" value="DOT"/>
            <property name="allowLineBreaks" value="true"/>
        </module>
        <module name="OperatorWrap"/>
        <module name="OperatorWrap">
            <property name="tokens" 
                      value="ASSIGN, DIV_ASSIGN, PLUS_ASSIGN, MINUS_ASSIGN, STAR_ASSIGN, MOD_ASSIGN, SR_ASSIGN,
                             BSR_ASSIGN, SL_ASSIGN, BXOR_ASSIGN, BOR_ASSIGN, BAND_ASSIGN"/>
            <property name="option" value="eol"/>
        </module>
        <module name="ParenPad"/>
        <module name="TypecastParenPad"/>
        <module name="TabCharacter"/>
        <module name="WhitespaceAfter"/>
        <module name="WhitespaceAround">
            <!--all tokens except for ASSIGN (because of annotations), GENERIC_START,GENERIC_END,WILDCARD_TYPE-->
            <property name="tokens" 
                      value="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"/>
            <property name="allowEmptyConstructors" value="true"/>
        </module>

        
        <!-- Modifier checks -->
        <module name="ModifierOrder"/>
        <module name="RedundantModifier"/>


        <!-- Checks for blocks -->
        <module name="AvoidNestedBlocks"/>
        <module name="EmptyBlock">
            <property name="option" value="stmt"/>
            <property name="tokens" value="LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_IF, LITERAL_FOR,
                                           LITERAL_TRY, LITERAL_WHILE, INSTANCE_INIT, STATIC_INIT"/>
        </module>

        <module name="EmptyBlock">
            <property name="option" value="text"/>
            <property name="tokens" value="LITERAL_CATCH"/>
        </module>
        
        
        <module name="LeftCurly">
            <property name="maxLineLength" value="115"/>
            <!--property name="option" value="nlow"/-->
        </module>
        <module name="NeedBraces"/>
        <module name="RightCurly"/>


        <!-- Checks for common coding problems -->
        <module name="CovariantEquals"/>
        <module name="DoubleCheckedLocking"/>
        <module name="EmptyStatement"/>
        <module name="EqualsHashCode"/>
        <!--module name="FinalLocalVariable">
            <property name="tokens" value="VARIABLE_DEF,PARAMETER_DEF"/>
        </module-->
        <module name="HiddenField">
            <property name="tokens" value="VARIABLE_DEF"/>
            <!--property name="ignoreConstructorParameter" value="true"/>
            <property name="ignoreSetter" value="true"/-->
        </module>
        <module name="IllegalInstantiation"/>
        <module name="InnerAssignment"/>
        <module name="MagicNumber"/>
        <module name="MissingSwitchDefault"/>
        <module name="ModifiedControlVariable"/>
        <module name="RedundantThrows"/>
        <module name="SimplifyBooleanExpression"/>
        <module name="SimplifyBooleanReturn"/>
        <module name="StringLiteralEquality"/>
        <module name="NestedIfDepth">
            <property name="max" value="3"/>
        </module>
        <module name="NestedTryDepth">
            <property name="max" value="2"/>
        </module>
        <module name="SuperClone"/>
	<module name="SuperFinalize"/>
        <!--module name="IllegalCatch"/-->
        <module name="IllegalThrows"/>
        <module name="PackageDeclaration"/>
        <module name="IllegalType"/>
        <module name="DeclarationOrder"/>
        <module name="ParameterAssignment"/>
        <module name="DefaultComesLast"/>
        <module name="FallThrough">
            <property name="checkLastCaseGroup" value="true"/>
            <property name="reliefPattern" value="falls through"/>
        </module>
        <module name="MultipleStringLiterals">
            <property name="ignoreStringsRegexp" value=":"/>
        </module>
        <module name="MultipleVariableDeclarations"/>
        <module name="UnnecessaryParentheses"/>
        
        
        <!-- Checks for class design -->
        <!--module name="DesignForExtension"/-->
        <module name="FinalClass"/>
        <module name="HideUtilityClassConstructor"/>
        <module name="InterfaceIsType"/>
        <module name="VisibilityModifier">
            <property name="packageAllowed" value="true"/>
        </module>
        <module name="MutableException"/>
        

        <!-- TODO: add Metrics checks -->
        
        
        <!-- Miscellaneous other checks -->
        <module name="ArrayTypeStyle"/>
        
        <!-- TODO: allow -->
        <!--module name="UncommentedMain"/-->
        <module name="UpperEll"/>
        <module name="Indentation">
            <property name="caseIndent" value="0"/>
        </module>
        
        <!-- TODO: allow -->
        <!--module name="TrailingComment"/-->
        <module name="GenericIllegalRegexp">
            <property name="format" value=";\s+$"/>
            <property name="message" value="Line has trailing spaces."/>
        </module>
    </module>
</module>