Fetching contributors…
Cannot retrieve contributors at this time
217 lines (175 sloc) 8.08 KB
<?xml version="1.0"?>
* Copyright 2001-2004 The Apache Software Foundation.
* Licensed 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.2//EN"
Checkstyle configuration that checks the sun coding conventions from:
- the Java Language Specification at
- the Sun Code Conventions at
- the Javadoc guidelines at
- the JDK Api documentation
- some best practices
Checkstyle is very configurable. Be sure to read the documentation at (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 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="FileLength"/>
<module name="FileTabCharacter">
<property name="eachLine" value="true"/>
<module name="SuppressWarningsFilter" />
<module name="TreeWalker">
<module name="SuppressWarningsHolder" />
<!-- Checks for Naming Conventions. -->
<!-- See -->
<module name="ConstantName">
<property name="format" value="^([A-Z_][A-Z0-9]*(_[A-Z0-9]+)*|_log)$"/>
<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 Headers -->
<!-- See -->
<!-- <module name="Header"> -->
<!-- The follow property value demonstrates the ability -->
<!-- to have access to ANT properties. In this case it uses -->
<!-- the ${basedir} property to allow Checkstyle to be run -->
<!-- from any directory within a project. See property -->
<!-- expansion, -->
<!-- -->
<!-- <property -->
<!-- name="headerFile" -->
<!-- value="${basedir}/java.header"/> -->
<!-- </module> -->
<!-- Following interprets the header file as regular expressions. -->
<!-- <module name="RegexpHeader"/> -->
<!-- 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="LineLength">
<property name="max" value="110"/>
<module name="MethodLength"/>
<module name="ParameterNumber">
<property name="max" value="5"/>
<!-- Checks for whitespace -->
<!-- See -->
<module name="EmptyForIteratorPad"/>
<module name="MethodParamPad"/>
<module name="NoWhitespaceBefore"/>
<module name="OperatorWrap"/>
<module name="ParenPad"/>
<module name="TypecastParenPad"/>
<module name="WhitespaceAfter"/>
<!--module name="WhitespaceAround"/-->
<!-- Modifier Checks -->
<!-- See -->
<module name="ModifierOrder"/>
<module name="RedundantModifier"/>
<!-- Checks for blocks. You know, those {}'s -->
<!-- See -->
<module name="AvoidNestedBlocks">
<property name="allowInSwitchCase" value="true"/>
<module name="EmptyBlock"/>
<module name="LeftCurly"/>
<module name="NeedBraces">
<property name="tokens" value=" LITERAL_DO,LITERAL_FOR,LITERAL_WHILE"/>
<module name="RightCurly"/>
<!-- Checks for common coding problems -->
<!-- See -->
<!--module name="AvoidInlineConditionals"/-->
<module name="EmptyStatement"/>
<module name="EqualsHashCode"/>
<!--module name="HiddenField"/-->
<module name="IllegalInstantiation"/>
<module name="InnerAssignment"/>
<!--module name="MagicNumber"/-->
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>
<module name="StringLiteralEquality"/>
<module name="NestedIfDepth"/>
<module name="NestedTryDepth"/>
<module name="SuperClone"/>
<module name="IllegalCatch">
<property name="illegalClassNames" value=" java.lang.Throwable, java.lang.RuntimeException"/>
<!--module name="IllegalThrows"/-->
<module name="FallThrough"/>
<module name="UnnecessaryParentheses"/>
<!--module name="FinalLocalVariable"/-->
<!-- 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="Regexp">
<property name="format" value="System\.(out)|(err)\.print(ln)?\("/>
<property name="illegalPattern" value="true"/>
<module name="Regexp">
<property name="format" value="System\.exit"/>
<property name="illegalPattern" value="true"/>
<module name="Regexp">
<property name="format" value="\.printStacktrace"/>
<property name="illegalPattern" value="true"/>
<!--module name="FinalParameters"/-->
<!--module name="GenericIllegalRegexp">
<property name="format" value="\s+$"/>
<property name="message" value="Line has trailing spaces."/>
<!--module name="TodoComment"/-->
<module name="UpperEll"/>