Application: gvSIG desktop » gvSIG data provider for GPE

<?xml version="1.0"?>

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

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

    <!-- Checks that property files contain the same keys.         -->

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

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

    <module name="TreeWalker">

            <property name="charset" value="UTF-8"/>

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

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

        <!-- gvSIG: All protected or public classes must have a Javadoc

             comment with the @author tag included -->

        <module name="JavadocType">

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

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

        </module>

        <!-- gvSIG: 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: Check correctly formatted Javadoc -->

        <module name="JavadocStyle">

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

        </module>

        <!--

        <module name="JavadocVariable"/>

                 -->

        <!-- Checks for Naming Conventions.                  -->

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

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

        <module name="PackageName">

                        <property name="format"

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

        </module>

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

        <module name="AbstractClassName"/>

        <!--

        <module name="ConstantName"/>

        <module name="LocalFinalVariableName"/>

        <module name="LocalVariableName"/>

        <module name="MemberName"/>

        <module name="MethodName"/>

        <module name="ParameterName"/>

        <module name="StaticVariableName"/>

        <module name="TypeName"/>

                 -->

        <!-- Checks for Headers                                -->

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

        <!-- gvSIG: Files must have the gvSIG header. -->

        <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}/build/java.header"/>                   -->

            <property name="headerFile" value="${checkstyle.header.file}"/>

            <property name="ignoreLines" value="2"/>

        </module>

        <!-- Following interprets the header file as regular expressions. -->

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

        <!-- Checks for imports                              -->

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

        <!-- gvSIG: Add warnings for redundant and unused imports -->

        <module name="RedundantImport">

                <property name="severity" value="warning"/>

        </module>

        <module name="UnusedImports">

                <property name="severity" value="warning"/>

        </module>

        <!--

        <module name="AvoidStarImport"/>

        <module name="IllegalImport"/> <!-#- defaults to sun.* packages -#->

                 -->

        <!-- Checks for Size Violations.                    -->

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

        <!--

        <module name="FileLength"/>

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

        <module name="NoWhitespaceAfter"/>

        <module name="NoWhitespaceBefore"/>

        <module name="OperatorWrap"/>

        <module name="ParenPad"/>

        <module name="TypecastParenPad"/>

        <module name="TabCharacter"/>

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

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

        <module name="DoubleCheckedLocking"/>

        <module name="CovariantEquals"/>

        <module name="EqualsHashCode"/>

        <module name="IllegalInstantiation">

                    <property name="classes" value="java.lang.Boolean"/>

                </module>

                <module name="StringLiteralEquality"/>

        <!--

        <module name="AvoidInlineConditionals"/>

        <module name="EmptyStatement"/>

        <module name="HiddenField"/>

        <module name="InnerAssignment"/>

        <module name="MagicNumber"/>

        <module name="MissingSwitchDefault"/>

        <module name="RedundantThrows"/>

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

                <!-- gvSIG: Get the author from the Javadoc -->

        <!--

                   <module name="WriteTag">

            <property name="tag" value="@author"/>

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

        </module>

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

        <module name="UpperEll"/>

                 -->

    </module>

</module>