378 lines
17 KiB
XML
378 lines
17 KiB
XML
<!--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
~ Multiverse 2 Copyright (c) the Multiverse Team 2011. ~
|
|
~ Multiverse 2 is licensed under the BSD License. ~
|
|
~ For more information please check the README.md file included ~
|
|
~ with this project. ~
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-->
|
|
|
|
<!DOCTYPE module PUBLIC
|
|
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
|
|
"https://checkstyle.org/dtds/configuration_1_3.dtd">
|
|
<!-- Future reference: valid severity values are 'ignore', 'info', 'warning', 'error' -->
|
|
<module name="Checker">
|
|
|
|
<!-- Javadoc Comments -->
|
|
<module name="JavadocPackage"/><!-- require package-info.java file -->
|
|
|
|
<!-- Miscellaneous -->
|
|
<module name="NewlineAtEndOfFile" />
|
|
<module name="OrderedProperties"/>
|
|
<module name="Translation"/>
|
|
<module name="UniqueProperties"/>
|
|
|
|
<!-- Regexp -->
|
|
<module name="RegexpSingleline">
|
|
<property name="message" value="Line has trailing spaces."/>
|
|
<property name="format" value="\s+$"/>
|
|
</module>
|
|
|
|
<!-- Size Violations -->
|
|
<module name="FileLength">
|
|
<property name="max" value="2000"/>
|
|
</module>
|
|
<module name="LineLength">
|
|
<property name="fileExtensions" value="java"/>
|
|
<property name="max" value="160"/>
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
|
|
<!-- Whitespace -->
|
|
<module name="FileTabCharacter">
|
|
<property name="eachLine" value="true"/>
|
|
</module>
|
|
|
|
<module name="TreeWalker">
|
|
<!-- Make suppression possible -->
|
|
<module name="SuppressWithNearbyCommentFilter">
|
|
<property name="commentFormat" value="SUPPRESS CHECKSTYLE: (\w+)"/>
|
|
<property name="checkFormat" value="$1"/>
|
|
</module>
|
|
<module name="SuppressionCommentFilter">
|
|
<property name="offCommentFormat" value="BEGIN CHECKSTYLE-SUPPRESSION\: (\w+)"/>
|
|
<property name="onCommentFormat" value="END CHECKSTYLE-SUPPRESSION\: (\w+)"/>
|
|
<property name="checkFormat" value="$1"/>
|
|
</module>
|
|
<module name="SuppressionCommentFilter">
|
|
<property name="offCommentFormat" value="BEGIN CHECKSTYLE-SUPPRESSION\: ALL"/>
|
|
<property name="onCommentFormat" value="END CHECKSTYLE-SUPPRESSION\: ALL"/>
|
|
</module>
|
|
|
|
<!-- Actual checks -->
|
|
|
|
<!-- Annotations -->
|
|
<module name="AnnotationLocation"/>
|
|
<module name="AnnotationUseStyle"/>
|
|
<module name="MissingDeprecated"/>
|
|
<module name="MissingOverride"/>
|
|
|
|
<!-- Block Checks -->
|
|
<module name="AvoidNestedBlocks"/>
|
|
<module name="EmptyBlock"/>
|
|
<module name="EmptyCatchBlock">
|
|
<property name="exceptionVariableName" value="ignore"/>
|
|
</module>
|
|
<module name="LeftCurly">
|
|
<property name="ignoreEnums" value="false"/>
|
|
</module>
|
|
<module name="NeedBraces">
|
|
<property name="tokens" value="LITERAL_IF"/>
|
|
<property name="allowSingleLineStatement" value="true"/>
|
|
</module>
|
|
<module name="NeedBraces">
|
|
<property name="tokens" value="LITERAL_DO,LITERAL_ELSE,LITERAL_FOR,LITERAL_WHILE"/>
|
|
</module>
|
|
<module name="RightCurly"/>
|
|
|
|
<!-- Class Design -->
|
|
<module name="DesignForExtension">
|
|
<property name="severity" value="info"/>
|
|
</module>
|
|
<module name="FinalClass"/>
|
|
<module name="HideUtilityClassConstructor"/>
|
|
<module name="InnerTypeLast"/>
|
|
<module name="InterfaceIsType"/>
|
|
<module name="MutableException"/>
|
|
<module name="OneTopLevelClass"/>
|
|
<module name="ThrowsCount">
|
|
<property name="max" value="0"/>
|
|
</module>
|
|
<module name="VisibilityModifier">
|
|
<property name="protectedAllowed" value="true"/>
|
|
</module>
|
|
|
|
<!-- Coding -->
|
|
<module name="ArrayTrailingComma"/>
|
|
<module name="AvoidDoubleBraceInitialization"/>
|
|
<module name="AvoidNoArgumentSuperConstructorCall"/>
|
|
<module name="CovariantEquals"/>
|
|
<module name="DeclarationOrder"/>
|
|
<module name="DefaultComesLast"/>
|
|
<module name="EmptyStatement"/>
|
|
<module name="EqualsAvoidNull"/>
|
|
<module name="EqualsHashCode"/>
|
|
<module name="FallThrough">
|
|
<property name="checkLastCaseGroup" value="true"/>
|
|
</module>
|
|
<module name="HiddenField">
|
|
<property name="ignoreConstructorParameter" value="true"/>
|
|
<property name="ignoreSetter" value="true"/>
|
|
<property name="setterCanReturnItsClass" value="true"/>
|
|
<property name="ignoreAbstractMethods" value="true"/>
|
|
</module>
|
|
<module name="IllegalCatch"/>
|
|
<module name="IllegalThrows"/>
|
|
<module name="IllegalToken"/>
|
|
<module name="IllegalType"/>
|
|
<module name="InnerAssignment"/>
|
|
<module name="MagicNumber">
|
|
<property name="ignoreHashCodeMethod" value="true"/>
|
|
<property name="ignoreAnnotationElementDefaults" value="true"/>
|
|
</module>
|
|
<module name="MissingSwitchDefault"/>
|
|
<module name="ModifiedControlVariable"/>
|
|
<module name="MultipleStringLiterals"/>
|
|
<module name="MultipleVariableDeclarations"/>
|
|
<module name="NestedForDepth">
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="NestedIfDepth"/>
|
|
<module name="NestedTryDepth"/>
|
|
<module name="NoClone"/>
|
|
<module name="NoFinalizer"/>
|
|
<module name="OneStatementPerLine"/>
|
|
<module name="PackageDeclaration"/>
|
|
<module name="ParameterAssignment"/>
|
|
<module name="RequireThis"/>
|
|
<module name="ReturnCount"/>
|
|
<module name="SimplifyBooleanExpression"/>
|
|
<module name="SimplifyBooleanReturn"/>
|
|
<module name="StringLiteralEquality"/>
|
|
<module name="SuperClone"/>
|
|
<module name="SuperFinalize"/>
|
|
<module name="UnnecessaryParentheses"/>
|
|
<module name="UnnecessarySemicolonAfterOuterTypeDeclaration"/>
|
|
<module name="UnnecessarySemicolonAfterTypeMemberDeclaration"/>
|
|
<module name="UnnecessarySemicolonInEnumeration"/>
|
|
<module name="UnnecessarySemicolonInTryWithResources"/>
|
|
<module name="UnusedLocalVariable"/>
|
|
<module name="VariableDeclarationUsageDistance">
|
|
<property name="allowedDistance" value="3"/>
|
|
<property name="validateBetweenScopes" value="false"/>
|
|
</module>
|
|
<module name="VariableDeclarationUsageDistance">
|
|
<property name="allowedDistance" value="5"/>
|
|
<property name="validateBetweenScopes" value="true"/>
|
|
</module>
|
|
|
|
<!-- Imports -->
|
|
<module name="AvoidStarImport"/>
|
|
<module name="IllegalImport">
|
|
<property name="illegalPkgs" value="sun"/>
|
|
</module>
|
|
<module name="ImportOrder"/>
|
|
<module name="RedundantImport"/>
|
|
<module name="UnusedImports"/>
|
|
|
|
<!-- Javadoc Comments -->
|
|
<module name="AtclauseOrder"/>
|
|
<module name="InvalidJavadocPosition"/>
|
|
<module name="JavadocBlockTagLocation"/>
|
|
<module name="JavadocContentLocationCheck"/>
|
|
<module name="JavadocMethod">
|
|
<property name="accessModifiers" value="public, protected, package"/>
|
|
<property name="tokens" value="METHOD_DEF"/>
|
|
</module>
|
|
<module name="JavadocMethod">
|
|
<property name="accessModifiers" value="public"/>
|
|
</module>
|
|
<module name="JavadocMissingLeadingAsterisk"/>
|
|
<module name="JavadocMissingWhitespaceAfterAsterisk"/>
|
|
<module name="JavadocParagraph">
|
|
<property name="allowNewlineParagraph" value="true"/>
|
|
</module>
|
|
<module name="JavadocStyle">
|
|
<property name="scope" value="package"/>
|
|
</module>
|
|
<module name="JavadocTagContinuationIndentation"/>
|
|
<module name="JavadocType"/>
|
|
<module name="JavadocVariable">
|
|
<property name="scope" value="package"/>
|
|
</module>
|
|
<module name="MissingJavadocMethod">
|
|
<property name="scope" value="public"/>
|
|
<property name="allowMissingPropertyJavadoc" value="true"/>
|
|
</module>
|
|
<module name="MissingJavadocMethod">
|
|
<property name="scope" value="protected"/>
|
|
<property name="excludeScope" value="public"/>
|
|
<property name="allowMissingPropertyJavadoc" value="true"/>
|
|
<property name="minLineCount" value="2"/>
|
|
</module>
|
|
<module name="MissingJavadocType"/>
|
|
<module name="NonEmptyAtclauseDescription"/>
|
|
<module name="RequireEmptyLineBeforeBlockTagGroup"/>
|
|
<module name="SingleLineJavadoc"/>
|
|
<module name="SummaryJavadoc"/>
|
|
<module name="WriteTag">
|
|
<property name="tag" value="@author"/>
|
|
<property name="tagFormat" value="\S"/>
|
|
<property name="severity" value="ignore"/>
|
|
<property name="tagSeverity" value="warning"/>
|
|
</module>
|
|
|
|
<!-- Metrics -->
|
|
<module name="BooleanExpressionComplexity"/>
|
|
<module name="ClassDataAbstractionCoupling">
|
|
<property name="max" value="7"/>
|
|
<property name="excludedClasses" value="ArrayIndexOutOfBoundsException, ArrayList, Boolean, Byte, Character, Class, Collection, Deprecated, Deque, Double, DoubleStream, EnumSet, Exception, Float, FunctionalInterface, HashMap, HashSet, IllegalArgumentException, IllegalStateException, IndexOutOfBoundsException, IntStream, Integer, LinkedHashMap, LinkedHashSet, LinkedList, List, Long, LongStream, Map, NullPointerException, Object, Optional, OptionalDouble, OptionalInt, OptionalLong, Override, Queue, RuntimeException, SafeVarargs, SecurityException, Set, Short, SortedMap, SortedSet, Stream, String, StringBuffer, StringBuilder, SuppressWarnings, Throwable, TreeMap, TreeSet, UnsupportedOperationException, Void, boolean, byte, char, double, float, int, long, short, var, void"/>
|
|
</module>
|
|
<module name="ClassFanOutComplexity">
|
|
<property name="max" value="20"/>
|
|
<property name="excludedClasses" value="ArrayIndexOutOfBoundsException, ArrayList, Boolean, Byte, Character, Class, Collection, Deprecated, Deque, Double, DoubleStream, EnumSet, Exception, Float, FunctionalInterface, HashMap, HashSet, IllegalArgumentException, IllegalStateException, IndexOutOfBoundsException, IntStream, Integer, LinkedHashMap, LinkedHashSet, LinkedList, List, Long, LongStream, Map, NullPointerException, Object, Optional, OptionalDouble, OptionalInt, OptionalLong, Override, Queue, RuntimeException, SafeVarargs, SecurityException, Set, Short, SortedMap, SortedSet, Stream, String, StringBuffer, StringBuilder, SuppressWarnings, Throwable, TreeMap, TreeSet, UnsupportedOperationException, Void, boolean, byte, char, double, float, int, long, short, var, void"/>
|
|
</module>
|
|
<module name="CyclomaticComplexity">
|
|
<property name="max" value="7"/>
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="JavaNCSS">
|
|
<property name="methodMaximum" value="50"/>
|
|
<property name="classMaximum" value="1500"/>
|
|
<property name="fileMaximum" value="2000"/>
|
|
<property name="recordMaximum" value="150"/>
|
|
</module>
|
|
<module name="NPathComplexity">
|
|
<property name="max" value="200"/>
|
|
</module>
|
|
|
|
<!-- Miscellaneous -->
|
|
<module name="ArrayTypeStyle"/>
|
|
<module name="AvoidEscapedUnicodeCharacters">
|
|
<property name="allowNonPrintableEscapes" value="true"/>
|
|
</module>
|
|
<module name="CommentsIndentation"/>
|
|
<module name="Indentation">
|
|
<property name="basicOffset" value="4"/>
|
|
<property name="braceAdjustment" value="0"/>
|
|
<property name="caseIndent" value="4"/>
|
|
<property name="throwsIndent" value="4"/>
|
|
<property name="arrayInitIndent" value="4"/>
|
|
<property name="lineWrappingIndentation" value="4"/>
|
|
<property name="forceStrictCondition" value="true"/>
|
|
</module>
|
|
<module name="NoCodeInFile"/>
|
|
<module name="OuterTypeFilename"/>
|
|
<module name="TodoComment">
|
|
<property name="format" value="TODO"/>
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="TrailingComment"/>
|
|
<module name="UncommentedMain"/>
|
|
<module name="UpperEll"/>
|
|
|
|
<!-- Modifiers -->
|
|
<module name="ModifierOrder"/>
|
|
<module name="RedundantModifier"/>
|
|
|
|
<!-- Naming Conventions -->
|
|
<module name="AbbreviationAsWordInName">
|
|
<property name="ignoreFinal" value="false"/>
|
|
<property name="allowedAbbreviations" value="MV"/>
|
|
</module>
|
|
<module name="AbstractClassName"/>
|
|
<module name="CatchParameterName"/>
|
|
<module name="ClassTypeParameterName">
|
|
<property name="format" value="^[A-Z]{1,3}$"/>
|
|
</module>
|
|
<module name="ConstantName"/>
|
|
<module name="IllegalIdentifierName"/>
|
|
<module name="InterfaceTypeParameterName">
|
|
<property name="format" value="^[A-Z]{1,3}$"/>
|
|
</module>
|
|
<module name="LambdaParameterName"/>
|
|
<module name="LocalFinalVariableName"/>
|
|
<module name="LocalVariableName"/>
|
|
<module name="MemberName"/>
|
|
<module name="MethodName"/>
|
|
<module name="MethodTypeParameterName">
|
|
<property name="format" value="^[A-Z]{1,3}$"/>
|
|
</module>
|
|
<module name="PackageName"/>
|
|
<module name="ParameterName"/>
|
|
<module name="PatternVariableName"/>
|
|
<module name="RecordComponentName"/>
|
|
<module name="RecordTypeParameterName">
|
|
<property name="format" value="^[A-Z]{1,3}$"/>
|
|
</module>
|
|
<module name="StaticVariableName"/>
|
|
<module name="TypeName"/>
|
|
|
|
<!-- Size Violations -->
|
|
<module name="AnonInnerLength">
|
|
<property name="max" value="20"/>
|
|
</module>
|
|
<module name="ExecutableStatementCount">
|
|
<property name="max" value="30"/>
|
|
</module>
|
|
<module name="LambdaBodyLength">
|
|
<property name="max" value="10"/>
|
|
</module>
|
|
<module name="MethodCount">
|
|
<property name="maxTotal" value="100"/>
|
|
<property name="maxPrivate" value="100"/>
|
|
<property name="maxPackage" value="100"/>
|
|
<property name="maxProtected" value="100"/>
|
|
<property name="maxPublic" value="100"/>
|
|
</module>
|
|
<module name="MethodLength">
|
|
<property name="max" value="50"/>
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="OuterTypeNumber">
|
|
<property name="max" value="1"/>
|
|
</module>
|
|
<module name="ParameterNumber">
|
|
<property name="max" value="3"/>
|
|
<property name="ignoreOverriddenMethods" value="true"/>
|
|
<property name="severity" value="warning"/>
|
|
</module>
|
|
<module name="RecordComponentNumber">
|
|
<property name="max" value="8"/>
|
|
</module>
|
|
|
|
<!-- Whitespace -->
|
|
<module name="EmptyForInitializerPad"/>
|
|
<module name="EmptyForIteratorPad"/>
|
|
<module name="EmptyLineSeparator">
|
|
<property name="allowNoEmptyLineBetweenFields" value="true"/>
|
|
<property name="allowMultipleEmptyLines" value="false"/>
|
|
<property name="allowMultipleEmptyLinesInsideClassMembers" value="false"/>
|
|
</module>
|
|
<module name="GenericWhitespace"/>
|
|
<module name="MethodParamPad"/>
|
|
<module name="NoLineWrap"/>
|
|
<module name="NoWhitespaceAfter">
|
|
<property name="tokens" value="AT,INC,DEC,UNARY_MINUS,UNARY_PLUS,BNOT,LNOT,DOT,ARRAY_DECLARATOR,INDEX_OP,LITERAL_SYNCHRONIZED,METHOD_REF"/>
|
|
</module>
|
|
<module name="NoWhitespaceBefore">
|
|
<property name="tokens" value="COMMA,SEMI,POST_INC,POST_DEC,DOT,GENERIC_START,GENERIC_END,ELLIPSIS,LABELED_STAT,METHOD_REF"/>
|
|
</module>
|
|
<module name="NoWhitespaceBeforeCaseDefaultColon"/>
|
|
<module name="OperatorWrap">
|
|
<property name="tokens" value="QUESTION,COLON,EQUAL,NOT_EQUAL,DIV,PLUS,MINUS,STAR,MOD,SR,BSR,GE,GT,SL,LE,LT,BXOR,BOR,LOR,BAND,LAND,LITERAL_INSTANCEOF,TYPE_EXTENSION_AND,ASSIGN,DIV_ASSIGN,PLUS_ASSIGN,MINUS_ASSIGN,STAR_ASSIGN,MOD_ASSIGN,SR_ASSIGN,BSR_ASSIGN,SL_ASSIGN,BXOR_ASSIGN,BOR_ASSIGN,BAND_ASSIGN,METHOD_REF"/>
|
|
</module>
|
|
<module name="ParenPad"/>
|
|
<module name="SeparatorWrap">
|
|
<property name="option" value="nl"/>
|
|
<property name="tokens" value="DOT,AT,RPAREN,METHOD_REF"/>
|
|
</module>
|
|
<module name="SeparatorWrap">
|
|
<property name="option" value="eol"/>
|
|
<property name="tokens" value="COMMA,SEMI,ELLIPSIS,LPAREN,ARRAY_DECLARATOR,RBRACK"/>
|
|
</module>
|
|
<module name="SingleSpaceSeparator"/>
|
|
<module name="TypecastParenPad"/>
|
|
<module name="WhitespaceAfter"/>
|
|
<module name="WhitespaceAround"/>
|
|
</module>
|
|
</module>
|