| <?xml version="1.0"?> |
| <!-- |
| 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 |
| "-//Checkstyle//DTD Checkstyle Configuration 1.2//EN" |
| "https://checkstyle.org/dtds/configuration_1_2.dtd"> |
| |
| <!-- |
| Checkstyle configuration that checks the Maven coding conventions from: |
| --> |
| |
| <module name="Checker"> |
| |
| <!-- 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"/ --> |
| |
| <module name="FileLength"/> |
| |
| <!-- Checks for Headers --> |
| <!-- See http://checkstyle.sf.net/config_header.html --> |
| <!-- <module name="RegexpHeader"> |
| <property name="fileExtensions" value="java"/> |
| <property name="headerFile" value="${checkstyle.header.file}"/> |
| </module> |
| --> |
| <module name="FileTabCharacter"> |
| <property name="eachLine" value="true"/> |
| </module> |
| |
| <!-- Line with trailing spaces (disabled as it's too noisy) --> |
| <!--<module name="RegexpSingleline"> |
| <property name="format" value="\s+$"/> |
| <property name="message" value="Line has trailing spaces."/> |
| </module>--> |
| |
| <module name="TreeWalker"> |
| |
| <property name="tabWidth" value="4"/> |
| |
| <!-- required for SuppressWarningsFilter (and other Suppress* rules not used here) --> |
| <!-- see http://checkstyle.sourceforge.net/config_annotation.html#SuppressWarningsHolder --> |
| <module name="SuppressWarningsHolder"/> |
| |
| <module name="LeftCurly"> |
| <property name="option" value="nl"/> |
| </module> |
| |
| <module name="RightCurly"> |
| <property name="option" value="alone"/> |
| </module> |
| |
| <module name="LineLength"> |
| <property name="max" value="120" /> |
| <property name="ignorePattern" value="@version|@see|@todo|TODO"/> |
| </module> |
| |
| <module name="MemberName" /> |
| |
| <!-- Checks for Javadoc comments. --> |
| <!-- See http://checkstyle.sf.net/config_javadoc.html --> |
| <module name="JavadocMethod"> |
| <property name="severity" value="warning"/> |
| <property name="scope" value="protected"/> |
| </module> |
| <module name="JavadocType"> |
| <property name="scope" value="protected"/> |
| <property name="allowUnknownTags" value="true" /> |
| </module> |
| <module name="JavadocVariable"> |
| <property name="severity" value="info"/> |
| <property name="scope" value="protected"/> |
| </module> |
| |
| |
| <!-- Checks for Naming Conventions. --> |
| <!-- See http://checkstyle.sf.net/config_naming.html --> |
| <module name="ConstantName"/> |
| <module name="LocalFinalVariableName"/> |
| <module name="LocalVariableName"/> |
| <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="UnusedImports"/> |
| |
| |
| <!-- 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"> |
| <property name="option" value="space"/> |
| </module> |
| <!-- module name="NoWhitespaceAfter"/ --> |
| <!-- module name="NoWhitespaceBefore"/ --> |
| <module name="OperatorWrap"/> |
| <module name="ParenPad"> |
| <property name="option" value="space" /> |
| </module> |
| <module name="WhitespaceAfter"/> |
| <module name="WhitespaceAround"/> |
| <!-- module name="MethodParamPad"/ --> |
| <module name="GenericWhitespace"/> |
| |
| |
| <!-- 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="NeedBraces"/> |
| |
| |
| <!-- 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="severity" value="warning"/> |
| <property name="ignoreSetter" value="true"/> |
| <property name="ignoreConstructorParameter" value="true"/> |
| </module> |
| <module name="IllegalInstantiation"/> |
| <module name="InnerAssignment"/> |
| <module name="MagicNumber"> |
| <!-- some numbers are really not that magic --> |
| <property name="ignoreNumbers" value="-4, -3, -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 31, 32, 37, 64, 100, 128, 256, 512, 1000, 1024"/> |
| </module> |
| <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"/> |
| <property name="packageAllowed" value="true"/> |
| </module> |
| |
| <!-- Miscellaneous other checks. --> |
| <!-- See http://checkstyle.sf.net/config_misc.html --> |
| <!-- module name="ArrayTypeStyle"/ --> |
| <!-- module name="FinalParameters"/ --> |
| <!-- Let todo plugin handle this. |
| <module name="TodoComment"/> |
| --> |
| <module name="UpperEll"/> |
| |
| </module> |
| |
| <!-- Support @SuppressWarnings (added in Checkstyle 5.7) --> |
| <!-- see http://checkstyle.sourceforge.net/config.html#SuppressWarningsFilter --> |
| <module name="SuppressWarningsFilter"/> |
| |
| <!-- Checks properties file for a duplicated properties. --> |
| <!-- See http://checkstyle.sourceforge.net/config_misc.html#UniqueProperties --> |
| <module name="UniqueProperties"/> |
| |
| </module> |