checkstyle-style.xml

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

<!-- This configuration file was written by the eclipse-cs plugin configuration
    editor -->
<!-- Checkstyle-Configuration: Bard Project Description: none -->
<module name="Checker">

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


    <module name="SuppressWithPlainTextCommentFilter">
        <property name="offCommentFormat" value="    // CHECKSTYLE:OFF"/>
        <property name="onCommentFormat" value="    // CHECKSTYLE:ON"/>
    </module>

    <module name="LineLength">
        <property name="severity" value="error" />
        <property name="ignorePattern" value="^import.*$" />
        <property name="max" value="120" />
        <property name="tabWidth" value="4" />
        <property name="fileExtensions" value="java" />
        <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity"
                  value="inherit" />
        <metadata name="net.sf.eclipsecs.core.comment"
                  value="Line length of 120 characters except for import lines." />
    </module>

    <module name="TreeWalker">
        <module name="RedundantModifier">
            <property name="severity" value="error" />
        </module>

	<!-- Make the @SuppressWarnings annotations available to Checkstyle -->
	    <module name="SuppressWarningsHolder" />

        <module name="ConstantName">
            <property name="severity" value="error" />
            <property name="format" value="^[A-Z][A-Z0-9_]*$" />
            <metadata name="net.sf.eclipsecs.core.comment"
                value="Constants (static finals) must be uppercase letters/digits/underscore." />
        </module>

        <module name="RedundantImport">
            <property name="severity" value="error" />
            <metadata name="net.sf.eclipsecs.core.comment"
                value="Duplicate import checking." />
        </module>

        <module name="UnusedImports">
            <property name="severity" value="error" />
            <metadata name="net.sf.eclipsecs.core.comment"
                value="Unused imports checking." />
        </module>

        <module name="MethodName">
            <property name="severity" value="error" />
            <property name="format" value="^[a-z][a-zA-Z0-9]*$" />
            <metadata name="net.sf.eclipsecs.core.comment"
                value="Method name check." />
        </module>

        <module name="LocalVariableName">
            <property name="severity" value="error" />
            <property name="format" value="^[a-z][a-zA-Z0-9]*$" />
            <metadata name="net.sf.eclipsecs.core.comment"
                value="Local variable name check." />
        </module>

        <module name="LocalFinalVariableName">
            <property name="severity" value="error" />
            <property name="format" value="^[a-z][a-zA-Z0-9]*$" />
            <metadata name="net.sf.eclipsecs.core.comment"
                value="Local final variable name check." />
        </module>

        <module name="MemberName">
            <property name="severity" value="error" />
            <property name="format" value="^[a-z][a-zA-Z0-9]*$" />
            <metadata name="net.sf.eclipsecs.core.comment"
                value="Member name check." />
        </module>

        <module name="TypeName">
            <property name="severity" value="error" />
            <property name="format" value="^[A-Z][a-zA-Z0-9]*$" />
            <metadata name="net.sf.eclipsecs.core.comment"
                value="Class name check." />
        </module>

        <module name="LeftCurly">
            <property name="tokens" value="INTERFACE_DEF,CLASS_DEF,ANNOTATION_DEF,ENUM_DEF,CTOR_DEF,METHOD_DEF,ENUM_CONSTANT_DEF,LITERAL_WHILE,LITERAL_TRY,LITERAL_CATCH,LITERAL_FINALLY,LITERAL_SYNCHRONIZED,LITERAL_SWITCH,LITERAL_DO,LITERAL_ELSE,LITERAL_FOR"/>
            <property name="severity" value="error" />
            <metadata name="net.sf.eclipsecs.core.comment" value="Left curly goes on end of line (eol)." />
        </module>

        <module name="RightCurly">
            <property name="severity" value="error" />
            <property name="option" value="same" />
            <property name="tokens" value="LITERAL_TRY,LITERAL_CATCH,LITERAL_FINALLY,LITERAL_ELSE"/>
            <metadata name="net.sf.eclipsecs.core.comment"
                value="Right curly goes same line as 'else', 'try', and 'catch'." />
        </module>

        <module name="NeedBraces">
            <property name="severity" value="error" />
            <metadata name="net.sf.eclipsecs.core.comment"
                value="Need braces for all code blocks." />
        </module>

        <module name="PackageDeclaration">
            <property name="severity" value="error"/>
            <property name="matchDirectoryStructure" value="true"/>
        </module>

        <module name="WhitespaceAround">
            <property name="severity" value="error" />
            <metadata name="net.sf.eclipsecs.core.comment"
                value="Checks that a token is surrounded by whitespace." />
        </module>

        <module name="WhitespaceAfter">
            <property name="severity" value="error" />
            <metadata name="net.sf.eclipsecs.core.comment"
                value="Checks that a token is followed by whitespace." />
        </module>

        <module name="ParenPad">
            <property name="severity" value="error" />
            <metadata name="net.sf.eclipsecs.core.comment"
                value="Checks the policy on the padding of parentheses." />
        </module>

        <module name="GenericWhitespace">
            <property name="severity" value="error" />
            <metadata name="net.sf.eclipsecs.core.comment"
                value="Fails if there is whitespace around generic '&lt;' '&gt;' characters." />
        </module>

        <module name="CyclomaticComplexity">
            <property name="severity" value="warning" />
            <property name="max" value="7" />
            <metadata name="net.sf.eclipsecs.core.comment"
                value="Cyclomatic complexity limit of 7." />
        </module>

        <module name="UpperEll">
            <property name="severity" value="error" />
            <metadata name="net.sf.eclipsecs.core.comment"
                value="Checks that long constants are defined with an upper ell. 'l' looks too much like '1'. " />
        </module>

        <module name="ArrayTypeStyle">
            <property name="severity" value="error" />
            <metadata name="net.sf.eclipsecs.core.comment"
                value="Enforce Java array type style." />
        </module>

        <!-- JavaDoc Checks -->
        <module name="JavadocStyle">
            <property name="severity" value="error" />
            <property name="checkEmptyJavadoc" value="true" />
            <property name="checkFirstSentence" value="true" />
            <property name="checkHtml" value="true" />
            <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit" />
            <metadata name="net.sf.eclipsecs.core.comment" value="Simple Javadoc style check." />
        </module>

        <module name="AtclauseOrder">
            <property name="severity" value="error" />
            <property name="tagOrder" value="@author, @version, @param, @return, @throws, @exception, @see, @since, @serial, @serialField, @serialData, @deprecated"/>
            <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit" />
            <metadata name="net.sf.eclipsecs.core.comment" value="Checks the order of Javadoc at-clauses." />
        </module>

        <module name="NonEmptyAtclauseDescription">
            <property name="severity" value="error" />
            <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit" />
            <metadata name="net.sf.eclipsecs.core.comment" value="Checks Javadoc At-Clause comments for descriptions." />
        </module>

        <module name="JavadocTagContinuationIndentation">
            <property name="severity" value="error" />
            <property name="offset" value="0" />
            <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit" />
            <metadata name="net.sf.eclipsecs.core.comment" value="Checks line continuation for Javadoc comments having no indent." />
        </module>

        <module name="JavadocType">
            <property name="severity" value="error" />
            <property name="scope" value="private" />
            <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit" />
            <metadata name="net.sf.eclipsecs.core.comment" value="Checks Javadoc comments for class and interface definitions." />
        </module>

        <module name="JavadocMethod">
            <property name="severity" value="error" />
            <property name="scope" value="private" />
            <property name="allowMissingParamTags" value="false" />
            <property name="validateThrows" value="false" />
            <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit" />
            <metadata name="net.sf.eclipsecs.core.comment" value="Checks the Javadoc of a method or constructor." />
        </module>

        <module name="JavadocVariable">
            <property name="severity" value="ignore" />
            <property name="scope" value="protected" />
            <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit" />
            <metadata name="net.sf.eclipsecs.core.comment" value="Checks that variables have Javadoc comments." />
        </module>

        <module name="EqualsHashCode">
            <property name="severity" value="error" />
            <metadata name="net.sf.eclipsecs.core.comment"
                value="Verify when Equals is overridden, hashCode is as well." />
        </module>

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

        <module name="ParameterNumber">
            <property name="severity" value="warning" />
        </module>

        <module name="MethodLength">
            <property name="severity" value="error" />
            <property name="max" value="160" />
        </module>

        <module name="RegexpSinglelineJava">
            <property name="severity" value="error" />
            <property name="format" value="\.toLowerCase\(\)" />
            <property name="message" value="use toLowerCase(Locale.ENGLISH)" />
            <property name="ignoreComments" value="true" />
            <metadata name="net.sf.eclipsecs.core.comment"
                value="toLowerCase must give a locale." />
        </module>

        <module name="RegexpSinglelineJava">
            <property name="severity" value="error" />
            <property name="format" value="\.toUpperCase\(\)" />
            <property name="message" value="use toUpperCase(Locale.ENGLISH)" />
            <property name="ignoreComments" value="true" />
            <metadata name="net.sf.eclipsecs.core.comment"
                value="toUpperCase must give a locale." />
        </module>

        <module name="EmptyBlock">
            <property name="severity" value="error" />
            <property name="option" value="text" />
        </module>

        <module name="SeparatorWrap">
            <metadata name="net.sf.eclipsecs.core.comment" value="When a line is broken at a non-assignment operator the break comes before the symbol." />
            <property name="severity" value="error" />
            <property name="option" value="nl" />
            <property name="tokens" value="DOT,ELLIPSIS,AT" />
        </module>

        <module name="SeparatorWrap">
            <metadata name="net.sf.eclipsecs.core.comment" value="A comma stays attached to the token that precedes it." />
            <property name="severity" value="error" />
            <property name="tokens" value="COMMA" />
        </module>

        <module name="HiddenField">
            <property name="severity" value="error" />
            <property name="tokens" value="VARIABLE_DEF"/>
        </module>

        <module name="SuppressionCommentFilter"/>

    </module>

    <module name="RegexpHeader">
        <property name="severity" value="error" />
        <property name="header"
            value="// Copyright 20[0-2][0-9],? (Yahoo Inc.|Oath Inc.)\n// Licensed under the terms of the Apache license. Please see LICENSE.md file distributed with this work for terms\.\n" />
        <property name="fileExtensions" value="java,groovy" />
        <metadata name="net.sf.eclipsecs.core.comment"
            value="Checks that the file starts with a yahoo copyright block." />
    </module>

    <module name="FileTabCharacter">
        <property name="severity" value="error" />
        <property name="eachLine" value="true" />
        <metadata name="net.sf.eclipsecs.core.comment" value="Enforce no tabs, only spaces for indent." />
    </module>

    <module name="NewlineAtEndOfFile">
        <property name="severity" value="error" />
        <property name="lineSeparator" value="lf" />
        <metadata name="net.sf.eclipsecs.core.comment" value="Enforce newline at end of file." />
    </module>

    <module name="RegexpMultiline">
        <metadata name="net.sf.eclipsecs.core.comment" value="Excessive white space" />
        <property name="severity" value="error" />
        <property name="format" value="^\R\R\R" />
        <property name="message" value="Excessive white space" />
    </module>

    <module name="RegexpMultiline">
        <metadata name="net.sf.eclipsecs.core.comment" value="Extra space at end of file" />
        <property name="severity" value="error" />
        <property name="format" value="^\R\Z" />
        <property name="message" value="Extra space at end of file" />
    </module>

    <module name="RegexpMultiline">
        <metadata name="net.sf.eclipsecs.core.comment" value="Extra lines between braces" />
        <property name="severity" value="error" />
        <property name="format" value="\}\R\R\s?\}" />
        <property name="message" value="Extra lines between braces" />
    </module>

    <module name="RegexpSingleline">
        <metadata name="net.sf.eclipsecs.core.comment" value="Trailing space" />
        <property name="severity" value="error" />
        <property name="format" value="\s$" />
        <property name="message" value="Trailing space" />
    </module>

    <module name="SuppressWarningsFilter" />

</module>