blob: 7268604deeaf455926544ff31c7ef51b1c585dac [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.
"-//Puppy Crawl//DTD Check Configuration 1.1//EN"
Checkstyle checks configured for Maven.
<module name="Checker">
<!-- Checks that a package.html file exists for each package. -->
<!-- See -->
<module name="JavadocPackage">
<!-- setting allowLegacy means it will check for package.html instead of just -->
<property name="allowLegacy" value="true"/>
<!-- Checks whether files end with a new line. -->
<!-- See -->
<!-- module name="NewlineAtEndOfFile"/-->
<!-- Checks that property files contain the same keys. -->
<!-- See -->
<module name="Translation"/>
<module name="Header">
<property name="headerFile" value="${checkstyle.header.file}"/>
<module name="FileLength"/>
<module name="FileTabCharacter">
<property name="fileExtensions" value="java,xml"/>
<module name="RegexpSingleline">
<property name="format" value="\s+$"/>
<property name="message" value="Line has trailing spaces."/>
<module name="TreeWalker">
<property name="cacheFile" value="${checkstyle.cache.file}"/>
<!-- ************************************************************** -->
<!-- Checks that are different from the sun coding conventions ones -->
<!-- ************************************************************** -->
<property name="tabWidth" value="4"/>
<module name="LeftCurly">
<property name="option" value="eol"/>
<module name="RightCurly">
<property name="option" value="same"/>
<module name="LineLength">
<property name="max" value="132"/>
<module name="MethodLength">
<property name="max" value="175"/>
<!-- No Paren pad check
<module name="ParenPad"/>
<module name="ConstantName">
<property name="format" value="log|^[a-zA-Z][a-zA-Z0-9_]*$"/>
<!-- ************************************************************** -->
<!-- Default Sun coding conventions checks -->
<!-- ************************************************************** -->
<!-- Checks for Javadoc comments. -->
<!-- See -->
<module name="JavadocMethod">
<property name="scope" value="protected"/>
<property name="allowUndeclaredRTE" value="true"/>
<module name="JavadocType">
<property name="scope" value="protected"/>
<module name="JavadocVariable">
<property name="scope" value="protected"/>
<!-- Checks for Naming Conventions. -->
<!-- See -->
<module name="LocalFinalVariableName"/>
<module name="LocalVariableName"/>
<module name="MethodName"/>
<module name="PackageName"/>
<module name="ParameterName"/>
<module name="StaticVariableName"/>
<module name="TypeName"/>
<module name="MemberName"/>
<!-- Checks for imports -->
<!-- See -->
<module name="AvoidStarImport"/>
<module name="IllegalImport"/> <!-- defaults to sun.* packages -->
<module name="RedundantImport"/>
<module name="UnusedImports"/>
<!-- Checks for Size Violations. -->
<!-- See -->
<module name="ParameterNumber"/>
<!-- Checks for whitespace -->
<!-- See -->
<module name="EmptyForIteratorPad"/>
<module name="NoWhitespaceAfter"/>
<module name="NoWhitespaceBefore"/>
<!-- module name="OperatorWrap"/ -->
<module name="WhitespaceAfter">
<property name="tokens" value="COMMA, SEMI"/>
<module name="WhitespaceAround"/>
<!-- Modifier Checks -->
<!-- See -->
<module name="ModifierOrder"/>
<!-- module name="RedundantModifier"/ -->
<!-- Checks for blocks. You know, those {}'s -->
<!-- See -->
<module name="AvoidNestedBlocks"/>
<module name="EmptyBlock">
<property name="option" value="text"/>
<module name="NeedBraces"/>
<!-- Checks for common coding problems -->
<!-- See -->
<!-- module name="AvoidInlineConditionals"/ -->
<module name="DoubleCheckedLocking"/> <!-- MY FAVOURITE -->
<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 -->
<!-- module name="DesignForExtension"/ -->
<module name="FinalClass"/>
<module name="HideUtilityClassConstructor"/>
<module name="InterfaceIsType"/>
<module name="VisibilityModifier"/>
<!-- Miscellaneous other checks. -->
<!-- See -->
<module name="ArrayTypeStyle"/>
<!-- module name="FinalParameters"/ -->
<module name="TodoComment"/>
<module name="UpperEll"/>