| <?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 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"> |
| <!-- |
| 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 each Java package has a Javadoc file used for commenting. --> |
| <!-- See http://checkstyle.sf.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 that property files contain the same keys. --> |
| <!-- See http://checkstyle.sf.net/config_misc.html#Translation --> |
| <module name="Translation"/> |
| |
| <module name="FileLength"/> |
| |
| <!-- Following interprets the header file as regular expressions. --> |
| <!-- <module name="RegexpHeader"/> --> |
| |
| <module name="FileTabCharacter"> |
| <property name="eachLine" value="true"/> |
| </module> |
| |
| <!-- |
| <module name="RegexpSingleline"> |
| <!- \s matches whitespace character, $ matches end of line. -> |
| <property name="format" value="\s+$"/> |
| <property name="message" value="Line has trailing spaces."/> |
| </module> |
| --> |
| |
| <module name="TreeWalker"> |
| |
| <property name="cacheFile" value="${checkstyle.cache.file}"/> |
| |
| <!-- Checks for Javadoc comments. --> |
| <!-- See http://checkstyle.sf.net/config_javadoc.html --> |
| <!-- <module name="JavadocMethod"> --> |
| <!-- No Javadoc required for private methods --> |
| <!-- <property name="scope" value="protected"/> --> |
| <!-- </module> --> |
| <!-- <module name="JavadocType"> --> |
| <!-- <property name="scope" value="public"/> --> |
| <!-- </module> --> |
| <!-- <module name="JavadocVariable"> --> |
| <!-- No Javadoc required for private fields --> |
| <!-- <property name="scope" value="protected"/> --> |
| <!-- </module> --> |
| <!-- <module name="JavadocStyle"> --> |
| <!-- <property name="checkFirstSentence" value="false"/> --> |
| <!-- </module> --> |
| |
| |
| <!-- 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"/> |
| <module name="TypeName"/> |
| |
| |
| <!-- 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> --> |
| |
| |
| <!-- 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"/> |
| |
| |
| <!-- Checks for Size Violations. --> |
| <!-- See http://checkstyle.sf.net/config_sizes.html --> |
| <!-- module name="LineLength"/ --> |
| <!--module name="MethodLength"/ --> |
| <module name="ParameterNumber"/> |
| |
| |
| <!-- Checks for whitespace --> |
| <!-- See http://checkstyle.sf.net/config_whitespace.html --> |
| <module name="EmptyForIteratorPad"> |
| <property name="option" value="space"/> |
| </module> |
| <module name="MethodParamPad"/> |
| <module name="NoWhitespaceAfter"> |
| <property name="tokens" value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS"/> |
| </module> |
| <module name="NoWhitespaceBefore"/> |
| <module name="OperatorWrap"/> |
| <module name="ParenPad"> |
| <property name="tokens" value="ANNOTATION_FIELD_DEF, CTOR_DEF, CTOR_CALL, EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL, METHOD_DEF, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, QUESTION"/> |
| <property name="option" value="space"/> |
| </module> |
| <module name="TypecastParenPad"> |
| <property name="option" value="space"/> |
| </module> |
| <module name="WhitespaceAfter"> |
| <property name="tokens" value="COMMA, TYPECAST"/> |
| </module> |
| <module name="WhitespaceAround"/> |
| <module name="EmptyLineSeparator"> |
| <property name="tokens" value="IMPORT, CLASS_DEF, ENUM_DEF, INTERFACE_DEF, CTOR_DEF, METHOD_DEF, STATIC_INIT, INSTANCE_INIT"/> |
| </module> |
| |
| |
| <!-- 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"/> |
| <module name="LeftCurly"> |
| <property name="option" value="nl"/> |
| </module> |
| <module name="NeedBraces"/> |
| <module name="RightCurly"> |
| <property name="option" value="alone"/> |
| </module> |
| |
| |
| <!-- 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="setterCanReturnItsClass" value="true"/> |
| </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="packageAllowed" value="true"/> |
| <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> |