<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
    "-//Puppy Crawl//DTD Check Configuration 1.0//EN"
    "http://www.puppycrawl.com/dtds/configuration_1_0.dtd">
<!--
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
 this work for additional information regarding copyright ownership.
 The ASF licenses this file to You 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.

-->

<!--

  a 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

-->

<module name="Checker">

  <module name="TreeWalker">

    <!--                         code conventions -->

    <!-- naming conventions -->
    <module name="ConstantName"/>
    <module name="MethodName"/>
    <module name="LocalFinalVariableName"/>
    <module name="LocalVariableName"/>
    <module name="MemberName"/>
    <module name="ParameterName"/>
    <module name="TypeName"/>
    <module name="StaticVariableName"/>
    <module name="PackageName"/>

    <!-- code layout -->
    <module name="RightCurly"/>
    <module name="LeftCurly"/>
    <module name="NeedBraces"/>
    <module name="OperatorWrap"/>

    <!-- standard whitespace settings -->
    <module name="ParenPad"/>
    <!--  default conflicts with jalopy configuration which
              places a space after the opening brace of an array initialization  -->
    <module name="NoWhitespaceAfter">
        <property name="tokens" value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS"/>
    </module>
    <module name="NoWhitespaceBefore"/>
    <module name="WhitespaceAfter"/>
    <module name="WhitespaceAround"/>



    <!--                       JavaDoc guidelines -->
    <module name="JavadocMethod"/>
    <module name="JavadocType"/>
    <module name="JavadocVariable"/>


    <!--                                        JLS -->
    <!--    <module name="RedundantModifier"/> -->
    <module name="ModifierOrder"/>
    <module name="UpperEll"/>



    <!--                                    Api Doc -->

    <!-- override hashCode whenever you override equals() -->
    <module name="EqualsHashCode"/>

    <!-- don't create new instances of Boolean,
         use Boolean.TRUE/FALSE or Boolean.valueOf() instead -->
    <module name="IllegalInstantiation">
      <property name="classes" value="java.lang.Boolean"/>
    </module>



    <!--                             best practices -->

    <!-- don't allow empty blocks (in particular catch blocks) -->
    <module name="EmptyBlock"/>

    <!-- avoid inner assignments -->
    <module name="InnerAssignment"/>

    <!-- don't allow imports from the sun.* package hierarchy -->
    <module name="IllegalImport"/>

    <!-- don't allow public members -->
    <module name="VisibilityModifier">
      <property name="protectedAllowed" value="true"/>
      <property name="packageAllowed" value="true"/>
    </module>


    <!-- simplify your code -->
    <!-- <module name="RedundantImport"/> -->
    <module name="UnusedImports"/>
    <module name="SimplifyBooleanExpression"/>
    <module name="SimplifyBooleanReturn"/>
    <module name="AvoidStarImport"/>

    <!-- flag reminder comments -->
    <module name="TodoComment"/>

    <!-- enforce default length limits -->
    <!--
    <module name="LineLength"/>
    <module name="MethodLength"/>
    <module name="FileLength"/>
    -->

    <!-- don't allow tabs -->
    <module name="TabCharacter"/>

  </module>

  <!-- enforce package documentation -->
  <module name="PackageHtml"/>

</module>
