Skip to content

Content of file checkstyle-checker.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--********************************************************************************************************************
 *
 * These Foolish Things - Miscellaneous utilities
 * Copyright (C) 2009-2013 by Tidalwave s.a.s. (http://tidalwave.it)
 *
 ***********************************************************************************************************************
 *
 * 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.
 *
 ***********************************************************************************************************************
 *
 * WWW: http://thesefoolishthings.java.net
 * SCM: https://bitbucket.org/tidalwave/thesefoolishthings-superpomconfig-src
 *
 ********************************************************************************************************************-->
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.1//EN"
                        "http://www.puppycrawl.com/dtds/configuration_1_1.dtd">
<module name="Checker">

    <module name="FileTabCharacter"/>
    <!-- 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 ref 3.3 (4) -->
    <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 ref 3.3 (2) -->
    <module name="FileLength">
        <property name="max" value="300"/>
    </module>
    
    <!-- Checks for whitespace                               -->
    <!-- See http://checkstyle.sf.net/config_whitespace.html -->
    <!--<module name="FileTabCharacter"/>-->

    <!-- 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>
        
<!--
    <module name="RegexpMultiline">
        <property name="format" value="System\.(out)|(err)\.print(ln)?\("/>
    </module>

    -->

    <module name="TreeWalker">
      
        <module name="FileContentsHolder"/>
                
        <!-- Checks for Javadoc comments. See http://checkstyle.sf.net/config_javadoc.html ref 3.3 (5) start --> 
        <module name="JavadocMethod">
            <property name="allowMissingPropertyJavadoc" value="true" /> 
            <property name="scope" value="public"/> <!-- TODO: exclude tests -->
        </module>
        <module name="JavadocType">
            <property name="scope" value="public"/>
        </module>
        <module name="JavadocVariable">
            <property name="scope" value="public"/>
        </module>
        <module name="JavadocStyle">
            <property name="checkFirstSentence" value="false"/>
        </module>
 
        <!-- Checks for Size Violations. See http://checkstyle.sf.net/config_sizes.html ref 3.3 (1) -->
        <module name="LineLength">
            <property name="max" value="120"/>
            <property name="ignorePattern" value="GEN-FIRST.*$"/> <!-- Ignore Netbeans autogenerated code -->
        </module>
        <module name="MethodLength">
            <property name="tokens" value="METHOD_DEF"/>
            <property name="max" value="60"/>
            <property name="countEmpty" value="false"/>
        </module>
        <module name="ParameterNumber">
            <property name="max" value="4"/>
            <property name="tokens" value="METHOD_DEF"/>
        </module> 
       
        <!-- Checks for whitespace. See http://checkstyle.sf.net/config_whitespace.html -->
        <module name="EmptyForIteratorPad"/>
        <module name="GenericWhitespace"/>
        <!-- module name="MethodParamPad"/ TODO: only for parameterless methods -->
        <module name="NoWhitespaceAfter"/>
        <module name="NoWhitespaceBefore"/>
        <module name="OperatorWrap"/>
        <module name="ParenPad"/>
        <module name="TypecastParenPad"/>
        <module name="WhitespaceAfter"/>
        <module name="WhitespaceAround"/>
 
        <!--check for imports-->
        <!--module name="AvoidStarImport"/ TOOD: allow for static imports -->
        <module name="IllegalImport"/>
        <module name="RedundantImport"/>
        <module name="UnusedImports"/>

        <!-- 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 -->
        <!-- ref 3.3 (7) start --> 
        <module name="AvoidNestedBlocks"/>
        <module name="EmptyBlock"/>
        <!-- module name="LeftCurly"/  TODO -->
        <module name="NeedBraces"/>
        <!-- module name="RightCurly"/ TODO -->
-->
<!-- ref 3.3 (7) end --> <!-- Checks for common coding problems --> <!-- See http://checkstyle.sf.net/config_coding.html --> <!-- <module name="AvoidInlineConditionals"/> <module name="DoubleCheckedLocking"/> <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"/>--> <!-- 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"/ --> <module name="FinalParameters"/> <!-- module name="TodoComment"/ --> <module name="UpperEll"/> </module> <!-- soppressioni standard di checkstyle--> <module name="SuppressionCommentFilter"/> <!-- Matisse auto generated code checkstyle suppression --> <module name="SuppressionCommentFilter"> <property name="offCommentFormat" value="&lt;editor-fold"/> <property name="onCommentFormat" value="&lt;/editor-fold"/> </module> <!-- Matisse auto generated code checkstyle suppression --> <module name="SuppressionCommentFilter"> <property name="offCommentFormat" value="// Variables declaration - do not modify"/> <property name="onCommentFormat" value="// End of variables declaration"/> </module> </module>