checkstyle.xml

<?xml version="1.0" encoding="UTF-8"?>

<!--
  -  Copyright 2014 VU University Medical Center.
  -  Licensed under the Apache License version 2.0 (see http://opensource.org/licenses/Apache-2.0).
-->

<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
        "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">

<!--
    Checkstyle configuration for the Workflow Runner project.

    @author <a href="mailto:f.debruijn@vumc.nl">Freek de Bruijn</a>
-->

<module name="Checker">

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

    <module name="SuppressionFilter">
        <!--<property name="file" value="${config_loc}checkstyle-suppressions.xml"/>-->
        <property name="file" value="checkstyle-suppressions.xml"/>
    </module>

    <module name="JavadocPackage"/>

    <module name="FileTabCharacter">
        <property name="eachLine" value="true"/>
    </module>

    <module name="TreeWalker">

        <property name="cacheFile" value="target/checkstyle/cache"/>

        <module name="MissingDeprecated"/>

        <module name="MissingOverride">
            <property name="javaFiveCompatibility" value="true"/>
        </module>

        <module name="SuppressWarnings"/>

        <module name="JavadocMethod">
            <property name="allowUndeclaredRTE" value="true"/>
            <property name="allowThrowsTagsForSubclasses" value="true"/>
            <property name="suppressLoadErrors" value="true"/>
        </module>

        <module name="JavadocStyle">
            <property name="checkEmptyJavadoc" value="true"/>
            <property name="endOfSentenceFormat"
                      value="(([.?!][ \t\n\r\f&lt;])|([.?!]$))|((\{@inheritDoc\}[ \t\n\r\f&lt;])|(\{@inheritDoc\}$))"/>
        </module>

        <module name="JavadocType">
            <property name="authorFormat" value="&lt;a href=&quot;mailto:(.+)&quot;&gt;(.+)&lt;/a&gt;"/>
        </module>

        <module name="JavadocVariable"/>

        <module name="AbstractClassName">
            <property name="format" value="^Abstract.+$"/>
        </module>

        <module name="ConstantName">
            <property name="format" value="^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*|logger$"/>
        </module>

        <module name="LocalFinalVariableName"/>
        <module name="LocalVariableName"/>

        <module name="MemberName">
            <property name="format" value="^[a-z][a-zA-Z0-9_]*$"/>
        </module>

        <module name="MethodName">
            <property name="format" value="^[a-z][a-zA-Z0-9_]*$"/>
        </module>

        <module name="PackageName"/>
        <module name="ParameterName"/>
        <module name="StaticVariableName"/>
        <module name="TypeName"/>
        <module name="AvoidStarImport"/>
        <module name="IllegalImport"/>
        <module name="RedundantImport"/>

        <module name="UnusedImports">
            <property name="processJavadoc" value="true"/>
        </module>

        <module name="ImportOrder">
            <property name="option" value="bottom"/>
            <property name="groups" value="au,com,java,javax,net,nl,org"/>
            <property name="ordered" value="true"/>
            <property name="separated" value="true"/>
        </module>

        <module name="AnonInnerLength"/>
        <module name="ExecutableStatementCount">
            <property name="tokens" value="INSTANCE_INIT,STATIC_INIT,METHOD_DEF,CTOR_DEF"/>
        </module>

        <module name="LineLength">
            <property name="max" value="150"/>
            <property name="tabWidth" value="4"/>
        </module>

        <module name="MethodLength"/>
        <module name="ParameterNumber"/>
        <module name="OuterTypeNumber"/>
        <module name="GenericWhitespace"/>

        <module name="EmptyForInitializerPad">
            <property name="option" value="space"/>
        </module>

        <module name="EmptyForIteratorPad">
            <property name="option" value="space"/>
        </module>

        <module name="WhitespaceAround"/>

        <module name="WhitespaceAfter">
            <property name="tokens" value="COMMA,SEMI,TYPECAST"/>
        </module>

        <module name="NoWhitespaceAfter">
            <property name="tokens" value="ARRAY_INIT,BNOT,DEC,DOT,INC,LNOT,UNARY_MINUS,UNARY_PLUS"/>
        </module>

        <module name="NoWhitespaceBefore">
            <property name="tokens" value="DOT,POST_DEC,POST_INC,SEMI"/>
            <property name="allowLineBreaks" value="true"/>
        </module>

        <module name="OperatorWrap" />
        <module name="MethodParamPad"/>
        <module name="ParenPad"/>

        <module name="TypecastParenPad">
            <property name="tokens" value="RPAREN,TYPECAST"/>
        </module>

        <module name="ModifierOrder"/>
        <module name="RedundantModifier"/>

        <module name="AvoidNestedBlocks">
            <property name="allowInSwitchCase" value="true"/>
        </module>

        <module name="EmptyBlock"/>

        <module name="LeftCurly">
            <property name="maxLineLength" value="150"/>
        </module>

        <!--<module name="NeedBraces"/>-->
        <module name="RightCurly"/>
        <module name="CovariantEquals"/>
        <module name="DefaultComesLast"/>
        <module name="DeclarationOrder"/>

        <!-- http://sourceforge.net/p/checkstyle/bugs/682/
            <module name="DoubleCheckedLocking"/>
        -->

        <module name="EmptyStatement"/>

        <module name="EqualsAvoidNull">
            <metadata name="net.sf.eclipsecs.core.comment" value="Evaluate whether this is useful"/>
        </module>

        <module name="EqualsHashCode"/>
        <module name="ExplicitInitialization"/>
        <module name="FallThrough"/>

        <module name="FinalLocalVariable">
            <property name="tokens" value="PARAMETER_DEF,VARIABLE_DEF"/>
        </module>

        <module name="HiddenField">
            <property name="tokens" value="VARIABLE_DEF"/>
            <property name="ignoreConstructorParameter" value="true"/>
            <property name="ignoreAbstractMethods" value="true"/>
            <property name="ignoreSetter" value="true"/>
        </module>

        <module name="IllegalCatch"/>

        <module name="IllegalThrows">
            <property name="illegalClassNames" value="java.lang.Error,java.lang.RuntimeException"/>
        </module>

        <module name="InnerAssignment"/>

        <module name="JUnitTestCase">
            <metadata name="net.sf.eclipsecs.core.comment"
                      value="Evaluate whether this still works with the spring tests"/>
        </module>

        <module name="MagicNumber">
            <property name="ignoreNumbers" value="-2, -1, 0, 1, 2"/>
            <property name="ignoreAnnotation" value="true"/>
        </module>

        <module name="MissingSwitchDefault"/>

        <module name="ModifiedControlVariable">
            <metadata name="net.sf.eclipsecs.core.comment" value="Evaluate whether this works in all cases"/>
        </module>

        <module name="MultipleStringLiterals"/>
        <module name="MultipleVariableDeclarations"/>

        <module name="NestedIfDepth">
            <property name="max" value="4"/>
        </module>

        <module name="NestedTryDepth">
            <property name="max" value="2"/>
        </module>

        <module name="NoClone"/>
        <module name="NoFinalizer"/>
        <module name="PackageDeclaration"/>
        <module name="ParameterAssignment"/>

        <module name="RedundantThrows">
            <property name="suppressLoadErrors" value="true"/>
        </module>

        <module name="ReturnCount">
            <property name="max" value="4"/>
        </module>

        <module name="SimplifyBooleanExpression"/>
        <module name="SimplifyBooleanReturn"/>
        <module name="StringLiteralEquality"/>
        <module name="SuperClone"/>
        <module name="SuperFinalize"/>
        <module name="ArrayTrailingComma"/>

        <module name="UnnecessaryParentheses">
            <metadata name="net.sf.eclipsecs.core.comment" value="Evaluate whether this works in calculations"/>
        </module>

        <module name="HideUtilityClassConstructor"/>

        <module name="VisibilityModifier">
            <property name="packageAllowed" value="true"/>
            <property name="protectedAllowed" value="true"/>
        </module>

        <module name="CyclomaticComplexity">
            <metadata name="net.sf.eclipsecs.core.comment" value="Evaluate whether this meets our complex system"/>
            <property name="max" value="7"/>
        </module>

        <module name="JavaNCSS">
            <metadata name="net.sf.eclipsecs.core.comment" value="Evaluate whether this metric makes any sense"/>
        </module>

        <module name="NPathComplexity">
            <metadata name="net.sf.eclipsecs.core.comment" value="Evaluate whether this metric makes any sense"/>
        </module>

        <module name="FinalParameters"/>

        <!-- todo: enable this check with throws property when maven-checkstyle-plugin supports Checkstyle 5.7. -->
        <!--<module name="Indentation">-->
        <!--<property name="throwsIndent" value="8"/>-->
        <!--</module>-->

        <module name="TrailingComment"/>
        <module name="UncommentedMain"/>
        <module name="StaticVariableName"/>
        <module name="FileContentsHolder"/>

    </module>

    <module name="FileLength"/>

    <module name="NewlineAtEndOfFile">
        <property name="lineSeparator" value="lf"/>
        <property name="fileExtensions" value="java"/>
    </module>

    <module name="SuppressionCommentFilter">
        <property name="offCommentFormat" value="CHECKSTYLE_OFF\: ([\w\|]+)"/>
        <property name="onCommentFormat" value="CHECKSTYLE_ON\: ([\w\|]+)"/>
        <property name="checkFormat" value="$1"/>
    </module>

</module>