checkstyle.xml

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" "https://checkstyle.org/dtds/configuration_1_3.dtd">

<module name="Checker">
    <property name="charset" value="UTF-8"/>

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

    <module name="TreeWalker">
        <property name="tabWidth" value="4"/>

        <!-- custom rules -->
        <module name="RegexpSinglelineJava">
            <property name="format" value='^[\t]* '/>
            <property name="message" value="Indent must use tab characters"/>
            <property name="ignoreComments" value="true"/>
            <property name="severity" value="error"/>
        </module>
        <module name="RegexpSinglelineJava">
            <property name="format" value='^import jersey\.repackaged'/>
            <property name="message" value="Don't use repackaged libraries"/>
            <property name="ignoreComments" value="true"/>
            <property name="severity" value="error"/>
        </module>
        <module name="RegexpSinglelineJava">
            <property name="format" value='^[\t]*  +\*'/>
            <property name="message" value="Comment indent must use tab characters"/>
            <property name="severity" value="error"/>
        </module>
        <module name="RegexpSinglelineJava">
            <property name="format" value='\S\s+$'/>
            <property name="message" value="trailing whitespaces"/>
        </module>
        <module name="WhitespaceAround">
            <property name="tokens" value="LCURLY"/>
            <property name="allowEmptyTypes" value="true"/>
        </module>
        <module name="RegexpSinglelineJava">
            <property name="format" value='@.*\s(class|interface|enum|private|public|protected)'/>
            <property name="ignoreComments" value="true"/>
            <property name="message" value="No Annotations at the class definition level."/>
        </module>

        <module name="RegexpSinglelineJava">
            <property name="format" value="System\.out\."/>
            <property name="severity" value="error"/>
        </module>


        <module name="CommentsIndentation"/>
        <module name="AvoidStarImport"/>
        <module name="Indentation"/>
        <module name="PackageName">
            <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
            <message key="name.invalidPattern"
                     value="Package name ''{0}'' must match pattern ''{1}''."/>
        </module>
        <module name="TypeName">
            <message key="name.invalidPattern"
                     value="Type name ''{0}'' must match pattern ''{1}''."/>
        </module>
        <module name="MemberName">
            <property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
            <message key="name.invalidPattern"
                     value="Member name ''{0}'' must match pattern ''{1}''."/>
        </module>
        <module name="ParameterName">
            <property name="format" value="^[a-z]([a-zA-Z0-9]*)?$"/>
            <message key="name.invalidPattern"
                     value="Parameter name ''{0}'' must match pattern ''{1}''."/>
        </module>
        <module name="CatchParameterName">
            <property name="format" value="^[a-z]([a-zA-Z0-9]*)?$"/>
            <message key="name.invalidPattern"
                     value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
        </module>
        <module name="LocalVariableName">
            <property name="tokens" value="VARIABLE_DEF"/>
            <property name="format" value="^[a-z]([a-zA-Z0-9]*)?$"/>
            <message key="name.invalidPattern"
                     value="Local variable name ''{0}'' must match pattern ''{1}''."/>
        </module>
        <module name="ClassTypeParameterName">
            <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][_A-Z0-9]*$)"/>
            <message key="name.invalidPattern"
                     value="Class type name ''{0}'' must match pattern ''{1}''."/>
        </module>
        <module name="MethodTypeParameterName">
            <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][_A-Z0-9]*$)"/>
            <message key="name.invalidPattern"
                     value="Method type name ''{0}'' must match pattern ''{1}''."/>
        </module>
        <module name="InterfaceTypeParameterName">
            <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*$)"/>
            <message key="name.invalidPattern"
                     value="Interface type name ''{0}'' must match pattern ''{1}''."/>
        </module>
        <module name="NoFinalizer"/>

        <!-- more code formatting rules -->
        <module name="AnnotationUseStyle"/>
        <module name="MissingDeprecated"/>
        <module name="MissingOverride"/>
        <module name="PackageAnnotation"/>
        <module name="EmptyBlock"/>
        <module name="EmptyCatchBlock"/>
        <module name="LeftCurly">
            <property name="tokens"
                      value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF, INTERFACE_DEF, LAMBDA, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF, OBJBLOCK, STATIC_INIT"/>
        </module>
        <module name="RightCurly">
            <property name="option" value="alone_or_singleline"/>
        </module>
        <module name="MutableException"/>
        <module name="ThrowsCount"/>
        <module name="MissingSwitchDefault"/>
        <module name="NoFinalizer"/>
        <module name="RedundantImport"/>
        <module name="UnusedImports"/>
        <module name="ArrayTypeStyle"/>
        <module name="AvoidEscapedUnicodeCharacters">
            <property name="allowEscapesForControlCharacters" value="true"/>
        </module>
        <module name="TrailingComment"/>
        <module name="UncommentedMain">
            <property name="excludedClasses" value="^com\.bakdata\.conquery\.Conquery$"/>
        </module>
        <module name="UpperEll"/>
        <module name="ModifierOrder"/>
        <module name="RedundantModifier"/>


        <!-- Javadoc requirements -->
        <module name="AtclauseOrder"/>
        <!--
        <module name="JavadocMethod">
            <property name="allowUndeclaredRTE" value="true"/>
            <property name="allowedAnnotations" value="Override"/>
            <property name="validateThrows" value="true"/>
        </module>
        <module name="JavadocStyle"/>
        <module name="JavadocTagContinuationIndentation"/>
        <module name="JavadocType">
            <property name="allowedAnnotations" value="Getter,Setter,Slf4j,Builder,UtilityClass"/>
        </module>
        <module name="JavadocVariable"/>
        <module name="JavadocPackage"/>
         -->
        <module name="RegexpSinglelineJava">
            <property name="format" value='@author'/>
            <property name="message" value="author tags are forbidden"/>
            <property name="ignoreComments" value="false"/>
            <property name="severity" value="error"/>
        </module>

        <module name="NonEmptyAtclauseDescription"/>
        <module name="SingleLineJavadoc">
            <property name="ignoredTags" value="@inheritDoc, @see"/>
            <property name="ignoreInlineTags" value="false"/>
        </module>
        <module name="SummaryJavadocCheck"/>
    </module>
</module>