checkstyle.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">

<!--
Checkstyle-Configuration: Android Style
Description: https://source.android.com/source/code-style.html

Modified for Okta.
Changed the rule for OIDCConfig to allow abbreviation.
Changed the rule for member name that must start with 'm'
See suppression.xml for individual files that skipped style checks.
-->
<module name="Checker">
    <!-- 100 char per line max, unless unavoidable -->
    <module name="LineLength">
        <property name="max" value="100"/>
        <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
    </module>

    <module name="SuppressionFilter">
        <property name="file" value="${config_loc}/suppression.xml"/>
    </module>

    <module name="TreeWalker">

        <property name="fileExtensions" value="java, properties, xml"/>

        <!-- Default severity is error -->
        <property name="severity" value="warning"/>

        <!--#################################################################-->
        <!--################ NAMING CHECKS ##################################-->
        <!--#################################################################-->

        <!-- Require package names to be all lower-case -->
        <module name="PackageName">
            <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
            <message key="name.invalidPattern"
                     value="Package name ''{0}'' must be lower-case."/>
        </module>

        <!-- Require standard type names -->
        <module name="TypeName">
            <message key="name.invalidPattern"
                     value="Type name ''{0}'' must begin with a capital letter."/>
        </module>

        <!--
        Type parameters must either be a single upper-case character, or must begin
        with an upper-case character and end with "T" (e.g. DataT).
        -->
        <module name="ClassTypeParameterName">
            <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]+[T]$)"/>
            <message key="name.invalidPattern"
                     value="Class type parameter ''{0}'' must either be a single upper-case character, or begin with an upper-case character and end with 'T'."/>
        </module>

        <!-- Non-public, non-static members must start with lowercase -->
        <module name="MemberName">
            <property name="format" value="^[a-zA-Z0-9_]*$"/>
            <property name="applyToPublic" value="false"/>
            <message key="name.invalidPattern"
                     value="Member name ''{0}'' must be at least two characters long."/>
        </module>

        <!--
        Require method names to be at least two characters long, and start with a
        lower case letter.
        -->
        <module name="MethodName">
            <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
            <message key="name.invalidPattern"
                     value="Method name ''{0}'' must be at least two characters long."/>
        </module>

        <!--
        Type parameters must either be a single upper-case character, or must begin
        with an upper-case character and end with "T" (e.g. DataT).
        -->
        <module name="MethodTypeParameterName">
            <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]+[T]$)"/>
            <message key="name.invalidPattern"
                     value="Method type parameter ''{0}'' must either be a single upper-case character or begin with an upper-case character and end with 'T'."/>
        </module>

        <!-- Require parameter names to be at least two characters long -->
        <module name="ParameterName">
            <property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
            <message key="name.invalidPattern"
                     value="Parameter name ''{0}'' must be at least two characters long."/>
        </module>

        <!--
        Require local variables to be at least two characters long,
        unless they are counters on a for loop.
        -->
        <module name="LocalVariableName">
            <property name="tokens" value="VARIABLE_DEF"/>
            <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
            <property name="allowOneCharVarInForLoop" value="true"/>
            <message key="name.invalidPattern"
                     value="Local variable name ''{0}'' must be at least two characters long."/>
        </module>

        <!-- Require that constants be capitalized. -->
        <module name="ConstantName"/>

        <module name="LocalFinalVariableName"/>

        <!--
        Require that static, non-public, non-final variable names be prefixed
        with "s".
        -->
        <module name="StaticVariableName">
            <property name="format" value="^s[A-Z][a-zA-Z0-9]*$"/>
            <message key="name.invalidPattern"
                     value="Static variable name ''{0}'' must be prefixed with s and be at least two characters long."/>
        </module>

        <!-- Capitalized abbreviations are forbidden (e.g. URL, XML, HTTP)-->
        <module name="AbbreviationAsWordInName">
            <property name="ignoreFinal" value="false"/>
            <property name="allowedAbbreviationLength" value="1"/>
        </module>

        <!-- Forbid unnecessary escaping. -->
        <module name="IllegalTokenText">
            <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
            <property name="format"
                      value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
            <property name="message" value="Avoid using corresponding octal or Unicode escape."/>
        </module>

        <!-- Forbid unnecessary unicode escapes -->
        <module name="AvoidEscapedUnicodeCharacters">
            <property name="allowEscapesForControlCharacters" value="true"/>
            <property name="allowByTailComment" value="true"/>
            <property name="allowNonPrintableEscapes" value="true"/>
        </module>

        <!-- Require array notation on type (e.g. int[] x, not int x[]) -->
        <module name="ArrayTypeStyle"/>

        <!--###################################################-->
        <!--################ IMPORTS ##########################-->
        <!--###################################################-->

        <!-- Star imports are forbidden. -->
        <module name="AvoidStarImport"/>

        <!-- Forbid imports from sun.* -->
        <module name="IllegalImport"/>

        <!-- Forbid redudant imports (e.g. import java.lang.String;) -->
        <module name="RedundantImport"/>

        <!-- Forbid unused imports -->
        <module name="UnusedImports"/>

        <!-- Forbid redundant modifiers -->
        <module name="RedundantModifier"/>

        <!--##############################################################-->
        <!--################ STRUCTURAL / WRAPPING CHECKS ################-->
        <!--##############################################################-->

        <!-- Require One top-level class per file -->
        <module name="OneTopLevelClass"/>

        <!-- Line-wrapping in import statements is forbidden. -->
        <module name="NoLineWrap"/>

        <!-- Empty catch blocks are forbidden. -->
        <module name="EmptyCatchBlock">
            <property name="exceptionVariableName" value="expected|ignore"/>
        </module>

        <!-- Require braces for all code blocks -->
        <module name="NeedBraces"/>

        <!-- Require One statement per line (e.g. no "a = b; c = d;") -->
        <module name="OneStatementPerLine"/>

        <!-- Multiple variable declarations on one line is forbidden. -->
        <module name="MultipleVariableDeclarations"/>

        <!-- Require switch statements to have default clause -->
        <module name="MissingSwitchDefault"/>

        <!--
        Case fall-through in switch statements is forbidden, except where an
        explicit "// fall-through" comment exists.
        -->
        <module name="FallThrough">
            <property name="reliefPattern" value="fall-through"/>
        </module>

        <!-- Require empty lines between definitions -->
        <module name="EmptyLineSeparator">
            <property name="allowNoEmptyLineBetweenFields" value="true"/>
        </module>

        <!-- Wrap only permitted before dot, e.g.
        fluentInterface.doX()
            .doY()
            .doZ();
        -->
        <module name="SeparatorWrap">
            <property name="tokens" value="DOT"/>
            <property name="option" value="nl"/>
        </module>

        <!-- Wrap only permitted after comma, e.g.
        doThings(withA,
            withB,
            withC);
        -->
        <module name="SeparatorWrap">
            <property name="tokens" value="COMMA"/>
            <property name="option" value="EOL"/>
        </module>

        <!--
        Require that annotations on type, method and constructor definitions be on
        a separate line.
        -->
        <module name="AnnotationLocation">
            <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
        </module>

        <!--
        Variable declarations may have annotations on the same line.
        -->
        <module name="AnnotationLocation">
            <property name="tokens" value="VARIABLE_DEF"/>
            <property name="allowSamelineMultipleAnnotations" value="true"/>
        </module>

        <!-- Forbid empty statements -->
        <module name="EmptyStatement"/>

        <!--#################################################################-->
        <!--################ WHITESPACE / LINE LENGTH CHECKS ################-->
        <!--#################################################################-->

        <!-- Forbid whitespace after prefix unary operators and accessors -->
        <module name="NoWhitespaceAfter">
            <property name="tokens" value="BNOT,DEC,DOT,INC,LNOT,UNARY_MINUS,UNARY_PLUS"/>
        </module>

        <!--
        Forbid whitespace before comma, semi-colon, and postfix unary operators
        -->
        <module name="NoWhitespaceBefore"/>

        <!-- Require whitespace around common tokens (=, if, etc.) -->
        <module name="WhitespaceAround">
            <property name="allowEmptyConstructors" value="true"/>
            <property name="allowEmptyMethods" value="true"/>
            <property name="allowEmptyTypes" value="true"/>
            <property name="allowEmptyLoops" value="true"/>
            <message key="ws.notFollowed"
                     value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
            <message key="ws.notPreceded"
                     value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
        </module>

        <!-- Require standard whitespace around type parameters -->
        <module name="GenericWhitespace">
            <message key="ws.followed"
                     value="GenericWhitespace ''{0}'' is followed by whitespace."/>
            <message key="ws.preceded"
                     value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
            <message key="ws.illegalFollow"
                     value="GenericWhitespace ''{0}'' should followed by whitespace."/>
            <message key="ws.notPreceded"
                     value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
        </module>

        <!-- Require Android standard indentation. -->
        <module name="Indentation">
            <property name="basicOffset" value="4"/>
            <property name="braceAdjustment" value="0"/>
            <property name="caseIndent" value="4"/>
            <property name="throwsIndent" value="8"/>
            <property name="lineWrappingIndentation" value="8"/>
            <property name="arrayInitIndent" value="4"/>
        </module>

        <!--
        Require that comments be placed at the same level of indentation as
        surrounding code.
        -->
        <module name="CommentsIndentation"/>

        <!--#################################################################-->
        <!--################ MISC. LANGUAGE CHECKS ##########################-->
        <!--#################################################################-->

        <!-- File name must correspond to contained class -->
        <module name="OuterTypeFilename"/>

        <!--
        Long constants must be suffixed with L:
        "The suffix L is preferred, because the letter l (ell) is often hard to
        distinguish from the digit 1 (one)."
        http://docs.oracle.com/javase/specs/jls/se8/html/jls-3.html#jls-3.10.1
        -->
        <module name="UpperEll"/>

        <!--
        Require modifier order consistent with recommends in JLS:
        http://docs.oracle.com/javase/specs/jls/se8/html/jls-8.html
        -->
        <module name="ModifierOrder"/>

        <!-- Finalizers are forbidden. -->
        <module name="NoFinalizer"/>

        <!-- overloaded methods must be grouped together -->
        <module name="OverloadMethodsDeclarationOrder"/>

        <!-- Require variables to be declared close to where they are used -->
        <module name="VariableDeclarationUsageDistance"/>

        <!-- Require that equals() and hashCode() are overridden together -->
        <module name="EqualsHashCode"/>

        <!-- Forbid shadowing fields or variables -->
        <module name="HiddenField">
            <!-- exception: constructor parameters -->
            <property name="ignoreConstructorParameter" value="true"/>
            <!-- exception: setter method parameters -->
            <property name="ignoreSetter" value="true"/>
        </module>

        <!--
        Forbid assignments in expressions, with the exception of loop conditions
        -->
        <module name="InnerAssignment"/>

        <!-- Require @Override on overridden methods -->
        <module name="MissingOverride"/>

        <!-- Forbid arbitrarily nested blocks -->
        <module name="AvoidNestedBlocks"/>

        <!-- Forbid the use of arbitrary numeric literals -->
        <module name="MagicNumber"/>

        <!-- Require boolean expressions to be simplifed -->
        <module name="SimplifyBooleanExpression"/>

        <!-- Require boolean returns to be simplified -->
        <module name="SimplifyBooleanReturn"/>

        <!-- Forbid interfaces with no methods -->
        <module name="InterfaceIsType"/>

        <!--#################################################################-->
        <!--################ JAVADOC CHECKS #################################-->
        <!--#################################################################-->

        <!-- Require Javadoc for all protected and public methods -->
        <module name="JavadocMethod">
            <property name="validateThrows" value="true"/>
            <property name="allowMissingParamTags" value="true"/>
            <property name="allowMissingReturnTag" value="true"/>
        </module>

        <!-- Require Javadoc for all protected and public classes -->
        <module name="JavadocType">
            <property name="scope" value="public"/>
        </module>
        <!-- Ensure proper Javadoc style for protected and public elements -->
        <module name="JavadocStyle">
            <property name="scope" value="protected"/>
            <property name="checkHtml" value="false"/>
        </module>

        <!-- Summary lines for Javadoc should have good style -->
        <module name="SummaryJavadoc">
            <property name="forbiddenSummaryFragments"
                      value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )|^Created by"/>
        </module>

        <!-- Javadoc blocks should fit in a single line -->
        <module name="SingleLineJavadoc"/>

        <!-- Require Javadoc to have proper paragraph tags -->
        <module name="JavadocParagraph"/>

        <!-- At-clauses in Javadoc should not be empty -->
        <module name="NonEmptyAtclauseDescription"/>

    </module>

    <!--################################################-->
    <!--################ Non-AST checks ################-->
    <!--################################################-->

    <!-- Ensure the copyright header appears in every java source file -->
    <module name="RegexpHeader">
        <property name="headerFile" value="${checkstyle.java.header}"/>
        <property name="fileExtensions" value="java"/>
        <message key="header.mismatch"
                 value="Expecting the file to start with a Copyright notice"/>
        <message key="header.missing"
                 value="Expecting the file to start with a Copyright notice"/>
    </module>

    <!-- Report every line containing a tab character" -->
    <module name="FileTabCharacter">
        <property name="eachLine" value="true"/>
    </module>

    <!-- Forbid trailing whitespace -->
    <module name="RegexpSingleline">
        <property name="format" value="\s+$"/>
        <property name="message" value="Line has trailing whitespace."/>
    </module>

    <!-- Require Javadoc for all packages -->
    <module name="JavadocPackage"/>

    <!-- Require a new line at the end of all files -->
    <module name="NewlineAtEndOfFile"/>
</module>