lang/java/reef-common/src/main/resources/checkstyle.xml - reef - Git at Google

 <?xml version="1.0"?>
 <!DOCTYPE module PUBLIC
         "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
         "http://www.puppycrawl.com/dtds/configuration_1_2.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.
 -->
 <!--

   This configuration is based on the one for Hadoop that is based on the
   sun_checks.xml file that is bundled with Checkstyle and includes checks
   for:

     - 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">
     <!-- By default violations of all checks are errors -->
     <!-- Exceptions are configured for violations which are not cleaned up yet -->
     <!-- The goal is to have no exceptions -->
     <property name="severity" value="error"/>

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

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

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

     <module name="FileLength"/>
     <module name="FileTabCharacter"/>

     <!-- not a check -->
     <module name="SuppressWarningsFilter"/>

     <!-- Checks for Headers                                -->
     <!-- See http://checkstyle.sf.net/config_header.html   -->
     <module name="RegexpHeader">
         <property name="header" value="^/\*$"/>
         <property name="fileExtensions" value="java"/>
     </module>

     <module name="TreeWalker">
         <!-- not a check -->
         <module name="SuppressWarningsHolder"/>

         <!-- Checks for Javadoc comments.                     -->
         <!-- See http://checkstyle.sf.net/config_javadoc.html -->
         <module name="JavadocType">
             <property name="scope" value="public"/>
             <property name="allowMissingParamTags" value="true"/>
             <property name="severity" value="warning"/>
         </module>
         <module name="JavadocStyle"/>

         <!-- 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"/>
         <module name="PackageName"/>
         <module name="ParameterName"/>
         <module name="StaticVariableName"/>
         <module name="TypeName"/>


         <!-- Checks for imports                              -->
         <!-- See http://checkstyle.sf.net/config_import.html -->
         <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">
             <property name="ignorePattern" value="^import"/>
             <property name="max" value="120"/>
         </module>
         <module name="MethodLength"/>
         <module name="ParameterNumber">
             <property name="max" value="7"/>
             <property name="tokens" value="METHOD_DEF"/>
             <property name="severity" value="warning"/>
         </module>

         <!-- 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="ParenPad"/>
         <module name="TypecastParenPad"/>
         <module name="WhitespaceAfter">
             <property name="tokens" value="COMMA, SEMI"/>
         </module>


         <!-- 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">
             <property name="allowInSwitchCase" value="true"/>
         </module>
         <module name="EmptyBlock">
             <property name="option" value="text"/>
         </module>
         <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="EmptyStatement"/>
         <module name="EqualsHashCode"/>
         <module name="HiddenField">
             <property name="ignoreConstructorParameter" value="true"/>
             <property name="ignoreSetter" value="true"/>
             <property name="setterCanReturnItsClass" value="true"/>
         </module>
         <module name="IllegalInstantiation"/>
         <module name="InnerAssignment"/>
         <module name="MissingSwitchDefault"/>
         <module name="SimplifyBooleanExpression"/>
         <module name="SimplifyBooleanReturn"/>

         <!-- Detects places in Java code where the diamond operator can be used -->
         <!-- See REEF-838 -->
         <module name="DiamondOperatorForVariableDefinition" />

         <module name="FinalParameters"/>
         <module name="UnnecessaryParentheses"/>

         <!-- Checks for class design                         -->
         <!-- See http://checkstyle.sf.net/config_design.html -->
         <module name="FinalClass"/>
         <module name="HideUtilityClassConstructor"/>
         <module name="InterfaceIsType"/>
         <module name="VisibilityModifier">
             <property name="protectedAllowed" value="true"/>
         </module>


         <!-- Miscellaneous other checks.                   -->
         <!-- See http://checkstyle.sf.net/config_misc.html -->
         <module name="ArrayTypeStyle"/>
         <module name="Indentation">
             <property name="basicOffset" value="2"/>
             <property name="caseIndent" value="0"/>
         </module>
         <module name="TodoComment">
             <property name="severity" value="warning"/>
             <property name="format" value="TODO[^\[][^J][^I][^R][^A]"/>
         </module>
         <module name="TodoComment">
             <property name="severity" value="info"/>
             <property name="format" value="TODO\[JIRA"/>
         </module>
         <module name="TodoComment">
             <property name="severity" value="warning"/>
             <property name="format" value="XXX|FIX"/>
         </module>
         <module name="UpperEll"/>

         <!-- Exception-handling checks. -->
         <!-- See https://issues.apache.org/jira/browse/REEF-864 -->
         <module name="MutableException"/>
         <module name="ForbidReturnInFinallyBlockCheck"/>
         <module name="ForbidThrowAnonymousExceptionsCheck"/>
         <module name="UselessSingleCatchCheck"/>
         <module name="EmptyCatchBlock">
             <property name="commentFormat" value="This is expected"/>
             <property name="exceptionVariableName" value="expected|ignored"/>
         </module>

         <!-- IllegalThrows is suppressed for files with the word "Test" in the filename -->
         <module name="IllegalThrows">
             <property name="illegalClassNames" value="Throwable, Error, RuntimeException, NullPointerException"/>
         </module>

         <!-- IllegalCatch is suppressed for files with the word "Test" in the filename -->
         <module name="IllegalCatch">
             <property name="illegalClassNames" value="Throwable, RuntimeException, Error" />
         </module>

         <module name="IllegalInstantiation">
             <property name="classes" value="java.lang.Throwable, java.lang.Error"/>
         </module>

         <module name="AvoidHidingCauseExceptionCheck" />

         <!-- ConstructorWithoutParams is suppressed for files with the word "Test" in the filename -->
         <module name="ConstructorWithoutParamsCheck" >
           <property name="classNameFormat" value=".*Exception$" />
           <property name="ignoredClassNameFormat" value="UnsupportedOperationException|NotImplementedException|NoSuchElementException" />
         </module>

         <!-- Checks for System.exit() call -->
         <!-- See https://issues.apache.org/jira/browse/REEF-1139 -->
         <module name="Regexp">
             <property name="severity" value="warning"/>
             <property name="format" value="System\.exit\("/>
             <property name="illegalPattern" value="true"/>
             <property name="ignoreComments" value="true"/>
         </module>

     </module>

 </module>
	<?xml version="1.0"?>
	<!DOCTYPE module PUBLIC
	"-//Puppy Crawl//DTD Check Configuration 1.2//EN"
	"http://www.puppycrawl.com/dtds/configuration_1_2.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.
	-->
	<!--

	This configuration is based on the one for Hadoop that is based on the
	sun_checks.xml file that is bundled with Checkstyle and includes checks
	for:

	- 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">
	<!-- By default violations of all checks are errors -->
	<!-- Exceptions are configured for violations which are not cleaned up yet -->
	<!-- The goal is to have no exceptions -->
	<property name="severity" value="error"/>

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

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

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

	<module name="FileLength"/>
	<module name="FileTabCharacter"/>

	<!-- not a check -->
	<module name="SuppressWarningsFilter"/>

	<!-- Checks for Headers -->
	<!-- See http://checkstyle.sf.net/config_header.html -->
	<module name="RegexpHeader">
	<property name="header" value="^/\*$"/>
	<property name="fileExtensions" value="java"/>
	</module>

	<module name="TreeWalker">
	<!-- not a check -->
	<module name="SuppressWarningsHolder"/>

	<!-- Checks for Javadoc comments. -->
	<!-- See http://checkstyle.sf.net/config_javadoc.html -->
	<module name="JavadocType">
	<property name="scope" value="public"/>
	<property name="allowMissingParamTags" value="true"/>
	<property name="severity" value="warning"/>
	</module>
	<module name="JavadocStyle"/>

	<!-- 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"/>
	<module name="PackageName"/>
	<module name="ParameterName"/>
	<module name="StaticVariableName"/>
	<module name="TypeName"/>


	<!-- Checks for imports -->
	<!-- See http://checkstyle.sf.net/config_import.html -->
	<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">
	<property name="ignorePattern" value="^import"/>
	<property name="max" value="120"/>
	</module>
	<module name="MethodLength"/>
	<module name="ParameterNumber">
	<property name="max" value="7"/>
	<property name="tokens" value="METHOD_DEF"/>
	<property name="severity" value="warning"/>
	</module>

	<!-- 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="ParenPad"/>
	<module name="TypecastParenPad"/>
	<module name="WhitespaceAfter">
	<property name="tokens" value="COMMA, SEMI"/>
	</module>


	<!-- 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">
	<property name="allowInSwitchCase" value="true"/>
	</module>
	<module name="EmptyBlock">
	<property name="option" value="text"/>
	</module>
	<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="EmptyStatement"/>
	<module name="EqualsHashCode"/>
	<module name="HiddenField">
	<property name="ignoreConstructorParameter" value="true"/>
	<property name="ignoreSetter" value="true"/>
	<property name="setterCanReturnItsClass" value="true"/>
	</module>
	<module name="IllegalInstantiation"/>
	<module name="InnerAssignment"/>
	<module name="MissingSwitchDefault"/>
	<module name="SimplifyBooleanExpression"/>
	<module name="SimplifyBooleanReturn"/>

	<!-- Detects places in Java code where the diamond operator can be used -->
	<!-- See REEF-838 -->
	<module name="DiamondOperatorForVariableDefinition" />

	<module name="FinalParameters"/>
	<module name="UnnecessaryParentheses"/>

	<!-- Checks for class design -->
	<!-- See http://checkstyle.sf.net/config_design.html -->
	<module name="FinalClass"/>
	<module name="HideUtilityClassConstructor"/>
	<module name="InterfaceIsType"/>
	<module name="VisibilityModifier">
	<property name="protectedAllowed" value="true"/>
	</module>


	<!-- Miscellaneous other checks. -->
	<!-- See http://checkstyle.sf.net/config_misc.html -->
	<module name="ArrayTypeStyle"/>
	<module name="Indentation">
	<property name="basicOffset" value="2"/>
	<property name="caseIndent" value="0"/>
	</module>
	<module name="TodoComment">
	<property name="severity" value="warning"/>
	<property name="format" value="TODO[^\[][^J][^I][^R][^A]"/>
	</module>
	<module name="TodoComment">
	<property name="severity" value="info"/>
	<property name="format" value="TODO\[JIRA"/>
	</module>
	<module name="TodoComment">
	<property name="severity" value="warning"/>
	<property name="format" value="XXX\|FIX"/>
	</module>
	<module name="UpperEll"/>

	<!-- Exception-handling checks. -->
	<!-- See https://issues.apache.org/jira/browse/REEF-864 -->
	<module name="MutableException"/>
	<module name="ForbidReturnInFinallyBlockCheck"/>
	<module name="ForbidThrowAnonymousExceptionsCheck"/>
	<module name="UselessSingleCatchCheck"/>
	<module name="EmptyCatchBlock">
	<property name="commentFormat" value="This is expected"/>
	<property name="exceptionVariableName" value="expected\|ignored"/>
	</module>

	<!-- IllegalThrows is suppressed for files with the word "Test" in the filename -->
	<module name="IllegalThrows">
	<property name="illegalClassNames" value="Throwable, Error, RuntimeException, NullPointerException"/>
	</module>

	<!-- IllegalCatch is suppressed for files with the word "Test" in the filename -->
	<module name="IllegalCatch">
	<property name="illegalClassNames" value="Throwable, RuntimeException, Error" />
	</module>

	<module name="IllegalInstantiation">
	<property name="classes" value="java.lang.Throwable, java.lang.Error"/>
	</module>

	<module name="AvoidHidingCauseExceptionCheck" />

	<!-- ConstructorWithoutParams is suppressed for files with the word "Test" in the filename -->
	<module name="ConstructorWithoutParamsCheck" >
	<property name="classNameFormat" value=".*Exception$" />
	<property name="ignoredClassNameFormat" value="UnsupportedOperationException\|NotImplementedException\|NoSuchElementException" />
	</module>

	<!-- Checks for System.exit() call -->
	<!-- See https://issues.apache.org/jira/browse/REEF-1139 -->
	<module name="Regexp">
	<property name="severity" value="warning"/>
	<property name="format" value="System\.exit\("/>
	<property name="illegalPattern" value="true"/>
	<property name="ignoreComments" value="true"/>
	</module>

	</module>

	</module>