blob: 954a75c0d81e118783839bbd8a02713c116012cf [file] [log] [blame]
<?xml version="1.0"?>
"-//Puppy Crawl//DTD Check Configuration 1.1//EN"
<!-- Checkstyle configuration that checks the commons-configuration coding conventions -->
<module name="Checker">
<property name="localeLanguage" value="en"/>
<!-- Checks that a package.html file exists for each package. -->
<!-- See -->
<module name="PackageHtml"/>
<!-- Checks whether files end with a new line. -->
<!-- See -->
<module name="NewlineAtEndOfFile"/>
<!-- Checks that property files contain the same keys. -->
<!-- See -->
<module name="Translation"/>
<!-- Exceptions -->
<!--<module name="SuppressionFilter">
<property name="file" value="conf/checkstyle-suppressions.xml"/>
</module> -->
<module name="TreeWalker">
<property name="cacheFile" value="${checkstyle.cache.file}"/>
<!-- Checks for Javadoc comments. -->
<!-- See -->
<module name="JavadocMethod">
<property name="scope" value="public"/>
<property name="allowUndeclaredRTE" value="true"/>
<property name="allowMissingJavadoc" value="true"/>
<module name="JavadocType">
<property name="authorFormat" value="\S"/>
<module name="JavadocVariable">
<property name="scope" value="protected"/>
<module name="JavadocStyle">
<property name="scope" value="public"/>
<!-- Checks for Naming Conventions. -->
<!-- See -->
<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 -->
<module name="Header">
<property name="headerFile" value="${licensedir}"/>
<!--<property name="ignoreLines" value="2"/> -->
<!-- Following interprets the header file as regular expressions. -->
<!-- <module name="RegexpHeader"/> -->
<!-- Checks for imports -->
<!-- See -->
<module name="AvoidStarImport"/>
<module name="IllegalImport"/> <!-- defaults to sun.* packages -->
<module name="RedundantImport"/>
<module name="UnusedImports"/>
<!-- Checks for Size Violations. -->
<!-- See -->
<!--<module name="FileLength"/>-->
<module name="LineLength">
<property name="max" value="120"/>
<module name="MethodLength"/>
<module name="ParameterNumber">
<property name="max" value="10"/>
<!-- Checks for whitespace -->
<!-- See -->
<module name="EmptyForIteratorPad"/>
<module name="NoWhitespaceAfter"/>
<module name="NoWhitespaceBefore"/>
<module name="OperatorWrap"/>
<module name="ParenPad"/>
<module name="TabCharacter"/>
<module name="WhitespaceAfter"/>
<module name="WhitespaceAround"/>
<!-- Modifier Checks -->
<!-- See -->
<module name="ModifierOrder"/>
<module name="RedundantModifier"/>
<!-- Checks for blocks. You know, those {}'s -->
<!-- See -->
<module name="AvoidNestedBlocks"/>
<!-- Require empty catch blocks to have at least a comment -->
<module name="EmptyBlock">
<property name="option" value="text"/>
<property name="tokens" value="LITERAL_CATCH"/>
<module name="LeftCurly">
<property name="option" value="nl"/>
<module name="NeedBraces"/>
<module name="RightCurly">
<property name="option" value="alone"/>
<!-- Checks for common coding problems -->
<!-- See -->
<module name="CovariantEquals"/>
<module name="DoubleCheckedLocking"/>
<module name="EqualsHashCode"/>
<module name="IllegalInstantiation"/>
<!-- <module name="InnerAssignment"/> -->
<module name="MagicNumber">
<property name="ignoreNumbers" value="-1,0,1,2,3"/>
<module name="RedundantThrows">
<property name="allowUnchecked" value="true"/>
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>
<module name="StringLiteralEquality"/>
<module name="SuperClone"/>
<module name="SuperFinalize"/>
<module name="DeclarationOrder"/>
<module name="ExplicitInitialization"/>
<module name="DefaultComesLast"/>
<module name="FallThrough"/>
<module name="MultipleVariableDeclarations"/>
<!-- <module name="UnnecessaryParentheses"/> -->
<!-- Checks for class design -->
<!-- See -->
<module name="FinalClass"/>
<module name="HideUtilityClassConstructor"/>
<module name="InterfaceIsType"/>
<module name="VisibilityModifier">
<property name="protectedAllowed" value="true"/>
<!-- Miscellaneous other checks. -->
<!-- See -->
<module name="ArrayTypeStyle"/>
<module name="GenericIllegalRegexp">
<property name="format" value="\s+$"/>
<property name="message" value="Line has trailing spaces."/>
<module name="TodoComment">
<property name="severity" value="info"/>
<module name="UpperEll"/>