<?xml version="1.0"?> | |
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.1//EN" "http://www.puppycrawl.com/dtds/configuration_1_1.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. | |
--> | |
<module name="Checker"> | |
<!-- required licence file --> | |
<module name="Header"> | |
<property name="headerFile" value="${checkstyle.src.dir}/RequiredHeader.txt"/> | |
<property name="ignoreLines" value="2"/> | |
</module> | |
<module name="FileLength"/> | |
<module name="FileTabCharacterCheck"/> | |
<module name="TreeWalker"> | |
<!-- Javadoc requirements --> | |
<!-- TODO uncomment this when javadoc will be improved | |
<module name="JavadocType"> | |
<property name="scope" value="protected"/> | |
</module> | |
<module name="JavadocMethod"> | |
<property name="scope" value="protected"/> | |
<property name="allowUndeclaredRTE" value="true"/> | |
</module> | |
<module name="JavadocVariable"> | |
<property name="scope" value="public"/> | |
</module> | |
--> | |
<!-- element naming --> | |
<module name="PackageName"/> | |
<module name="TypeName"/> | |
<module name="ConstantName"/> | |
<module name="LocalFinalVariableName"/> | |
<module name="LocalVariableName"/> | |
<module name="MemberName"/> | |
<module name="MethodName"/> | |
<module name="ParameterName"/> | |
<module name="StaticVariableName"/> | |
<!-- Import conventions --> | |
<module name="AvoidStarImport"/> | |
<!-- <module name="IllegalImport"/> --> | |
<module name="RedundantImport"/> | |
<module name="UnusedImports"/> | |
<!-- size limits --> | |
<module name="LineLength"> | |
<property name="max" value="100"/> | |
<property name="ignorePattern" value="^ *\* *[^ ]+$"/> | |
<property name="tabWidth" value="4"/> | |
</module> | |
<module name="MethodLength"/> | |
<module name="ParameterNumber"/> | |
<!-- whitespace checks --> | |
<module name="EmptyForIteratorPad"/> | |
<module name="NoWhitespaceAfter"/> | |
<module name="NoWhitespaceBefore"/> | |
<module name="OperatorWrap"/> | |
<module name="ParenPad"/> | |
<module name="WhitespaceAfter"/> | |
<module name="WhitespaceAround"/> | |
<!-- Modifier Checks --> | |
<module name="ModifierOrder"/> | |
<!-- Checks for blocks --> | |
<module name="AvoidNestedBlocks"/> | |
<module name="EmptyBlock"> | |
<property name="option" value="text"/> | |
</module> | |
<module name="LeftCurly"/> | |
<module name="NeedBraces"/> | |
<module name="RightCurly"/> | |
<!-- Checks for common coding problems --> | |
<!--<module name="AvoidInlineConditionals"/> --> | |
<module name="DoubleCheckedLocking"/> | |
<module name="EmptyStatement"/> | |
<module name="EqualsHashCode"/> | |
<module name="IllegalInstantiation"> | |
<property name="classes" value="java.lang.Boolean"/> | |
</module> | |
<module name="InnerAssignment"/> | |
<module name="MagicNumber"/> | |
<module name="MissingSwitchDefault"/> | |
<module name="RedundantThrows"> | |
<property name="allowUnchecked" value="true"/> | |
</module> | |
<module name="SimplifyBooleanExpression"/> | |
<module name="SimplifyBooleanReturn"/> | |
<!-- Checks for class design --> | |
<!-- <module name="DesignForExtension"/> --> | |
<module name="FinalClass"/> | |
<module name="HideUtilityClassConstructor"/> | |
<module name="InterfaceIsType"/> | |
<module name="VisibilityModifier"/> | |
<!-- Miscellaneous other checks. --> | |
<module name="ArrayTypeStyle"/> | |
<!-- | |
<module name="GenericIllegalRegexp"> | |
<property name="format" value="\s+$"/> | |
<property name="message" value="Line has trailing spaces."/> | |
</module> | |
--> | |
<!-- | |
<module name="TodoComment"/> | |
--> | |
<module name="UpperEll"/> | |
<!-- allow comment suppression of checks --> | |
<module name="FileContentsHolder"/> | |
</module> | |
<!--TODO: comment this out, if Simian is not present --> | |
<!-- | |
<module name="au.com.redhillconsulting.simian.SimianCheck"/> | |
--> | |
<module name="SuppressionCommentFilter"> | |
<property name="offCommentFormat" value="CheckStyle\:([\w\|]+) *OFF"/> | |
<property name="onCommentFormat" value="CheckStyle\:([\w\|]+) *ON"/> | |
<property name="checkFormat" value="$1"/> | |
</module> | |
<module name="SuppressionFilter"> | |
<property name="file" value="${checkstyle.src.dir}/checkstyle-suppress.xml"/> | |
</module> | |
</module> |