This repository has been archived by the owner. It is now read-only.
Fetching contributors…
Cannot retrieve contributors at this time
247 lines (206 sloc) 10.5 KB
<?xml version="1.0" encoding="UTF-8"?>
Copyright (c) 2010-2017 Oracle and/or its affiliates. All rights reserved.
The contents of this file are subject to the terms of either the GNU
General Public License Version 2 only ("GPL") or the Common Development
and Distribution License("CDDL") (collectively, the "License"). You
may not use this file except in compliance with the License. You can
obtain a copy of the License at
or LICENSE.txt. See the License for the specific
language governing permissions and limitations under the License.
When distributing the software, include this License Header Notice in each
file and include the License file at LICENSE.txt.
GPL Classpath Exception:
Oracle designates this particular file as subject to the "Classpath"
exception as provided by Oracle in the GPL Version 2 section of the License
file that accompanied this code.
If applicable, add the following below the License Header, with the fields
enclosed by brackets [] replaced by your own identifying information:
"Portions Copyright [year] [name of copyright owner]"
If you wish your version of this file to be governed by only the CDDL or
only the GPL Version 2, indicate your decision by adding "[Contributor]
elects to include this software in this distribution under the [CDDL or GPL
Version 2] license." If you don't indicate a single choice of license, a
recipient has the option to distribute your version of this file under
either the CDDL, the GPL Version 2 or to extend the choice of license to
its licensees as provided above. However, if you add GPL Version 2 code
and therefore, elected the GPL Version 2 license, then the option applies
only if the new code is made subject to such option by the copyright
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "">
This file is based on maven-checkstyle-plugin config/sun_checks.xml file.
Checkstyle configuration that checks the coding conventions based on:
- the Java Language Specification at
- the Sun Code Conventions at
- the Javadoc guidelines at
- the JDK Api documentation
- some custom relaxations of the rules above & 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">
If you set the basedir property below, then all reported file
names will be relative to the specified directory. See
<property name="basedir" value="${basedir}"/>
<property name="charset" value="UTF-8"/>
<!-- Checks that each Java package has a Javadoc file used for commenting. -->
<!-- See -->
<module name="JavadocPackage" />
<!-- 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"/>
<!-- Following interprets the header file as regular expressions. -->
<!-- <module name="RegexpHeader"/> -->
<!-- Present in checkstyle-verify.xml -->
<!--<module name="FileTabCharacter">
<property name="eachLine" value="true"/>
<!-- Present in checkstyle-verify.xml -->
<!--<module name="RegexpSingleline">
<property name="format" value="\S+\s+$"/>
<property name="message" value="Non-empty line has trailing spaces."/>
<module name="TreeWalker">
<property name="cacheFile" value="${checkstyle.cache.file}"/>
<property name="tabWidth" value="4"/>
<!-- 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"/>
<module name="JavadocStyle"/>
<!-- Checks for Naming Conventions. -->
<!-- See -->
<module name="ConstantName"/>
<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> -->
<!-- Checks for imports -->
<!-- See -->
<module name="IllegalImport"/> <!-- defaults to sun.* packages -->
<!-- Present in checkstyle-verify.xml -->
<!--<module name="AvoidStarImport"/>-->
<module name="RedundantImport"/>
<!-- Present in checkstyle-verify.xml -->
<!--<module name="UnusedImports"/>-->
<!-- Checks for Size Violations. -->
<!-- See -->
<!-- Present in checkstyle-verify.xml -->
<!--<module name="LineLength">
<property name="max" value="130"/>
<property name="ignorePattern" value="@version|@see|@todo|TODO"/>
<module name="MethodLength"/>
<module name="ParameterNumber"/>
<!-- Checks for whitespace -->
<!-- See -->
<module name="EmptyForIteratorPad"/>
<module name="OperatorWrap"/>
<!-- Present in checkstyle-verify.xml -->
<!--<module name="MethodParamPad"/>
<module name="NoWhitespaceAfter"/>
<module name="NoWhitespaceBefore"/>
<module name="ParenPad"/>
<module name="TypecastParenPad"/>
<module name="WhitespaceAfter"/>
<module name="WhitespaceAround">
<property name="allowEmptyConstructors" value="true"/>
<!-- Modifier Checks -->
<!-- See -->
<!--<module name="ModifierOrder"/>-->
<module name="RedundantModifier"/>
<!-- Checks for blocks. You know, those {}'s -->
<!-- See -->
<module name="AvoidNestedBlocks"/>
<!-- Present in checkstyle-verify.xml -->
<!--<module name="EmptyBlock"/>
<module name="LeftCurly"/>
<module name="NeedBraces"/>
<module name="RightCurly"/>-->
<!-- Checks for common coding problems -->
<!-- See -->
<!-- module name="AvoidInlineConditionals"/-->
<module name="EmptyStatement"/>
<module name="EqualsHashCode"/>
<module name="HiddenField">
<property name="ignoreConstructorParameter" value="true"/>
<property name="ignoreSetter" value="true"/>
<module name="IllegalInstantiation"/>
<module name="InnerAssignment"/>
<module name="MagicNumber">
<property name="ignoreHashCodeMethod" value="true"/>
<module name="MissingSwitchDefault"/>
<!-- TODO: Ignoring module until this bug is resolved: -->
<!--<module name="RedundantThrows">
<property name="allowUnchecked" value="true"/>
<module name="RedundantModifier">
<property name="tokens" value="INTERFACE_DEF"/>
<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"/>
<module name="ThrowsCount">
<property name="max" value="3"/>
<!-- Miscellaneous other checks. -->
<!-- See -->
<module name="ArrayTypeStyle"/>
<module name="FinalParameters"/>
<module name="TodoComment"/>
<!-- Present in checkstyle-verify.xml -->
<!--<module name="UpperEll"/>-->