checkstyle.xml

<?xml version="1.0"?>
<!--
  This software was produced for the U. S. Government
  under Contract No. W15P7T-11-C-F600, and is
  subject to the Rights in Noncommercial Computer Software
  and Noncommercial Computer Software Documentation
  Clause 252.227-7014 (JUN 1995)

  Copyright 2013 The MITRE Corporation. All Rights Reserved.

  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
    "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
    "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">

<!--

  Checkstyle configuration that checks for some fairly minimal conventions. Some
    coding convention sources this is partially borrowed from are:

    - 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">
  <property name="severity" value="warning"/>

  <!--
      If you set the basedir property below, then all reported file
      names will be relative to the specified directory. See
      http://checkstyle.sourceforge.net/5.x/config.html#Checker
  -->
  <!--<property name="basedir" value="${basedir}"/>-->

  <module name="SuppressionFilter">
    <property name="file" value="${checkstyle.suppressions.file}" default="checkstyle-suppressions.xml"/>
  </module>

  <!-- http://checkstyle.sourceforge.net/config_duplicates.html -->
  <module name="StrictDuplicateCode">
    <property name="min" value="15"/>
  </module>
  <!-- http://www.harukizaemon.com/simian/installation.html#checkstyle -->
  <!--<module name="au.com.redhillconsulting.simian.SimianCheck">-->
    <!--<property name="threshold" value="6"/>-->
  <!--</module>-->


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

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

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

  <!-- Checks for Size Violations.                    -->
  <!-- See http://checkstyle.sf.net/config_sizes.html -->
  <module name="FileLength"/>

  <!-- Checks for whitespace                               -->
  <!-- See http://checkstyle.sf.net/config_whitespace.html -->
  <module name="FileTabCharacter">
    <property name="severity" value="error"/>
  </module>

  <!-- Miscellaneous other checks.                   -->
  <!-- See http://checkstyle.sf.net/config_misc.html -->
  <module name="RegexpSingleline">
    <property name="format" value="\s+$"/>
    <property name="minimum" value="0"/>
    <property name="maximum" value="0"/>
    <property name="message" value="Line has trailing spaces."/>
  </module>

  <!-- Checks for Headers                                -->
  <!-- See http://checkstyle.sf.net/config_header.html   -->
  <!-- <module name="Header"> -->
  <!--   <property name="headerFile" value="${checkstyle.header.file}"/> -->
  <!--   <property name="fileExtensions" value="java"/> -->
  <!-- </module> -->

  <module name="TreeWalker">
    <property name="tabWidth" value="${checkstyle.indentChars}" default="2"/>

    <module name="Indentation">
      <property name="severity" value="warning"/>
      <property name="basicOffset" value="${checkstyle.indentChars}" default="2"/>
      <property name="caseIndent" value="${checkstyle.indentChars}" default="2"/>
      <!-- https://sourceforge.net/p/checkstyle/patches/226/
          and https://github.com/maikelsteneker/checkstyle-throwsIndent -->
      <!--<property name="throwsIndent" value="${checkstyle.indentCharsThrows}" default="4"/>-->
    </module>

    <!-- http://checkstyle.sourceforge.net/config_annotation.html -->
    <module name="MissingOverride"/>

    <!-- http://checkstyle.sourceforge.net/config_coding.html -->
    <module name="CovariantEquals"/>
    <module name="EqualsHashCode"/>

    <!-- Checks for Javadoc comments.                     -->
    <!-- See http://checkstyle.sf.net/config_javadoc.html -->
    <!--<module name="JavadocMethod"/>-->
    <!--<module name="JavadocType"/>-->
    <!--<module name="JavadocVariable"/>-->
    <!--<module name="JavadocStyle"/>-->

    <!-- Checks for Naming Conventions.                  -->
    <!-- See http://checkstyle.sf.net/config_naming.html -->
    <module name="ClassTypeParameterName">
      <property name="severity" value="error"/>
    </module>
    <!-- As per Sun convention except also allowing "logger"  or "log"
         since some people don't like references to "LOGGER" shouting out all
         over their code -->
    <module name="ConstantName">
      <property name="severity" value="error"/>
      <property name="format" value="^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^log(ger)?$"/>
    </module>
    <module name="LocalFinalVariableName">
    </module>
    <module name="LocalVariableName">
    </module>
    <module name="MemberName">
      <property name="severity" value="error"/>
    </module>
    <module name="MethodName">
      <property name="severity" value="error"/>
    </module>
    <module name="MethodTypeParameterName">
      <property name="severity" value="error"/>
    </module>
    <module name="PackageName">
      <property name="severity" value="error"/>
    </module>
    <module name="ParameterName">
      <property name="severity" value="error"/>
    </module>
    <module name="StaticVariableName">
      <property name="severity" value="error"/>
    </module>
    <module name="TypeName">
      <property name="severity" value="error"/>
    </module>


    <!-- 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">
      <property name="processJavadoc" value="true" />
    </module>

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


    <!-- Checks for whitespace                               -->
    <!-- See http://checkstyle.sf.net/config_whitespace.html -->
    <!--<module name="EmptyForIteratorPad"/>-->
    <!--<module name="GenericWhitespace"/>-->
    <!--<module name="MethodParamPad"/>-->
    <!--<module name="NoWhitespaceAfter"/>-->
    <!--<module name="NoWhitespaceBefore"/>-->
    <!--<module name="OperatorWrap"/>-->
    <!--<module name="ParenPad"/>-->
    <!--<module name="TypecastParenPad"/>-->
    <!--<module name="WhitespaceAfter"/>--><!-- TODO customize -->
    <!--<module name="WhitespaceAround"/>-->


    <!-- 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">
      <property name="severity" value="error" />
      <property name="option" value="text" /><!-- at least include a comment -->
    </module>
    <module name="LeftCurly"/>
    <!--<module name="NeedBraces"/>-->
    <module name="RightCurly"/>

    <!-- 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">
      <property name="severity" value="error" />
    </module>
    <!--<module name="FinalParameters"/>-->
    <!--<module name="TodoComment"/>-->
    <module name="UpperEll">
      <property name="severity" value="error" />
    </module>
    <module name="OuterTypeFilename">
      <property name="severity" value="error" />
    </module>

  </module>

</module>