swe_checkstyle.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
    This configuration file was written by the eclipse-cs plugin configuration editor
-->
<!--
    Checkstyle-Configuration: SWE Checkstyle checks
    Description: This is the SW Environment Checkstyle template
-->
<!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"/>
    <module name="FileLength"/>
    <module name="FileTabCharacter"/>
    <module name="RegexpSingleline">
        <property name="format" value="\s+$"/>
        <property name="minimum" value="0"/>
        <property name="maximum" value="0"/>
        <property name="message" value="Line has trailing spaces."/>
        <property name="severity" value="error"/>
    </module>

    <module name="LineLength">
        <property name="max" value="121"/>
        <property name="ignorePattern" value="^ *\* *.+$"/> <!-- ignore javadoc comments -->
    </module>

    <module name="TreeWalker">
        <module name="ConstantName">
            <property name="format" value="^logger|([A-Z][A-Z0-9]*(_[A-Z0-9]+)*)$"/>
        </module>
        <module name="LocalFinalVariableName"/>
        <module name="LocalVariableName"/>
        <module name="MemberName"/>
        <module name="MethodName"/>
        <module name="PackageName"/>
        <module name="PackageDeclaration"/>
        <module name="ParameterName"/>
        <module name="StaticVariableName"/>
        <module name="TypeName"/>
        <module name="AvoidStarImport"/>
        <module name="IllegalImport"/>
        <module name="RedundantImport"/>
        <module name="UnusedImports"/>

        <module name="MethodLength"/>
        <module name="EmptyForIteratorPad"/>
        <module name="MethodParamPad"/>
        <module name="NoWhitespaceAfter">
                  <property name="severity" value="warning"/>
                  <property name="tokens" value="BNOT,DEC,DOT,INC,LNOT,UNARY_MINUS,UNARY_PLUS,TYPECAST"/>
        </module>
        <module name="NoWhitespaceBefore">
                <property name="allowLineBreaks" value="true"/>
                <property name="severity" value="warning"/>
                <property name="tokens" value="SEMI,DOT,POST_DEC,POST_INC"/>
        </module>
        <module name="OperatorWrap"/>
        <module name="ParenPad"/>
        <module name="TypecastParenPad"/>
        <module name="WhitespaceAfter">
                    <property name="severity" value="warning"/>
                <property name="tokens" value="COMMA,SEMI"/>
        </module>
        <module name="WhitespaceAround">
                    <property name="severity" value="info"/>
        </module>
        <module name="ModifierOrder"/>
        <module name="RedundantModifier"/>
        <module name="AvoidNestedBlocks"/>
        <module name="EmptyBlock"/>
        <module name="LeftCurly"/>
        <module name="NeedBraces"/>
        <module name="RightCurly"/>
        <module name="AvoidInlineConditionals"/>
        <module name="EmptyStatement"/>
        <module name="EqualsHashCode"/>
        <module name="HiddenField">
                 <property name="ignoreSetter" value="true"/>
                 <property name="ignoreConstructorParameter" value="true"/>
        </module>
        <module name="IllegalInstantiation"/>
        <module name="InnerAssignment"/>
        <module name="MagicNumber"/>
        <module name="MissingSwitchDefault"/>
        <module name="SimplifyBooleanExpression"/>
        <module name="SimplifyBooleanReturn"/>
        <module name="CovariantEquals"/>
        <module name="DefaultComesLast"/>
        <module name="ModifiedControlVariable"/>
        <module name="StringLiteralEquality"/>
        <module name="FinalClass"/>
        <module name="HideUtilityClassConstructor"/>
        <module name="InterfaceIsType">
                <property name="severity" value="warning"/>
        </module>
        <module name="VisibilityModifier">
                  <property name="packageAllowed" value="true"/>
                    <property name="protectedAllowed" value="true"/>
        </module>
        <module name="ArrayTypeStyle"/>
        <module name="TodoComment">
                    <property name="severity" value="ignore"/>
        </module>
        <module name="UpperEll"/>
        <module name="JavadocMethod"/>
        <module name="MissingJavadocMethod"/>
        <module name="JavadocStyle">
                   <property name="scope" value="protected"/>
        </module>
        <module name="JavadocType"/>
        <module name="JavadocVariable">
                   <property name="scope" value="protected"/>
        </module>
        <module name="MultipleVariableDeclarations" >
                    <property name="severity" value="warning"/>
        </module>
        <module name="ArrayTrailingComma">
                <property name="severity" value="warning"/>
        </module>

        <!-- Ignore generated code -->
        <module name="SuppressionCommentFilter"/>
        <module name="SuppressWithNearbyCommentFilter">
            <property name="commentFormat" value="CS IGNORE (\w+) FOR NEXT (\d+) LINES\. REASON\: \w+"/>
            <property name="checkFormat" value="$1"/>
            <property name="influenceFormat" value="$2"/>
        </module>
    </module>
    <module name="NewlineAtEndOfFile"/>
    <module name="Translation"/>
</module>