checkstyle.xml

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

<!--
  Copyright (C) 2015 Seoul National University

  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.
-->
<!--

  This configuration is based on the one for Hadoop that is based on the
  sun_checks.xml file that is bundled with Checkstyle and includes checks
  for:

    - 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 each Java package has a Javadoc file, package-info.java, used for commenting. -->
  <!-- See http://checkstyle.sourceforge.net/config_javadoc.html#JavadocPackage -->
  <module name="JavadocPackage"/>

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

  <!-- Checks that source files are not too long (default: 2000 lines). -->
  <module name="FileLength"/>

  <!-- Checks that there are no tab characters in the source code. -->
  <module name="FileTabCharacter"/>

  <!-- Allows use of @SuppressWarnings annotation to suppress audits. Used with SuppressWarningsHolder. -->
  <!-- See http://checkstyle.sourceforge.net/config.html#Filters -->
  <module name="SuppressWarningsFilter"/>

  <module name="TreeWalker">
    <!-- Checks that local variables that never have their values changed are declared final. -->
    <!-- See http://checkstyle.sourceforge.net/config_coding.html#FinalLocalVariable -->
    <!-- This check fails to detect all violations. -->
    <!-- IntelliJ inspections were used to identify and fix undetected violations. -->
    <module name="FinalLocalVariable">
      <property name="validateEnhancedForLoopVariable" value="true"/>
    </module>

    <!-- Allows use of @SuppressWarnings annotation to suppress audits. Used with SuppressWarningsFilter. -->
    <module name="SuppressWarningsHolder"/>

    <!-- Checks for Javadoc comments. TODO #77 Turn on this check. Currently just a warning. -->
    <!-- See http://checkstyle.sf.net/config_javadoc.html -->
    <module name="JavadocType">
      <property name="scope" value="public"/>
      <property name="allowMissingParamTags" value="true"/>
      <property name="severity" value="warning"/>
    </module>
    <module name="JavadocStyle"/>

    <!-- 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_imports.html -->
    <module name="RedundantImport"/>
    <module name="UnusedImports"/>


    <!-- Checks for Size Violations.                    -->
    <!-- See http://checkstyle.sf.net/config_sizes.html -->
    <!-- Checks that line length is max 120 except for import statements. -->
    <module name="LineLength">
      <property name="ignorePattern" value="^import"/>
      <property name="max" value="120"/>
    </module>
    <!-- Checks that methods are not too long (default: 150 lines). -->
    <module name="MethodLength"/>

    <!-- Checks for whitespace                               -->
    <!-- See http://checkstyle.sf.net/config_whitespace.html -->
    <module name="EmptyForIteratorPad"/>
    <module name="MethodParamPad"/>
    <module name="NoWhitespaceAfter"/>
    <module name="NoWhitespaceBefore"/>
    <module name="ParenPad"/>
    <module name="TypecastParenPad"/>
    <module name="WhitespaceAfter">
      <property name="tokens" value="COMMA, SEMI"/>
    </module>
    <module name="WhitespaceAround">
      <property name="ignoreEnhancedForColon" value="false"/>
    </module>


    <!-- Modifier Checks                                    -->
    <!-- See http://checkstyle.sf.net/config_modifier.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">
      <property name="allowInSwitchCase" value="true"/>
    </module>
    <module name="EmptyBlock">
      <property name="option" value="text"/>
    </module>
    <module name="LeftCurly"/>
    <module name="NeedBraces"/>
    <module name="RightCurly"/>


    <!-- Checks for common coding problems               -->
    <!-- See http://checkstyle.sf.net/config_coding.html -->
    <module name="EmptyStatement"/>
    <module name="EqualsHashCode"/>
    <!-- Checks that local variables do not hide fields, except for constructors and setters. -->
    <module name="HiddenField">
      <property name="ignoreConstructorParameter" value="true"/>
      <property name="ignoreSetter" value="true"/>
      <property name="setterCanReturnItsClass" value="true"/>
    </module>
    <module name="InnerAssignment"/>
    <module name="MissingSwitchDefault"/>
    <module name="SimplifyBooleanExpression"/>
    <module name="SimplifyBooleanReturn"/>

    <!-- Checks for class design                         -->
    <!-- See http://checkstyle.sf.net/config_design.html -->
    <module name="FinalClass">
      <property name="severity" value="error"/>
		</module>

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


    <!-- Miscellaneous other checks.                   -->
    <!-- See http://checkstyle.sf.net/config_misc.html -->
    <module name="ArrayTypeStyle"/>
    <module name="Indentation">
      <property name="basicOffset" value="2"/>
      <property name="caseIndent" value="0"/>
    </module>
    <module name="UpperEll"/>
    <!-- Checks for proper TODO comment format -->
    <!--
      All TODO comments should follow the following format:
        TODO #Number: Comment
      Throws an checkstyle error if an incorrect format is used.
    -->
    <module name="TodoComment">
      <property name="severity" value="info"/>
      <property name="format" value="TODO #\d+: .*"/>
    </module>
    <module name="TodoComment">
      <property name="severity" value="error"/>
      <property name="format" value="TODO(?! #\d+: ).*"/>
    </module>
    <!-- Check that parameters for methods, constructors, and catch blocks are final. -->
    <module name="FinalParameters"/>
  </module>

</module>