checkstyle.xml

<?xml version="1.0"?>
<!-- 
/*
 * Copyright 2001-2004 The Apache Software Foundation.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 -->

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

<!--

  Checkstyle configuration that checks the sun coding conventions from:

    - the Java Language Specification at
      http://java.sun.com/docs/books/jls/second_edition/html/index.html

    - the Sun Code Conventions at http://java.sun.com/docs/codeconv/

    - the Javadoc guidelines at
      http://java.sun.com/j2se/javadoc/writingdoccomments/index.html

    - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html

    - some best practices

  Checkstyle is very configurable. Be sure to read the documentation at
  http://checkstyle.sf.net (or in your downloaded distribution).

  Most Checks are configurable, be sure to consult the documentation.

  To completely disable a check, just comment it out or delete it from the file.

  Finally, it is worth reading the documentation.

-->

<module name="Checker">
  <!-- Checks that a package.html file exists for each package.     -->
  <!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml -->
  <!--module name="PackageHtml"/-->

  <!-- Checks whether files end with a new line.                        -->
  <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
  <!--<module name="NewlineAtEndOfFile">-->
  <!--<property name="lineSeparator" value="lf"/>-->
  <!--</module>-->


  <!-- Checks that property files contain the same keys.         -->
  <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->


  <!-- Checks for Headers                                -->
  <!-- See http://checkstyle.sf.net/config_header.html   -->
  <!-- <module name="Header">                            -->
  <!-- The follow property value demonstrates the ability     -->
  <!-- to have access to ANT properties. In this case it uses -->
  <!-- the ${basedir} property to allow Checkstyle to be run  -->
  <!-- from any directory within a project. See property      -->
  <!-- expansion,                                             -->
  <!-- http://checkstyle.sf.net/config.html#properties        -->
  <!-- <property                                              -->
  <!--     name="headerFile"                                  -->
  <!--     value="${basedir}/java.header"/>                   -->
  <!-- </module> -->

  <!-- Following interprets the header file as regular expressions. -->
  <!-- <module name="RegexpHeader"/>                                -->

  <module name="RegexpHeader">
    <property name="header" value="^/\*$\n^\s*\*\s+Licensed to Sematext Group, Inc$"/>
    <property name="fileExtensions" value=".java"/>
  </module>

  <module name="FileLength"/>

  <!--<module name="TabCharacter"/>-->

  <!-- Checks for common coding problems               -->
  <!-- See http://checkstyle.sf.net/config_coding.html -->
  <!--module name="AvoidInlineConditionals"/-->
  <!--<module name="DoubleCheckedLocking"/>-->


  <module name="TreeWalker">

    <property name="cacheFile" value="${checkstyle.cache.file}"/>

    <!-- Checks for Javadoc comments.                     -->
    <!-- See http://checkstyle.sf.net/config_javadoc.html -->
    <module name="JavadocMethod">
      <property name="allowMissingPropertyJavadoc" value="true"/>
      <property name="severity" value="ignore"/>
    </module>
    <module name="JavadocType">
      <property name="severity" value="warning"/>
      <property name="authorFormat" value="\S"/>
      <property name="allowMissingParamTags" value="true"/>
    </module>
    <module name="JavadocVariable">
      <property name="severity" value="ignore"/>
    </module>
    <module name="JavadocStyle">
      <property name="checkEmptyJavadoc" value="true"/>
      <property name="severity" value="ignore"/>
    </module>


    <!-- Checks for Naming Conventions.                  -->
    <!-- See http://checkstyle.sf.net/config_naming.html -->
    <module name="ConstantName"/>
    <module name="LocalFinalVariableName"/>
    <module name="LocalVariableName"/>
    <module name="MemberName"/>
    <module name="MethodName"/>
    <module name="PackageName"/>
    <module name="ParameterName"/>
    <module name="StaticVariableName"/>
    <module name="TypeName"/>

    <!-- Checks for imports                              -->
    <!-- See http://checkstyle.sf.net/config_import.html -->
    <module name="AvoidStarImport"/>
    <module name="IllegalImport"/>
    <!-- defaults to sun.* packages -->
    <module name="RedundantImport"/>
    <module name="UnusedImports"/>


    <!-- Checks for Size Violations.                    -->
    <!-- See http://checkstyle.sf.net/config_sizes.html -->
    <module name="LineLength">
      <property name="max" value="120"/>
      <property name="severity" value="warning"/>
    </module>
    <module name="MethodLength"/>
    <module name="ParameterNumber"/>


    <!-- Checks for whitespace                               -->
    <!-- See http://checkstyle.sf.net/config_whitespace.html -->
    <module name="EmptyForIteratorPad"/>
    <module name="MethodParamPad"/>
    <module name="OperatorWrap">
      <property name="option" value="eol"/>
    </module>
    <module name="ParenPad"/>
    <module name="TypecastParenPad"/>
    <module name="NoWhitespaceAfter">
      <!-- Default tokens without ARRAY_INIT and additional GENERIC_START -->
      <property name="tokens" value="BNOT, DEC, DOT, INC, LNOT,
                                         UNARY_MINUS, UNARY_PLUS"/>
    </module>
    <module name="NoWhitespaceBefore">
      <!-- Default tokens and additional GENERIC_START and GENERIC_END -->
      <property name="tokens" value="SEMI, POST_DEC, POST_INC,
                                         GENERIC_START, GENERIC_END"/>
    </module>
    <module name="WhitespaceAfter">
      <!-- Default tokens and additional GENERIC_END -->
      <property name="tokens" value="COMMA, SEMI, TYPECAST"/>
    </module>
    <module name="WhitespaceAround">
      <!-- Default tokens without GENERIC_START, GENERIC_END and WILDCARD_TYPE -->
      <property name="tokens"
                value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR,
                           BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, 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, QUESTION,
                           RCURLY, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN,
                           TYPE_EXTENSION_AND"/>
      <property name="allowEmptyConstructors" value="true"/>
      <property name="allowEmptyMethods" value="true"/>
    </module>


    <!-- Modifier Checks                                    -->
    <!-- See http://checkstyle.sf.net/config_modifiers.html -->
    <module name="ModifierOrder"/>
    <!--module name="RedundantModifier"/-->


    <!-- Checks for blocks. You know, those {}'s         -->
    <!-- See http://checkstyle.sf.net/config_blocks.html -->
    <module name="AvoidNestedBlocks"/>
    <module name="EmptyBlock"/>
    <module name="LeftCurly"/>
    <module name="NeedBraces"/>
    <module name="RightCurly"/>


    <!-- MY FAVOURITE -->
    <module name="EmptyStatement"/>
    <module name="EqualsHashCode"/>
    <!--module name="HiddenField"/-->
    <module name="IllegalInstantiation"/>
    <!--<module name="InnerAssignment"/>-->
    <module name="MagicNumber">
      <property name="severity" value="ignore"/>
    </module>
    <module name="MissingSwitchDefault"/>
    <module name="SimplifyBooleanExpression"/>
    <module name="SimplifyBooleanReturn"/>


    <!-- Checks for class design                         -->
    <!-- See http://checkstyle.sf.net/config_design.html -->
    <!--module name="DesignForExtension"/-->
    <module name="FinalClass"/>
    <module name="HideUtilityClassConstructor"/>
    <module name="InterfaceIsType"/>
    <module name="VisibilityModifier"/>


    <!-- Miscellaneous other checks.                   -->
    <!-- See http://checkstyle.sf.net/config_misc.html -->
    <module name="ArrayTypeStyle"/>
    <!--module name="FinalParameters"/-->
    <!--module name="GenericIllegalRegexp">
        <property name="format" value="\s+$"/>
        <property name="message" value="Line has trailing spaces."/>
    </module-->
    <module name="TodoComment">
      <property name="severity" value="warning"/>
    </module>
    <module name="UpperEll"/>
    <module name="SuppressionCommentFilter"/>
  </module>


</module>