checkstyle.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
  ~ Based on Netty's check style config https://github.com/netty/netty-build/blob/master/src/main/resources/io/netty/checkstyle.xml
  -->
<!DOCTYPE module PUBLIC
        "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
        "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
<module name="Checker">
    <module name="SuppressionCommentFilter"/>
    <module name="TreeWalker">
        <module name="FileContentsHolder"/>
    </module>
    <module name="FileTabCharacter"/>
    <!--<module name="JavadocPackage"/> will get back to this when time allows-->
    <module name="NewlineAtEndOfFile">
        <property name="lineSeparator" value="lf"/>
    </module>
    <!-- Copyright headers -->
    <!--<module name="RegexpSingleline">-->
    <!--<property name="format" value="^(\s|\*)*Copyright\s+[0-9]+\s+The Netty Project\s*$"/>-->
    <!--<property name="minimum" value="1"/>-->
    <!--<property name="maximum" value="1"/>-->
    <!--<property name="message" value="missing copyright header"/>-->
    <!--</module>-->
    <!-- Unmaintainable Javadoc tags -->
    <!--<module name="RegexpSingleline">-->
    <!--<property name="format" value="(@(author|version)|\(non-Javadoc\))"/>-->
    <!--<property name="ignoreCase" value="true"/>-->
    <!--<property name="message" value="unmaintainable Javadoc tags: @author, @version, or (non-Javadoc)"/>-->
    <!--</module>-->
    <!-- Force UNIX line separator -->
    <module name="RegexpMultiline">
        <property name="format" value="\r"/>
        <property name="message" value="non-Unix line separator"/>
    </module>
    <!-- Trailing whitespace -->
    <module name="RegexpSingleline">
        <property name="format" value="\s+$"/>
        <property name="message" value="trailing whitespace"/>
    </module>
    <!-- Prohibit consecutive empty lines (except the lines after package/import) -->
    <module name="RegexpMultiline">
        <property name="format" value="\n *(?!package )(?!import )[^\n]+\n{3,}"/>
        <property name="message" value="two or more consecutive empty lines"/>
    </module>
    <!-- Prohibit an empty after { or before } -->
    <module name="RegexpMultiline">
        <property name="format" value="\n\n\s+\}[^\n]{0,10}\n"/>
        <property name="message" value="an empty line before '}'"/>
    </module>
    <module name="RegexpMultiline">
        <property name="format" value="\n\s+[^\n]{1,8}\{\n\n"/>
        <property name="message" value="an empty line after a short line that ends with '{'"/>
    </module>

    <module name="TreeWalker">
        <module name="LineLength">
            <property name="max" value="120"/>
        </module>
        <module name="WhitespaceAfter"/>
        <module name="WhitespaceAround">
            <property name="tokens"
                      value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, 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, RCURLY, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN, TYPE_EXTENSION_AND, DEC, INC"/>
        </module>
        <!-- Commented out due to false positives.
            <module name="MissingDeprecated"/>
            -->
        <module name="MissingOverride"/>
        <module name="PackageAnnotation"/>
        <module name="EmptyBlock">
            <property name="option" value="text"/>
        </module>
        <module name="LeftCurly"/>
        <module name="RightCurly"/>
        <module name="NeedBraces"/>
        <module name="AvoidNestedBlocks">
            <property name="allowInSwitchCase" value="true"/>
        </module>
        <module name="HideUtilityClassConstructor"/>
        <module name="CovariantEquals"/>
        <module name="EmptyStatement"/>
        <module name="EqualsHashCode"/>
        <!--
            <module name="FinalLocalVariable"/>
            -->
        <!-- Commented out due to http://jira.codehaus.org/browse/MCHECKSTYLE-111
            <module name="RedundantThrows">
              <property name="logLoadErrors" value="false"/>
              <property name="suppressLoadErrors" value="true"/>
            </module>
            -->
        <module name="SimplifyBooleanExpression"/>
        <module name="SimplifyBooleanReturn"/>
        <module name="NoFinalizer"/>
        <module name="SuperClone"/>
        <module name="SuperFinalize"/>
        <module name="PackageDeclaration"/>
        <module name="ExplicitInitialization"/>
        <module name="DefaultComesLast"/>
        <module name="UnnecessaryParentheses"/>
        <module name="AvoidStarImport">
            <property name="allowStaticMemberImports" value="true"/>
        </module>
        <module name="RedundantImport"/>
        <!-- Commented out due to false positives.
            <module name="UnusedImports">
              <property name="processJavadoc" value="true"/>
            </module>
            -->
        <module name="JavadocStyle">
            <property name="checkFirstSentence" value="false"/>
        </module>
        <module name="UpperEll"/>
        <module name="ArrayTypeStyle"/>
        <module name="OuterTypeFilename"/>
        <module name="ModifierOrder"/>
        <module name="RedundantModifier"/>
        <module name="GenericWhitespace"/>
        <module name="EmptyForInitializerPad"/>
        <module name="EmptyForIteratorPad"/>
        <module name="MethodParamPad"/>
        <module name="ParenPad"/>
        <module name="TypecastParenPad"/>
        <module name="ParameterName">
            <property name="format" value="^(?!arg[0-9])[_a-z][_a-zA-Z0-9]*$"/>
        </module>
    </module>
</module>