blob: ecf39462fbe18dc61ffcac95cea80f4f5817c559 [file] [log] [blame]
<?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
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.
This version of checkstyle is based on the Apache Calcite checkstyle
checkstyle configuration, which in turn is based on Giraph and Hadoop and
common-math configurations.
The documentation for checkstyle is available at
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.1//EN" "">
<!-- Calcite customization of default Checkstyle behavior -->
<module name="Checker">
<property name="localeLanguage" value="en"/>
<!-- Checks for headers -->
<!-- See -->
<!-- Verify that EVERY source file has the appropriate license -->
<module name="Header">
<property name="headerFile" value="${checkstyle.header.file}"/>
<!-- Checks for Javadoc comments (checker). -->
<!-- See -->
<!-- Require package javadoc -->
<module name="JavadocPackage"/>
<!-- Miscellaneous other checks (checker). -->
<!-- See -->
<!-- Require files to end with newline characters -->
<module name="NewlineAtEndOfFile">
<property name="lineSeparator" value="lf"/>
<!-- Checks for whitespace (tree walker) -->
<!-- See -->
<!-- No tabs allowed! -->
<module name="FileTabCharacter"/>
<module name="TreeWalker">
<property name="cacheFile" value="target/checkstyle-cachefile"/>
<!-- Checks for blocks. You know, those {}'s -->
<!-- See -->
<!-- No empty blocks (i.e. catch); must contain at least a comment -->
<module name="EmptyBlock">
<property name="option" value="text"/>
<module name="AvoidNestedBlocks">
<property name="allowInSwitchCase" value="true"/>
<module name="LeftCurly"/>
<!-- No if/else/do/for/while without braces -->
<module name="NeedBraces"/>
<module name="RightCurly"/>
<!-- Checks for class design -->
<!-- See -->
<!-- Utility class should not be instantiated, they must have a
private constructor -->
<module name="HideUtilityClassConstructor"/>
<!-- Checks for common coding problems -->
<!-- See -->
<module name="EmptyStatement"/>
<!-- Require hash code override when equals is -->
<module name="EqualsHashCode"/>
<!-- Disallow unnecessary instantiation of Boolean, String -->
<module name="IllegalInstantiation">
<property name="classes" value="java.lang.Boolean, java.lang.String"/>
<!-- Switch statements should be complete and with independent cases -->
<module name="FallThrough"/>
<!-- For hadoop_yarn profile, some YARN exceptions aren't loading in checkstyle -->
<module name="RedundantThrows">
<property name="suppressLoadErrors" value="true" />
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>
<!-- Only one statement per line allowed -->
<module name="OneStatementPerLine"/>
<!-- Don't add up parentheses when they are not required -->
<module name="UnnecessaryParentheses" />
<!-- Don't use = or != for string comparisons -->
<module name="StringLiteralEquality" />
<!-- Don't declare multiple variables in the same statement -->
<module name="MultipleVariableDeclarations" />
<!-- String literals more than one character long should not be
repeated several times -->
<!-- the "unchecked" string is also accepted to allow
@SuppressWarnings("unchecked") -->
<!-- Disabling for now until we have a better ignoreStringsRegexp -->
<module name="MultipleStringLiterals" >
<property name="ignoreStringsRegexp" value='^(("")|(".")|("unchecked"))$'/>
<!-- Checks for imports -->
<!-- See -->
<module name="RedundantImport"/>
<!-- Import should be explicit, and only from pure java packages.
But we allow imports that are only used in javadoc. -->
<module name="UnusedImports">
<property name="processJavadoc" value="true"/>
<module name="IllegalImport" />
<module name="AvoidStarImport" />
<module name="ImportOrder">
<property name="groups" value="java,javax,lib,shared,common,platform,org,com,io,net,scala,clover"/>
<property name="ordered" value="true"/>
<property name="separated" value="true"/>
<property name="option" value="bottom"/>
<!-- Checks for Javadoc comments (tree walker). -->
<!-- See -->
<!-- Javadoc must be formatted correctly -->
<module name="JavadocStyle">
<property name="checkFirstSentence" value="false"/>
<!-- Must have class / interface header comments -->
<module name="JavadocType"/>
<!-- Miscellaneous other checks (tree walker). -->
<!-- See -->
<!-- Java style arrays -->
<module name="ArrayTypeStyle"/>
<!-- Indentation -->
<module name="Indentation">
<property name="caseIndent" value="0"/>
<property name="basicOffset" value="4"/>
<property name="braceAdjustment" value="0"/>
<!-- Turn this on to see what needs to be done
<module name="TodoComment"/>
<module name="UpperEll"/>
<module name="OperatorWrap"/>
<!-- Modifier Checks -->
<!-- See -->
<!-- Use a consistent way to put modifiers -->
<module name="ModifierOrder"/>
<module name="RedundantModifier"/>
<!-- Checks for Naming Conventions. -->
<!-- See -->
<!-- Constant names should obey the traditional all uppercase
naming convention -->
<module name="ConstantName"/>
<module name="LocalFinalVariableName">
<!-- Allow '_' except first. -->
<property name="format" value="^[a-z][a-zA-Z0-9_]*$"/>
<module name="LocalVariableName">
<!-- Allow '_' except first. -->
<property name="format" value="^[a-z][a-zA-Z0-9_]*$"/>
<module name="MemberName"/>
<module name="MethodName">
<!-- Allow trailing '_', signifying private methods.
Also allow '_' prefix, indicating disabled method or junit test. -->
<property name="format" value="^_?[a-z][a-zA-Z0-9]*_?$"/>
<module name="PackageName"/>
<module name="ParameterName">
<!-- Allow trailing '_'. -->
<property name="format" value="^[a-z][a-zA-Z0-9]*_?$"/>
<module name="StaticVariableName"/>
<module name="TypeName"/>
<!-- Checks for regexp expressions. -->
<!-- See -->
<!-- No trailing whitespace -->
<module name="Regexp">
<property name="format" value="[ \t]+$"/>
<property name="illegalPattern" value="true"/>
<property name="message" value="Trailing whitespace"/>
<!-- Authors should be in pom.xml file -->
<module name="Regexp">
<property name="format" value="@author"/>
<property name="illegalPattern" value="true"/>
<property name="message" value="developers names should be in pom file"/>
<!-- No multi-line C-style comments except at start of line. -->
<module name="Regexp">
<property name="format" value="^ +/\*[^*][^/]$"/>
<property name="illegalPattern" value="true"/>
<property name="message" value="C-style comment"/>
<module name="Regexp">
<property name="format" value="^ +/\*$"/>
<property name="illegalPattern" value="true"/>
<property name="message" value="C-style comment"/>
<!-- Checks for Size Violations. -->
<!-- See -->
<!-- Lines cannot exceed 100 chars, except if they are hyperlinks
or strings (possibly preceded by '+' and followed by say '),'. -->
<module name="LineLength">
<property name="max" value="100"/>
<property name="ignorePattern" value="^import|@see|@link|@BaseMessage|href|^[ +]*&quot;.*&quot;[);,]*$"/>
<!-- Over time, we will revise this down -->
<module name="MethodLength">
<property name="max" value="390"/>
<!-- Checks for whitespace (tree walker) -->
<!-- See -->
<module name="EmptyForIteratorPad"/>
<!-- Spacing around methods -->
<module name="MethodParamPad">
<property name="option" value="nospace"/>
<property name="allowLineBreaks" value="true"/>
<!-- No whitespace before a token -->
<module name="NoWhitespaceBefore"/>
<!-- Whitespace after tokens is required -->
<module name="WhitespaceAfter"/>
<!-- Whitespace around tokens is required -->
<module name="WhitespaceAround">
<property name="allowEmptyConstructors" value="true"/>
<property name="allowEmptyMethods" value="true"/>
<module name="ParenPad"/>
<module name="TypecastParenPad"/>
<!-- No extra whitespace around types -->
<module name="GenericWhitespace"/>
<!-- Required for SuppressionCommentFilter below -->
<module name="FileContentsHolder"/>
<!-- Setup special comments to suppress specific checks from source files -->
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="CHECKSTYLE\: stop ([\w\|]+)"/>
<property name="onCommentFormat" value="CHECKSTYLE\: resume ([\w\|]+)"/>
<property name="checkFormat" value="$1"/>
<!-- Turn off all checks between OFF and ON -->
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="CHECKSTYLE\: OFF"/>
<property name="onCommentFormat" value="CHECKSTYLE\: ON"/>
<!-- Turn off checks for the next N lines. -->
<module name="SuppressWithNearbyCommentFilter">
<property name="commentFormat" value="CHECKSTYLE: +IGNORE (\d+)"/>
<property name="influenceFormat" value="$1"/>