Application: gvSIG desktop

<?xml version="1.0"?>

<!--

    gvSIG. Desktop Geographic Information System.

    Copyright (C) 2007-2013 gvSIG Association.

    This program is free software; you can redistribute it and/or

    modify it under the terms of the GNU General Public License

    as published by the Free Software Foundation; either version 3

    of the License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,

    but WITHOUT ANY WARRANTY; without even the implied warranty of

    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License

    along with this program; if not, write to the Free Software

    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

    MA  02110-1301, USA.

    For any additional information, do not hesitate to contact us

    at info AT gvsig.com, or visit our website www.gvsig.com.

-->

<!DOCTYPE module PUBLIC

    "-//Puppy Crawl//DTD Check Configuration 1.2//EN"

    "http://www.puppycrawl.com/dtds/configuration_1_2.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">

    <!--

        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}"/>

    -->

    <!-- gvSIG: All project files have the ISO-8859-1 charset -->

        <property name="charset" value="ISO-8859-1" />

    <!-- Checks that a package-info.java file exists for each package.     -->

    <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->

        <module name="JavadocPackage">

                <property name="allowLegacy" value="true" />

        </module>

    <!-- 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"/>

    <module name="TreeWalker">

            <!-- Miscellaneous other checks.                   -->

            <!-- See http://checkstyle.sf.net/config_misc.html -->

            <!-- gvSIG: apply only to java files -->

            <module name="RegexpSinglelineJava">

               <property name="format" value="\s+$"/>

               <property name="minimum" value="0"/>

               <property name="maximum" value="0"/>

               <property name="message" value="Line has trailing spaces."/>

               <property name="ignoreComments" value="true"/>

            </module>

        <!-- Checks for Javadoc comments.                     -->

        <!-- See http://checkstyle.sf.net/config_javadoc.html -->

                <!--

                        gvSIG rule 3: All protected or public classes must have a Javadoc comments,

                        except getters and setters

                -->

                <module name="JavadocMethod">

                        <property name="scope" value="protected" />

                        <property name="allowMissingPropertyJavadoc" value="true" />

                </module>

                <!--

                        gvSIG rule 9: All classes must have a Javadoc comment

                        with the "@author tag" and the "@version $Id$" tag included 

                -->

                <module name="JavadocType">

                        <property name="scope" value="private" />

                        <property name="authorFormat" value="\S" />

                        <property name="versionFormat" value="\$Id.*\$"/>

                </module>

        <module name="JavadocVariable">

                        <property name="scope" value="protected" />

                </module>

                <!-- gvSIG rule 3: Check correctly formatted Javadoc -->

                <module name="JavadocStyle">

                        <property name="scope" value="protected" />

                </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"/>

                <!-- gvSIG rule 15: All packages must begin with org.gvsig.  -->

                <module name="PackageName">

                        <property name="format" value="^org\.gvsig(\.[a-z][a-z0-9]*)+$" />

                </module>

                <!-- gvSIG advised rule 1: Abstract class names must begin with Abstract. -->

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

        <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"/>

        <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"/>

        <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"/>

        <module name="LeftCurly"/>

        <module name="NeedBraces"/>

        <module name="RightCurly"/>

        <!-- Checks for common coding problems               -->

        <!-- See http://checkstyle.sf.net/config_coding.html -->

        <module name="AvoidInlineConditionals"/>

        <module name="DoubleCheckedLocking"/>    <!-- MY FAVOURITE -->

        <module name="EmptyStatement"/>

        <module name="EqualsHashCode"/>

        <module name="HiddenField"/>

        <module name="IllegalInstantiation"/>

        <module name="InnerAssignment"/>

        <module name="MagicNumber"/>

        <module name="MissingSwitchDefault"/>

        <module name="RedundantThrows"/>

        <module name="SimplifyBooleanExpression"/>

        <module name="SimplifyBooleanReturn"/>

                <!-- gvSIG: Check for some common programming errors -->

                <module name="CovariantEquals" />

                <module name="StringLiteralEquality" />

        <!-- 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"/>

        <!-- gvSIG: removed -->

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

        <module name="TodoComment"/>

        <module name="UpperEll"/>

            <!-- gvSIG rule 2: Sun style with 4 spaces -->

            <module name="Indentation">

                    <property name="basicOffset" value="4"/>

                    <property name="caseIndent" value="0"/>

                </module>

        <!-- gvSIG rule 10: Do not use System.out/err to log -->

                <module name="Regexp">

                    <!-- . matches any character, so we need to escape it and use \. 

                    to match dots.-->

                    <property name="format" value="System\.[out|err]\.println"/>

                    <property name="illegalPattern" value="true"/>

                </module>

                <!-- gvSIG rule 11: Try to avoid catching Throwable or 

                Exception and catch specific exceptions instead. -->

                <module name="IllegalCatch"/>

                <!-- gvSIG rule 13: Use interfaces in the declaration of 

                methods and variables.

        By default only avoids usage of Classes:

                        "java.util.GregorianCalendar, java.util.Hashtable, 

                          java.util.HashSet, java.util.HashMap, java.util.ArrayList, 

                          java.util.LinkedList, java.util.LinkedHashMap, 

                          java.util.LinkedHashSet, java.util.TreeSet, 

                          java.util.TreeMap, java.util.Vector" -->

                <module name="IllegalType">

                    <property name="ignoredMethodNames" value="getInstance"/>

                </module>

    </module>

        <!--  gvSIG rule 1: check for the gvSIG header -->

    <!-- Uneeded, use the maven-license-plugin instead

        <module name="RegexpHeader"> -->

                <!-- 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="${checkstyle.header.file}" />

        </module>

    -->

</module>