.code_styling/APPC CheckStyle Preferences.xml

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