| <?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="localeCountry" value="US"/> |
| <property name="localeLanguage" value="en"/> |
| |
| <module name="SuppressionFilter"> |
| <property name="file" value="checkstyle-suppressions.xml"/> |
| </module> |
| |
| <!-- Checks that a package.html file exists for each package. --> |
| <!-- See http://checkstyle.sourceforge.net/config_javadoc.html#JavadocPackage --> |
| <module name="JavadocPackage"> |
| <property name="allowLegacy" value="true"/> |
| </module> |
| |
| <!-- Checks whether files end with a new line. --> |
| <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile --> |
| <module name="NewlineAtEndOfFile"/> |
| |
| <!-- Checks for Size Violations. --> |
| <!-- See http://checkstyle.sf.net/config_sizes.html --> |
| <module name="FileLength"/> |
| |
| <module name="FileTabCharacter"/> |
| |
| <!-- Checks that property files contain the same keys. --> |
| <!-- See http://checkstyle.sf.net/config_misc.html#Translation --> |
| <module name="Translation"/> |
| |
| <!-- Checks if source file begin with the Apache.org header --> |
| <!-- http://checkstyle.sourceforge.net/config_header.html --> |
| <module name="Header"> |
| <property name="headerFile" value="header.txt"/> |
| <property name="fileExtensions" value="java"/> |
| </module> |
| |
| <module name="TreeWalker"> |
| |
| <!-- Checks for Javadoc comments. --> |
| <!-- See http://checkstyle.sf.net/config_javadoc.html --> |
| <module name="JavadocType"> |
| <property name="scope" value="protected"/> |
| <property name="allowMissingParamTags" value="true"/> |
| </module> |
| <module name="JavadocMethod"> |
| <property name="scope" value="protected"/> |
| <property name="allowUndeclaredRTE" value="true"/> |
| <property name="allowMissingParamTags" value="true"/> |
| </module> |
| <module name="JavadocVariable"> |
| <property name="scope" value="protected"/> |
| </module> |
| <module name="JavadocStyle"> |
| <property name="scope" value="protected"/> |
| <property name="checkHtml" value="false"/> |
| </module> |
| |
| <!-- Checks for Naming Conventions. --> |
| <!-- See http://checkstyle.sf.net/config_naming.html --> |
| <module name="ConstantName"/> |
| <module name="LocalFinalVariableName"/> |
| <module name="MemberName"/> |
| <module name="MethodName"/> |
| <module name="PackageName"/> |
| <module name="ParameterName"/> |
| <module name="StaticVariableName"/> |
| <module name="TypeName"/> |
| |
| <!-- Checks for imports --> |
| <!-- See http://checkstyle.sf.net/config_import.html --> |
| <module name="AvoidStarImport"/> |
| <module name="IllegalImport"/> |
| <module name="RedundantImport"/> |
| <module name="UnusedImports"/> |
| |
| <!-- <module name="LineLength"> |
| <property name="max" value="80"/> |
| <property name="ignorePattern" value="^ *\*"/> |
| </module> --> |
| <module name="MethodLength"> |
| <property name="tokens" value="METHOD_DEF"/> |
| <property name="max" value="200"/> |
| </module> |
| <module name="ParameterNumber"/> |
| |
| <!-- Checks for whitespace --> |
| <!-- See http://checkstyle.sf.net/config_whitespace.html --> |
| <module name="EmptyForIteratorPad"/> |
| <module name="MethodParamPad"/> |
| <!-- <module name="NoWhitespaceAfter"/> --> |
| <module name="NoWhitespaceBefore"/> |
| <module name="OperatorWrap"/> |
| <module name="ParenPad"/> |
| <module name="TypecastParenPad"/> |
| |
| <module name="WhitespaceAfter"/> |
| <module name="WhitespaceAround"/> |
| |
| <module name="GenericWhitespace"/> |
| |
| <!-- Checks for blocks. You know, those {}'s --> |
| <!-- See http://checkstyle.sf.net/config_blocks.html --> |
| <module name="AvoidNestedBlocks"/> |
| <!-- <module name="EmptyBlock"/> --> |
| <module name="LeftCurly"/> |
| <module name="NeedBraces"/> |
| <module name="RightCurly"/> |
| |
| <!-- Checks for misc --> |
| <!-- see http://checkstyle.sourceforge.net/config_misc.html --> |
| <!-- <module name="Indentation"/> --> |
| |
| <!-- Checks for annotations --> |
| <!-- http://checkstyle.sourceforge.net/config_annotation.html --> |
| <module name="AnnotationUseStyle"/> |
| <!--<module name="MissingDeprecated"/>--> |
| <module name="MissingOverride"/> |
| <module name="SuppressWarnings"/> |
| |
| <!-- Checks for correct class design --> |
| <!-- http://checkstyle.sourceforge.net/config_design.html --> |
| <!--<module name="VisibilityModifier"/>--> |
| <!--<module name="FinalClass"/>--> |
| <module name="InterfaceIsType"/> |
| <!--<module name="HideUtilityClassConstructor"/> --> |
| <!--<module name="MutableException"/>--> |
| <module name="ThrowsCount"> |
| <property name="max" value="2"/> |
| </module> |
| |
| </module> |
| |
| </module> |