| <?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 |
| "-//Puppy Crawl//DTD Check Configuration 1.2//EN" |
| "http://www.puppycrawl.com/dtds/configuration_1_2.dtd"> |
| |
| <!-- |
| Checkstyle configuration that checks the maven coding conventions from: |
| --> |
| |
| <module name="Checker"> |
| |
| <!-- Checks that a package.html file exists for each package. --> |
| <!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml --> |
| <!-- module name="PackageHtml"/ --> |
| |
| <!-- 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="TreeWalker"> |
| |
| <property name="cacheFile" value="${checkstyle.cache.file}"/> |
| |
| <property name="tabWidth" value="4"/> |
| |
| <module name="LeftCurly"> |
| <property name="option" value="nl"/> |
| <property name="severity" value="warning"/> |
| </module> |
| |
| <module name="RightCurly"> |
| <property name="option" value="alone"/> |
| <property name="severity" value="warning"/> |
| </module> |
| |
| <module name="LineLength"> |
| <property name="max" value="120" /> |
| <property name="ignorePattern" value="@version|@see|@todo|TODO"/> |
| <property name="severity" value="warning"/> |
| </module> |
| |
| <module name="MemberName" > |
| <property name="severity" value="warning"/> |
| </module> |
| |
| <!-- Checks for Javadoc comments. --> |
| <!-- See http://checkstyle.sf.net/config_javadoc.html --> |
| <module name="JavadocMethod"> |
| <property name="severity" value="info"/> |
| </module> |
| <module name="JavadocType"> |
| <property name="severity" value="info"/> |
| </module> |
| <module name="JavadocVariable"> |
| <property name="severity" value="info"/> |
| </module> |
| |
| |
| <!-- Checks for Naming Conventions. --> |
| <!-- See http://checkstyle.sf.net/config_naming.html --> |
| <module name="ConstantName"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="LocalFinalVariableName"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="LocalVariableName"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="MethodName"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="PackageName"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="ParameterName"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="StaticVariableName"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="TypeName"> |
| <property name="severity" value="warning"/> |
| </module> |
| |
| |
| <!-- Checks for Headers --> |
| <!-- See http://checkstyle.sf.net/config_header.html --> |
| <module name="RegexpHeader"> |
| <property name="headerFile" value="${checkstyle.header.file}"/> |
| <property name="severity" value="error"/> |
| </module> |
| |
| <!-- Checks for imports --> |
| <!-- See http://checkstyle.sf.net/config_import.html --> |
| <module name="AvoidStarImport"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="IllegalImport"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="RedundantImport"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="UnusedImports"> |
| <property name="severity" value="warning"/> |
| </module> |
| |
| |
| <!-- Checks for Size Violations. --> |
| <!-- See http://checkstyle.sf.net/config_sizes.html --> |
| <module name="FileLength"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="MethodLength"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="ParameterNumber"> |
| <property name="severity" value="warning"/> |
| </module> |
| |
| |
| <!-- Checks for whitespace --> |
| <!-- See http://checkstyle.sf.net/config_whitespace.html --> |
| <module name="EmptyForIteratorPad"> |
| <property name="option" value="space"/> |
| <property name="severity" value="warning"/> |
| </module> |
| <!-- module name="NoWhitespaceAfter"/ --> |
| <!-- module name="NoWhitespaceBefore"/ --> |
| <module name="OperatorWrap"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="ParenPad"> |
| <property name="option" value="space" /> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="TabCharacter"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="WhitespaceAfter"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="WhitespaceAround"> |
| <property name="severity" value="warning"/> |
| </module> |
| <!-- module name="MethodParamPad"/ --> |
| |
| |
| <!-- Modifier Checks --> |
| <!-- See http://checkstyle.sf.net/config_modifiers.html --> |
| <module name="ModifierOrder"> |
| <property name="severity" value="warning"/> |
| </module> |
| <!-- <module name="RedundantModifier"> |
| <property name="severity" value="warning"/> |
| </module> --> |
| |
| |
| <!-- Checks for blocks. You know, those {}'s --> |
| <!-- See http://checkstyle.sf.net/config_blocks.html --> |
| <module name="AvoidNestedBlocks"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="EmptyBlock"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="NeedBraces"> |
| <property name="severity" value="warning"/> |
| </module> |
| |
| |
| <!-- Checks for common coding problems --> |
| <!-- See http://checkstyle.sf.net/config_coding.html --> |
| <!-- module name="AvoidInlineConditionals"/ --> |
| <module name="DoubleCheckedLocking"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="EmptyStatement"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="EqualsHashCode"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="HiddenField"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="IllegalInstantiation"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="InnerAssignment"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="MagicNumber"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="MissingSwitchDefault"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="RedundantThrows"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="SimplifyBooleanExpression"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="SimplifyBooleanReturn"> |
| <property name="severity" value="warning"/> |
| </module> |
| |
| <!-- Checks for class design --> |
| <!-- See http://checkstyle.sf.net/config_design.html --> |
| <!-- module name="DesignForExtension"/ --> |
| <!-- module name="FinalClass"/ --> |
| <!-- module name="HideUtilityClassConstructor"/ --> |
| <module name="InterfaceIsType"> |
| <property name="severity" value="warning"/> |
| </module> |
| <module name="VisibilityModifier"> |
| <property name="severity" value="warning"/> |
| </module> |
| |
| |
| <!-- Miscellaneous other checks. --> |
| <!-- See http://checkstyle.sf.net/config_misc.html --> |
| <!-- module name="ArrayTypeStyle"/ --> |
| <!-- module name="FinalParameters"/ --> |
| <!-- Line with Trailing Spaces (disabled as it's to noisy) |
| <module name="GenericIllegalRegexp"> |
| <property name="format" value="\s+$"/> |
| <property name="message" value="Line has trailing spaces."/> |
| </module> |
| --> |
| <!-- Let todo plugin handle this. |
| <module name="TodoComment"/> |
| --> |
| <module name="UpperEll"> |
| <property name="severity" value="warning"/> |
| </module> |
| |
| <!-- Old Habits Die Hard --> |
| <module name="GenericIllegalRegexp"> |
| <property name="format" value="org.codehaus.plexus.util.StringUtil" /> |
| <property name="message" value="[MRM-710] Use commons-lang and StringUtils instead." /> |
| <property name="severity" value="error"/> |
| </module> |
| <module name="GenericIllegalRegexp"> |
| <property name="format" value="org.codehaus.plexus.util.FileUtil" /> |
| <property name="message" value="[MRM-709] Use commons-io and FileUtils instead." /> |
| <property name="severity" value="error"/> |
| </module> |
| <module name="GenericIllegalRegexp"> |
| <property name="format" value="org.codehaus.plexus.util.IOUtil" /> |
| <property name="message" value="[MRM-709] Use commons-io and IOUtils instead." /> |
| <property name="severity" value="error"/> |
| </module> |
| |
| </module> |
| |
| </module> |