| <?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.3//EN" |
| "https://checkstyle.org/dtds/configuration_1_3.dtd"> |
| |
| <!-- Checkstyle checks configured for Maven. --> |
| |
| <module name="Checker"> |
| |
| <property name="cacheFile" value="${checkstyle.cache.file}" /> |
| |
| <!-- Checks that a package.html file exists for each package. --> |
| <!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml --> |
| <module name="JavadocPackage"> |
| <!-- setting allowLegacy means it will check for package.html instead of just package-info.java --> |
| <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="Header"> |
| <property name="headerFile" value="${checkstyle.header.file}" /> |
| </module> |
| |
| <module name="FileLength" /> |
| |
| <module name="FileTabCharacter"> |
| <property name="fileExtensions" value="java,xml" /> |
| </module> |
| |
| <module name="RegexpSingleline"> |
| <property name="format" value="\s+$" /> |
| <property name="message" value="Line has trailing spaces." /> |
| </module> |
| |
| <module name="LineLength"> |
| <property name="max" value="160" /> |
| </module> |
| |
| <module name="TreeWalker"> |
| |
| <module name="ExplicitInitializationCheck" /> |
| <!-- ************************************************************** --> |
| <!-- Checks that are different from the sun coding conventions ones --> |
| <!-- ************************************************************** --> |
| <property name="tabWidth" value="4" /> |
| <module name="LeftCurly"> |
| <property name="option" value="eol" /> |
| </module> |
| <module name="RightCurly"> |
| <property name="option" value="same" /> |
| </module> |
| <module name="MethodLength"> |
| <property name="max" value="175" /> |
| </module> |
| <!-- No Paren pad check <module name="ParenPad"/> --> |
| <module name="ConstantName"> |
| <property name="format" value="log|^[a-zA-Z][a-zA-Z0-9_]*$" /> |
| </module> |
| |
| <!-- ************************************************************** --> |
| <!-- Default Sun coding conventions checks --> |
| <!-- ************************************************************** --> |
| |
| <!-- Checks for Javadoc comments. --> |
| <!-- See http://checkstyle.sf.net/config_javadoc.html --> |
| <module name="JavadocMethod"> |
| <property name="accessModifiers" value="protected" /> |
| </module> |
| <module name="JavadocType"> |
| <property name="scope" value="protected" /> |
| </module> |
| <module name="JavadocVariable"> |
| <property name="scope" value="protected" /> |
| </module> |
| |
| <!-- Checks for Naming Conventions. --> |
| <!-- See http://checkstyle.sf.net/config_naming.html --> |
| <module name="LocalFinalVariableName" /> |
| <module name="LocalVariableName" /> |
| <module name="MethodName" /> |
| <module name="PackageName" /> |
| <module name="ParameterName" /> |
| <module name="StaticVariableName" /> |
| <module name="TypeName" /> |
| <module name="MemberName" /> |
| |
| <!-- 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="ParameterNumber" /> |
| |
| <!-- Checks for whitespace --> |
| <!-- See http://checkstyle.sf.net/config_whitespace.html --> |
| <module name="EmptyForIteratorPad" /> |
| <module name="NoWhitespaceBefore" /> |
| <!-- module name="OperatorWrap"/ --> |
| <module name="WhitespaceAfter"> |
| <property name="tokens" value="COMMA, SEMI" /> |
| </module> |
| <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="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"/ --> |
| <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" /> |
| |
| <!-- Miscellaneous other checks. --> |
| <!-- See http://checkstyle.sf.net/config_misc.html --> |
| <module name="ArrayTypeStyle" /> |
| <!-- module name="FinalParameters"/ --> |
| <module name="TodoComment" /> |
| <module name="UpperEll" /> |
| <module name="ImportOrder"> |
| <property name="option" value="top"/> |
| <property name="groups" value="java,javax,org"/> |
| <property name="ordered" value="true"/> |
| <property name="separated" value="true"/> |
| </module> |
| |
| </module> |
| <!-- @author tags are deprecated --> |
| <module name="RegexpSingleline"> |
| <property name="format" value="^\s+\*\s+@author\s" /> |
| <property name="message" value="Deprecated @author tag" /> |
| <property name="fileExtensions" value="java" /> |
| <property name="severity" value="warning" /> |
| </module> |
| </module> |