build-tools/src/main/resources/checkstyle.xml - incubator-atlas - Git at Google

 <?xml version="1.0"?>
 <!--
   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.
   -->

 <!DOCTYPE module PUBLIC
         "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
         "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">

 <!--

   Checkstyle configuration for Metadata 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">

     <!-- 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 for Headers                                -->
     <!-- See http://checkstyle.sf.net/config_header.html   -->
     <module name="Header">
         <property name="headerFile" value="${checkstyle.header.file}"/>
         <property name="fileExtensions" value="java"/>
     </module>

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

     <module name="TreeWalker">
         <!-- 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"/>
         </module>
         <module name="JavadocStyle"/>

         <module name="SuperClone"/>
         <module name="SuperFinalize"/>

         <!-- Checks for Naming Conventions.                  -->
         <!-- See http://checkstyle.sf.net/config_naming.html -->
         <module name="ConstantName"/>
         <module name="ClassTypeParameterName">
             <property name="format" value="^[A-Z]+$"/>
         </module>
         <module name="LocalFinalVariableName">
             <!--<property name="format" value="^[A-Z][_A-Z0-9]*$"/>-->
         </module>
         <module name="LocalVariableName"/>
         <module name="MemberName"/>
         <module name="MethodName"/>
         <module name="MethodTypeParameterName">
             <property name="format" value="^[A-Z]+$"/>
         </module>
         <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="max" value="120"/>
         </module>
         <module name="MethodLength"/>
         <module name="ParameterNumber">
             <property name="tokens" value="METHOD_DEF"/>
         </module>
         <module name="OuterTypeNumber"/>

         <!-- Checks for whitespace                               -->
         <!-- See http://checkstyle.sf.net/config_whitespace.html -->
         <module name="GenericWhitespace"/>
         <module name="EmptyForIteratorPad"/>
         <module name="MethodParamPad"/>
         <module name="WhitespaceAround">
             <property name="tokens" value="LITERAL_IF"/>
         </module>
         <module name="NoWhitespaceAfter">
             <property name="tokens"
                       value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS"/>
         </module>
         <module name="NoWhitespaceBefore"/>
         <module name="OperatorWrap"/>
         <module name="ParenPad"/>
         <module name="TypecastParenPad"/>
         <module name="WhitespaceAfter">
             <property name="tokens" value="COMMA, SEMI"/>
         </module>

         <module name="Regexp">
             <property name="format" value="[ \t]+$"/>
             <property name="illegalPattern" value="true"/>
             <property name="message" value="Trailing whitespace"/>
         </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"/>
         <module name="EmptyBlock">
             <!-- catch blocks need a statement or a comment. -->
             <property name="option" value="text"/>
             <property name="tokens" value="LITERAL_CATCH"/>
         </module>
         <module name="EmptyBlock">
             <!-- all other blocks need a real statement. -->
             <property name="option" value="stmt"/>
             <property name="tokens" value="LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY,
           LITERAL_IF, LITERAL_FOR, LITERAL_TRY, LITERAL_WHILE, INSTANCE_INIT,
           STATIC_INIT"/>
         </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"/-->
         <!-- DoubleCheckedLocking check is no longer required. See http://checkstyle.sourceforge.net/releasenotes.html -->
         <!-- module name="DoubleCheckedLocking"/-->
         <module name="EmptyStatement"/>
         <module name="EqualsHashCode"/>
         <module name="StringLiteralEquality"/>
         <module name="HiddenField">
             <property name="ignoreConstructorParameter" value="true"/>
             <property name="ignoreAbstractMethods" value="true"/>
             <property name="ignoreSetter" value="true"/>
         </module>
         <module name="IllegalInstantiation"/>
         <module name="InnerAssignment"/>
         <module name="MissingSwitchDefault"/>
         <module name="RedundantThrows"/>
         <module name="SimplifyBooleanExpression"/>
         <module name="SimplifyBooleanReturn"/>
         <module name="DefaultComesLast"/>

         <!-- 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>
         <module name="MissingOverride"/>


         <!-- Miscellaneous other checks.                   -->
         <!-- See http://checkstyle.sf.net/config_misc.html -->
         <module name="ArrayTypeStyle"/>
         <module name="ArrayTrailingComma"/>
         <!--
           This generates too many false-positives on wrapped 'throws' clauses
           to be really useful. Disabled for now.

           Metadata style is:
           * Spaces, not tabs.
           * Indent by four spaces.
           * Indent by four spaces when wrapping a line.
         -->
         <module name="Indentation">
             <property name="basicOffset" value="4"/>
             <property name="caseIndent" value="0"/>
         </module>
         <module name="TodoComment"/>
         <module name="UpperEll"/>

         <module name="FileContentsHolder"/>
     </module>

     <!-- allow warnings to be suppressed -->
     <module name="SuppressionCommentFilter">
         <property name="offCommentFormat" value="SUSPEND CHECKSTYLE CHECK ParameterNumberCheck|VisibilityModifierCheck|HiddenFieldCheck|MethodName"/>
         <property name="onCommentFormat" value="RESUME CHECKSTYLE CHECK ParameterNumberCheck|VisibilityModifierCheck|HiddenFieldCheck|MethodName"/>
         <property name="checkFormat" value="ParameterNumberCheck|VisibilityModifierCheck|HiddenFieldCheck|MethodName"/>
     </module>

     <module name="SuppressionFilter">
         <property name="file" value="${checkstyle.suppressions.file}"/>
     </module>
 </module>
	<?xml version="1.0"?>
	<!--
	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.
	-->

	<!DOCTYPE module PUBLIC
	"-//Puppy Crawl//DTD Check Configuration 1.2//EN"
	"http://www.puppycrawl.com/dtds/configuration_1_2.dtd">

	<!--

	Checkstyle configuration for Metadata 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">

	<!-- 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 for Headers -->
	<!-- See http://checkstyle.sf.net/config_header.html -->
	<module name="Header">
	<property name="headerFile" value="${checkstyle.header.file}"/>
	<property name="fileExtensions" value="java"/>
	</module>

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

	<module name="TreeWalker">
	<!-- 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"/>
	</module>
	<module name="JavadocStyle"/>

	<module name="SuperClone"/>
	<module name="SuperFinalize"/>

	<!-- Checks for Naming Conventions. -->
	<!-- See http://checkstyle.sf.net/config_naming.html -->
	<module name="ConstantName"/>
	<module name="ClassTypeParameterName">
	<property name="format" value="^[A-Z]+$"/>
	</module>
	<module name="LocalFinalVariableName">
	<!--<property name="format" value="^[A-Z][_A-Z0-9]*$"/>-->
	</module>
	<module name="LocalVariableName"/>
	<module name="MemberName"/>
	<module name="MethodName"/>
	<module name="MethodTypeParameterName">
	<property name="format" value="^[A-Z]+$"/>
	</module>
	<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="max" value="120"/>
	</module>
	<module name="MethodLength"/>
	<module name="ParameterNumber">
	<property name="tokens" value="METHOD_DEF"/>
	</module>
	<module name="OuterTypeNumber"/>

	<!-- Checks for whitespace -->
	<!-- See http://checkstyle.sf.net/config_whitespace.html -->
	<module name="GenericWhitespace"/>
	<module name="EmptyForIteratorPad"/>
	<module name="MethodParamPad"/>
	<module name="WhitespaceAround">
	<property name="tokens" value="LITERAL_IF"/>
	</module>
	<module name="NoWhitespaceAfter">
	<property name="tokens"
	value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS"/>
	</module>
	<module name="NoWhitespaceBefore"/>
	<module name="OperatorWrap"/>
	<module name="ParenPad"/>
	<module name="TypecastParenPad"/>
	<module name="WhitespaceAfter">
	<property name="tokens" value="COMMA, SEMI"/>
	</module>

	<module name="Regexp">
	<property name="format" value="[ \t]+$"/>
	<property name="illegalPattern" value="true"/>
	<property name="message" value="Trailing whitespace"/>
	</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"/>
	<module name="EmptyBlock">
	<!-- catch blocks need a statement or a comment. -->
	<property name="option" value="text"/>
	<property name="tokens" value="LITERAL_CATCH"/>
	</module>
	<module name="EmptyBlock">
	<!-- all other blocks need a real statement. -->
	<property name="option" value="stmt"/>
	<property name="tokens" value="LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY,
	LITERAL_IF, LITERAL_FOR, LITERAL_TRY, LITERAL_WHILE, INSTANCE_INIT,
	STATIC_INIT"/>
	</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"/-->
	<!-- DoubleCheckedLocking check is no longer required. See http://checkstyle.sourceforge.net/releasenotes.html -->
	<!-- module name="DoubleCheckedLocking"/-->
	<module name="EmptyStatement"/>
	<module name="EqualsHashCode"/>
	<module name="StringLiteralEquality"/>
	<module name="HiddenField">
	<property name="ignoreConstructorParameter" value="true"/>
	<property name="ignoreAbstractMethods" value="true"/>
	<property name="ignoreSetter" value="true"/>
	</module>
	<module name="IllegalInstantiation"/>
	<module name="InnerAssignment"/>
	<module name="MissingSwitchDefault"/>
	<module name="RedundantThrows"/>
	<module name="SimplifyBooleanExpression"/>
	<module name="SimplifyBooleanReturn"/>
	<module name="DefaultComesLast"/>

	<!-- 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>
	<module name="MissingOverride"/>


	<!-- Miscellaneous other checks. -->
	<!-- See http://checkstyle.sf.net/config_misc.html -->
	<module name="ArrayTypeStyle"/>
	<module name="ArrayTrailingComma"/>
	<!--
	This generates too many false-positives on wrapped 'throws' clauses
	to be really useful. Disabled for now.

	Metadata style is:
	* Spaces, not tabs.
	* Indent by four spaces.
	* Indent by four spaces when wrapping a line.
	-->
	<module name="Indentation">
	<property name="basicOffset" value="4"/>
	<property name="caseIndent" value="0"/>
	</module>
	<module name="TodoComment"/>
	<module name="UpperEll"/>

	<module name="FileContentsHolder"/>
	</module>

	<!-- allow warnings to be suppressed -->
	<module name="SuppressionCommentFilter">
	<property name="offCommentFormat" value="SUSPEND CHECKSTYLE CHECK ParameterNumberCheck\|VisibilityModifierCheck\|HiddenFieldCheck\|MethodName"/>
	<property name="onCommentFormat" value="RESUME CHECKSTYLE CHECK ParameterNumberCheck\|VisibilityModifierCheck\|HiddenFieldCheck\|MethodName"/>
	<property name="checkFormat" value="ParameterNumberCheck\|VisibilityModifierCheck\|HiddenFieldCheck\|MethodName"/>
	</module>

	<module name="SuppressionFilter">
	<property name="file" value="${checkstyle.suppressions.file}"/>
	</module>
	</module>