| <?xml version="1.0" encoding="UTF-8"?> |
| <!-- |
| 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. |
| --> |
| <!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.2//EN" |
| "http://www.puppycrawl.com/dtds/configuration_1_2.dtd"> |
| <!-- |
| |
| Checkstyle configuration that checks the sun coding conventions from: |
| |
| - the Java Language Specification at |
| http://java.sun.com/docs/books/jls/second_edition/html/index.html |
| |
| - the Sun Code Conventions at http://java.sun.com/docs/codeconv/ |
| |
| - the Javadoc guidelines at |
| http://java.sun.com/j2se/javadoc/writingdoccomments/index.html |
| |
| - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html |
| |
| - some best practices |
| |
| Checkstyle is very configurable. Be sure to read the documentation at |
| http://checkstyle.sf.net (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"> |
| |
| <!-- <property name="cacheFile" value="checkstyle.cache"/>--> |
| |
| <!-- |
| If you set the basedir property below, then all reported file |
| names will be relative to the specified directory. See |
| http://checkstyle.sourceforge.net/5.x/config.html#Checker |
| |
| <property name="basedir" value="${basedir}"/> |
| --> |
| |
| <!-- Checks that a package-info.java file exists for each package. --> |
| <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage --> |
| <!--<module name="JavadocPackage"/>--> |
| |
| <!-- Checks whether files end with a new line. --> |
| <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile --> |
| <module name="NewlineAtEndOfFile"/> |
| |
| <!-- Checks that property files contain the same keys. --> |
| <!-- See http://checkstyle.sf.net/config_misc.html#Translation --> |
| <module name="Translation"/> |
| |
| <!-- Checks for Size Violations. --> |
| <!-- See http://checkstyle.sf.net/config_sizes.html --> |
| <module name="FileLength"/> |
| |
| <!-- Checks for whitespace --> |
| <!-- See http://checkstyle.sf.net/config_whitespace.html --> |
| <module name="FileTabCharacter"/> |
| |
| <!-- Checks for Size Violations. --> |
| <!-- See http://checkstyle.sf.net/config_sizes.html --> |
| <module name="LineLength"> |
| <property name="max" value="120"/> |
| <property name="ignorePattern" value="^import"/> |
| <property name="fileExtensions" value="java,xml"/> |
| </module> |
| |
| <module name="SuppressWithPlainTextCommentFilter"/> |
| |
| <!-- Miscellaneous other checks. --> |
| <!-- See http://checkstyle.sf.net/config_misc.html --> |
| <module name="RegexpSingleline"> |
| <property name="format" value="\s+$"/> |
| <property name="minimum" value="0"/> |
| <property name="maximum" value="2"/> |
| <property name="message" value="Line has trailing spaces."/> |
| </module> |
| |
| <module name="TreeWalker"> |
| |
| <!-- Checks for Javadoc comments. --> |
| <!-- See http://checkstyle.sf.net/config_javadoc.html --> |
| <!--<module name="JavadocMethod"> |
| <property name="scope" value="public"/> |
| <property name="allowMissingPropertyJavadoc" value="true"/> |
| </module> |
| <module name="JavadocType"/> |
| <module name="JavadocVariable"> |
| <property name="scope" value="public"/> |
| <property name="ignoreNamePattern" value="LOG"/> |
| </module> |
| <module name="JavadocStyle"/>--> |
| |
| |
| <!-- Checks for Naming Conventions. --> |
| <!-- See http://checkstyle.sf.net/config_naming.html --> |
| <module name="ConstantName"/> |
| <module name="LocalFinalVariableName"/> |
| <module name="LocalVariableName"/> |
| <module name="MemberName"/> |
| <module name="MethodName"/> |
| <module name="PackageName"/> |
| <module name="ParameterName"/> |
| <module name="StaticVariableName"> |
| <property name="format" value="^[A-Z][A-Z0-9_]*$"/> |
| </module> |
| <module name="TypeName"/> |
| <module name="SuppressionCommentFilter"/> |
| |
| <!-- Checks for Headers --> |
| <!-- See http://checkstyle.sf.net/config_header.html --> |
| <!-- <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, --> |
| <!-- http://checkstyle.sf.net/config.html#properties --> |
| <!-- <property --> |
| <!-- name="headerFile" --> |
| <!-- value="${basedir}/java.header"/> --> |
| <!-- </module> --> |
| |
| <!-- Following interprets the header file as regular expressions. --> |
| <!-- <module name="RegexpHeader"/> --> |
| |
| |
| <!-- Checks for imports --> |
| <!-- See http://checkstyle.sf.net/config_import.html --> |
| <module name="AvoidStarImport"/> |
| <module name="IllegalImport"/> <!-- defaults to sun.* packages --> |
| <module name="RedundantImport"/> |
| <module name="UnusedImports"/> |
| <module name="ImportOrder"> |
| <property name="separated" value="false"/> |
| <property name="separatedStaticGroups" value="true"/> |
| <property name="option" value="top"/> |
| <property name="sortStaticImportsAlphabetically" value="true"/> |
| </module> |
| |
| <!-- Checks for Size Violations. --> |
| <!-- See http://checkstyle.sf.net/config_sizes.html --> |
| <!--<module name="MethodLength"/>--> |
| <!--<module name="ParameterNumber"/>--> |
| |
| |
| <!-- Checks for whitespace --> |
| <!-- See http://checkstyle.sf.net/config_whitespace.html --> |
| <module name="EmptyForIteratorPad"/> |
| <module name="GenericWhitespace"/> |
| <module name="MethodParamPad"/> |
| <!--<module name="NoWhitespaceAfter"/> |
| <module name="NoWhitespaceBefore"/>--> |
| <module name="OperatorWrap"/> |
| <module name="ParenPad"/> |
| <module name="TypecastParenPad"/> |
| <module name="WhitespaceAfter"/> |
| <module name="WhitespaceAround"/> |
| |
| |
| <!-- Modifier Checks --> |
| <!-- See http://checkstyle.sf.net/config_modifiers.html --> |
| <module name="ModifierOrder"/> |
| <module name="RedundantModifier"/> |
| |
| |
| <!-- Checks for blocks. You know, those {}'s --> |
| <!-- See http://checkstyle.sf.net/config_blocks.html --> |
| <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 --> |
| <!-- See http://checkstyle.sf.net/config_coding.html --> |
| <!-- <module name="AvoidInlineConditionals"/>--> |
| <module name="EmptyStatement"/> |
| <module name="EqualsHashCode"/> |
| <module name="HiddenField"> |
| <property name="ignoreSetter" value="true"/> |
| <property name="ignoreConstructorParameter" value="true"/> |
| <property name="tokens" value="VARIABLE_DEF"/> |
| </module> |
| <module name="IllegalInstantiation"/> |
| <module name="InnerAssignment"/> |
| <!--<module name="MagicNumber"/>--> |
| <module name="MissingSwitchDefault"/> |
| <module name="SimplifyBooleanExpression"/> |
| <module name="SimplifyBooleanReturn"/> |
| |
| <!-- Checks for class design --> |
| <!-- See http://checkstyle.sf.net/config_design.html --> |
| <!--<module name="DesignForExtension"/>--> |
| <module name="FinalClass"/> |
| <module name="HideUtilityClassConstructor"/> |
| <!--<module name="InterfaceIsType"/>--> |
| <module name="VisibilityModifier"> |
| <property name="protectedAllowed" value="true"/> |
| </module> |
| |
| |
| <!-- Miscellaneous other checks. --> |
| <!-- See http://checkstyle.sf.net/config_misc.html --> |
| <module name="ArrayTypeStyle"/> |
| <module name="FinalParameters"/> |
| <module name="TodoComment"/> |
| <module name="UpperEll"/> |
| </module> |
| |
| </module> |