.code_styling/APPC CheckStyle Preferences.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
   3
   4 <!--
   5     This configuration file was written by the eclipse-cs plugin configuration editor
   6 -->
   7 <!--
   8     Checkstyle-Configuration: APPC Rules
   9     Description: none
  10 -->
  11 <module name="Checker">
  12   <property name="severity" value="warning"/>
  13   <property name="charset" value="UTF-8"/>
  14   <module name="TreeWalker">
  15     <module name="FileContentsHolder"/>
  16     <module name="OuterTypeFilename">
  17       <property name="severity" value="error"/>
  18     </module>
  19     <module name="IllegalTokenText">
  20       <property name="severity" value="warning"/>
  21       <property name="tokens" value="CHAR_LITERAL,STRING_LITERAL"/>
  22       <property name="format" value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
  23       <property name="message" value="Avoid using corresponding octal or Unicode escape."/>
  24       <message key="illegal.token.text" value="Token text matches the illegal pattern ''{0}''. Avoid using Octal or Unicode escape sequences.  They are confusing and often error prone."/>
  25     </module>
  26     <module name="AvoidEscapedUnicodeCharacters">
  27       <property name="severity" value="warning"/>
  28       <property name="allowEscapesForControlCharacters" value="true"/>
  29       <property name="allowByTailComment" value="true"/>
  30       <property name="allowNonPrintableEscapes" value="true"/>
  31     </module>
  32     <module name="LineLength">
  33       <property name="severity" value="info"/>
  34       <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
  35       <property name="max" value="120"/>
  36     </module>
  37     <module name="AvoidStarImport">
  38       <property name="severity" value="error"/>
  39     </module>
  40     <module name="NoLineWrap"/>
  41     <module name="EmptyBlock">
  42       <property name="severity" value="error"/>
  43       <property name="option" value="text"/>
  44       <property name="tokens" value="LITERAL_TRY,LITERAL_CATCH,LITERAL_FINALLY,LITERAL_IF,LITERAL_ELSE,LITERAL_SWITCH"/>
  45     </module>
  46     <module name="NeedBraces">
  47       <property name="severity" value="warning"/>
  48     </module>
  49     <module name="OneStatementPerLine">
  50       <property name="severity" value="warning"/>
  51     </module>
  52     <module name="MultipleVariableDeclarations">
  53       <property name="severity" value="warning"/>
  54     </module>
  55     <module name="ArrayTypeStyle">
  56       <property name="severity" value="info"/>
  57     </module>
  58     <module name="UpperEll">
  59       <property name="severity" value="warning"/>
  60     </module>
  61     <module name="ModifierOrder">
  62       <property name="severity" value="warning"/>
  63     </module>
  64     <module name="EmptyLineSeparator">
  65       <property name="severity" value="info"/>
  66       <property name="allowNoEmptyLineBetweenFields" value="true"/>
  67     </module>
  68     <module name="PackageName">
  69       <property name="severity" value="warning"/>
  70       <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
  71       <message key="name.invalidPattern" value="Package name ''{0}'' must match pattern ''{1}''."/>
  72     </module>
  73     <module name="TypeName">
  74       <property name="severity" value="warning"/>
  75       <message key="name.invalidPattern" value="Type name ''{0}'' must match pattern ''{1}''."/>
  76     </module>
  77     <module name="MemberName">
  78       <property name="severity" value="warning"/>
  79       <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
  80       <message key="name.invalidPattern" value="Member name ''{0}'' must match pattern ''{1}''."/>
  81     </module>
  82     <module name="ParameterName">
  83       <property name="severity" value="warning"/>
  84       <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
  85       <message key="name.invalidPattern" value="Parameter name ''{0}'' must match pattern ''{1}''."/>
  86     </module>
  87     <module name="LocalVariableName">
  88       <property name="severity" value="warning"/>
  89       <property name="format" value="^[a-z][a-zA-Z0-9_]*$"/>
  90       <property name="allowOneCharVarInForLoop" value="true"/>
  91       <message key="name.invalidPattern" value="Local variable name ''{0}'' must match pattern ''{1}''."/>
  92     </module>
  93     <module name="ClassTypeParameterName">
  94       <property name="severity" value="warning"/>
  95       <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
  96       <message key="name.invalidPattern" value="Class type name ''{0}'' must match pattern ''{1}''."/>
  97     </module>
  98     <module name="MethodTypeParameterName">
  99       <property name="severity" value="warning"/>
 100       <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
 101       <message key="name.invalidPattern" value="Method type name ''{0}'' must match pattern ''{1}''."/>
 102     </module>
 103     <module name="NoFinalizer">
 104       <property name="severity" value="error"/>
 105     </module>
 106     <module name="VariableDeclarationUsageDistance">
 107       <property name="severity" value="info"/>
 108       <property name="allowedDistance" value="5"/>
 109     </module>
 110     <module name="MethodParamPad">
 111       <property name="severity" value="info"/>
 112     </module>
 113     <module name="AnnotationLocation">
 114       <property name="severity" value="warning"/>
 115       <property name="allowSamelineMultipleAnnotations" value="true"/>
 116     </module>
 117     <module name="NonEmptyAtclauseDescription">
 118       <property name="severity" value="warning"/>
 119     </module>
 120     <module name="SummaryJavadocCheck">
 121       <property name="severity" value="ignore"/>
 122       <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
 123     </module>
 124     <module name="JavadocMethod">
 125       <property name="severity" value="warning"/>
 126       <property name="minLineCount" value="2"/>
 127       <property name="allowedAnnotations" value="Override, Test"/>
 128       <property name="scope" value="protected"/>
 129       <property name="allowThrowsTagsForSubclasses" value="true"/>
 130       <property name="allowMissingThrowsTags" value="true"/>
 131       <property name="allowMissingReturnTag" value="true"/>
 132       <property name="suppressLoadErrors" value="true"/>
 133     </module>
 134     <module name="MethodName">
 135       <property name="severity" value="warning"/>
 136       <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
 137       <message key="name.invalidPattern" value="Method name ''{0}'' must match pattern ''{1}''."/>
 138     </module>
 139     <module name="JavadocType">
 140       <property name="severity" value="warning"/>
 141       <property name="scope" value="protected"/>
 142     </module>
 143     <module name="JavadocStyle">
 144       <property name="severity" value="warning"/>
 145       <property name="scope" value="protected"/>
 146       <property name="checkFirstSentence" value="false"/>
 147     </module>
 148     <module name="JavadocVariable">
 149       <property name="severity" value="warning"/>
 150       <property name="excludeScope" value="private"/>
 151       <property name="scope" value="protected"/>
 152     </module>
 153     <module name="ConstantName">
 154       <property name="severity" value="warning"/>
 155     </module>
 156     <module name="InterfaceTypeParameterName">
 157       <property name="severity" value="warning"/>
 158     </module>
 159     <module name="IllegalImport">
 160       <property name="severity" value="error"/>
 161     </module>
 162     <module name="RedundantImport">
 163       <property name="severity" value="warning"/>
 164     </module>
 165     <module name="UnusedImports">
 166       <property name="severity" value="info"/>
 167     </module>
 168     <module name="AnonInnerLength">
 169       <property name="severity" value="info"/>
 170     </module>
 171     <module name="MethodLength">
 172       <property name="severity" value="info"/>
 173     </module>
 174     <module name="ParameterNumber">
 175       <property name="severity" value="info"/>
 176     </module>
 177     <module name="OuterTypeNumber">
 178       <property name="severity" value="error"/>
 179     </module>
 180     <module name="EmptyForInitializerPad">
 181       <property name="severity" value="info"/>
 182     </module>
 183     <module name="EmptyForIteratorPad">
 184       <property name="severity" value="info"/>
 185     </module>
 186     <module name="ParenPad">
 187       <property name="severity" value="info"/>
 188     </module>
 189     <module name="TypecastParenPad">
 190       <property name="severity" value="info"/>
 191       <property name="tokens" value="RPAREN,TYPECAST"/>
 192     </module>
 193     <module name="RedundantModifier">
 194       <property name="severity" value="warning"/>
 195     </module>
 196     <module name="AvoidNestedBlocks">
 197       <property name="severity" value="warning"/>
 198       <property name="allowInSwitchCase" value="true"/>
 199     </module>
 200     <module name="CovariantEquals">
 201       <property name="severity" value="warning"/>
 202     </module>
 203     <module name="DefaultComesLast">
 204       <property name="severity" value="info"/>
 205     </module>
 206     <module name="DeclarationOrder">
 207       <property name="severity" value="ignore"/>
 208       <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="info"/>
 209     </module>
 210     <module name="EmptyStatement">
 211       <property name="severity" value="error"/>
 212     </module>
 213     <module name="EqualsAvoidNull">
 214       <property name="severity" value="warning"/>
 215     </module>
 216     <module name="EqualsHashCode">
 217       <property name="severity" value="warning"/>
 218     </module>
 219     <module name="HiddenField">
 220       <property name="severity" value="warning"/>
 221       <property name="ignoreConstructorParameter" value="true"/>
 222       <property name="ignoreSetter" value="true"/>
 223     </module>
 224     <module name="IllegalInstantiation">
 225       <property name="severity" value="warning"/>
 226       <property name="classes" value="java.lang.Boolean"/>
 227     </module>
 228     <module name="IllegalCatch">
 229       <property name="severity" value="warning"/>
 230       <message key="illegal.catch" value="Catching java.lang.Exception or unchecked exceptions should not be done!"/>
 231     </module>
 232     <module name="IllegalThrows">
 233       <property name="severity" value="warning"/>
 234     </module>
 235     <module name="InnerAssignment">
 236       <property name="severity" value="warning"/>
 237     </module>
 238     <module name="MagicNumber">
 239       <property name="severity" value="warning"/>
 240     </module>
 241     <module name="MissingCtor">
 242       <property name="severity" value="info"/>
 243     </module>
 244     <module name="ModifiedControlVariable">
 245       <property name="severity" value="error"/>
 246     </module>
 247     <module name="MultipleStringLiterals">
 248       <property name="severity" value="info"/>
 249     </module>
 250     <module name="MultipleVariableDeclarations">
 251       <property name="severity" value="warning"/>
 252     </module>
 253     <module name="NestedForDepth">
 254       <property name="severity" value="warning"/>
 255       <property name="max" value="4"/>
 256     </module>
 257     <module name="NestedIfDepth">
 258       <property name="severity" value="warning"/>
 259       <property name="max" value="4"/>
 260     </module>
 261     <module name="NestedTryDepth">
 262       <property name="severity" value="warning"/>
 263       <property name="max" value="2"/>
 264     </module>
 265     <module name="PackageDeclaration">
 266       <property name="severity" value="error"/>
 267     </module>
 268     <module name="ParameterAssignment">
 269       <property name="severity" value="error"/>
 270       <message key="parameter.assignment" value="Assignment of parameter ''{0}'' should not be done.  The effect of doing this could cause side effects with the calling method(s)."/>
 271     </module>
 272     <module name="ReturnCount">
 273       <property name="severity" value="warning"/>
 274     </module>
 275     <module name="SimplifyBooleanExpression">
 276       <property name="severity" value="info"/>
 277     </module>
 278     <module name="SimplifyBooleanReturn">
 279       <property name="severity" value="info"/>
 280     </module>
 281     <module name="StringLiteralEquality">
 282       <property name="severity" value="warning"/>
 283     </module>
 284     <module name="SuperClone">
 285       <property name="severity" value="error"/>
 286     </module>
 287     <module name="UnnecessaryParentheses">
 288       <property name="severity" value="info"/>
 289     </module>
 290     <module name="OneStatementPerLine">
 291       <property name="severity" value="warning"/>
 292     </module>
 293     <module name="FinalClass">
 294       <property name="severity" value="warning"/>
 295     </module>
 296     <module name="InnerTypeLast">
 297       <property name="severity" value="warning"/>
 298     </module>
 299     <module name="HideUtilityClassConstructor">
 300       <property name="severity" value="error"/>
 301     </module>
 302     <module name="InterfaceIsType">
 303       <property name="severity" value="warning"/>
 304     </module>
 305     <module name="VisibilityModifier">
 306       <property name="severity" value="error"/>
 307       <property name="protectedAllowed" value="true"/>
 308     </module>
 309     <module name="ClassDataAbstractionCoupling">
 310       <property name="severity" value="info"/>
 311     </module>
 312     <module name="ClassFanOutComplexity">
 313       <property name="severity" value="info"/>
 314     </module>
 315     <module name="CyclomaticComplexity">
 316       <property name="severity" value="info"/>
 317     </module>
 318     <module name="NPathComplexity">
 319       <property name="severity" value="info"/>
 320     </module>
 321     <module name="TodoComment">
 322       <property name="severity" value="warning"/>
 323     </module>
 324     <module name="UncommentedMain">
 325       <property name="severity" value="warning"/>
 326     </module>
 327   </module>
 328   <module name="FileTabCharacter">
 329     <property name="severity" value="warning"/>
 330     <property name="eachLine" value="true"/>
 331   </module>
 332   <module name="UniqueProperties">
 333     <property name="severity" value="warning"/>
 334   </module>
 335   <module name="SuppressionFilter">
 336     <property name="file" value="${samedir}/Checkstyle_Suppression_Filter.xml"/>
 337   </module>
 338   <module name="SuppressionCommentFilter">
 339     <property name="offCommentFormat" value="@sonar:off"/>
 340     <property name="onCommentFormat" value="@sonar:on"/>
 341   </module>
 342 </module>