checkstyle/src/main/resources/onap-checkstyle/onap-java-style.xml

   1 <?xml version="1.0"?>
   2 <!--
   3    Copyright (c) 2016 Huawei Technologies Co., Ltd.
   4    Modifications Copyright (C) 2019-2020, 2024 Nordix Foundation.
   5
   6    Licensed under the Apache License, Version 2.0 (the "License");
   7    you may not use this file except in compliance with the License.
   8    You may obtain a copy of the License at
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  12    Unless required by applicable law or agreed to in writing, software
  13    distributed under the License is distributed on an "AS IS" BASIS,
  14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15    See the License for the specific language governing permissions and
  16    limitations under the License.
  17 -->
  18 <!DOCTYPE module PUBLIC
  19           "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
  20           "https://checkstyle.org/dtds/configuration_1_3.dtd">
  21
  22 <!--
  23     Checkstyle configuration that checks the Google coding conventions from Google Java Style
  24     that can be found at https://google.github.io/styleguide/javaguide.html
  25
  26     Checkstyle is very configurable. Be sure to read the documentation at
  27     http://checkstyle.org (or in your downloaded distribution).
  28
  29     To completely disable a check, just comment it out or delete it from the file.
  30     To suppress certain violations please review suppression filters.
  31
  32     Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
  33  -->
  34
  35  <!--
  36  To update the checkstyle version in ONAP see:
  37  https://wiki.onap.org/display/DW/How+to+update+ONAP+checkstyle+when+Checkstyle+steps+their+version
  38   -->
  39
  40 <module name="Checker">
  41     <property name="charset" value="UTF-8" />
  42
  43     <property name="severity" value="warning" />
  44
  45     <property name="fileExtensions" value="java, properties, xml" />
  46     <!-- Excludes all 'module-info.java' files              -->
  47     <!-- See https://checkstyle.org/config_filefilters.html -->
  48     <module name="BeforeExecutionExclusionFileFilter">
  49         <property name="fileNamePattern" value="module\-info\.java$" />
  50     </module>
  51     <!-- https://checkstyle.org/config_filters.html#SuppressionFilter -->
  52     <module name="SuppressionFilter">
  53         <property name="file" value="${org.checkstyle.google.suppressionfilter.config}"
  54             default="checkstyle-suppressions.xml" />
  55         <property name="optional" value="true" />
  56     </module>
  57     <module name="SuppressWarningsFilter"/>
  58
  59     <!-- Checks for whitespace                               -->
  60     <!-- See http://checkstyle.org/config_whitespace.html -->
  61     <module name="FileTabCharacter">
  62         <property name="eachLine" value="true" />
  63     </module>
  64
  65     <module name="LineLength">
  66         <property name="fileExtensions" value="java" />
  67         <property name="max" value="120" />
  68         <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://" />
  69     </module>
  70
  71     <module name="TreeWalker">
  72         <module name="OuterTypeFilename" />
  73         <module name="IllegalTokenText">
  74             <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL" />
  75             <property name="format"
  76                 value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)" />
  77             <property name="message"
  78                 value="Consider using special escape sequence instead of octal value or Unicode escaped value." />
  79         </module>
  80         <module name="AvoidEscapedUnicodeCharacters">
  81             <property name="allowEscapesForControlCharacters" value="true" />
  82             <property name="allowByTailComment" value="true" />
  83             <property name="allowNonPrintableEscapes" value="true" />
  84         </module>
  85         <module name="AvoidStarImport" />
  86         <module name="OneTopLevelClass" />
  87         <module name="NoLineWrap">
  88             <property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT" />
  89         </module>
  90         <module name="EmptyBlock">
  91             <property name="option" value="TEXT" />
  92             <property name="tokens"
  93                 value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH" />
  94         </module>
  95         <module name="NeedBraces">
  96             <property name="tokens" value="LITERAL_DO, LITERAL_ELSE, LITERAL_FOR, LITERAL_IF, LITERAL_WHILE" />
  97         </module>
  98         <module name="LeftCurly">
  99             <property name="tokens"
 100                 value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF,
 101                     INTERFACE_DEF, LAMBDA, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT,
 102                     LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF,
 103                     LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF,
 104                     OBJBLOCK, STATIC_INIT" />
 105         </module>
 106         <module name="RightCurly">
 107             <property name="id" value="RightCurlySame" />
 108             <property name="tokens"
 109                 value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE,
 110                     LITERAL_DO" />
 111         </module>
 112         <module name="RightCurly">
 113             <property name="id" value="RightCurlyAlone" />
 114             <property name="option" value="alone" />
 115             <property name="tokens"
 116                 value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,
 117                     INSTANCE_INIT, ANNOTATION_DEF, ENUM_DEF" />
 118         </module>
 119         <module name="SuppressionXpathSingleFilter">
 120           <!-- suppression is required till https://github.com/checkstyle/checkstyle/issues/7541 -->
 121             <property name="id" value="RightCurlyAlone" />
 122             <property name="query"
 123                 value="//RCURLY[parent::SLIST[count(./*)=1]
 124                                                  or preceding-sibling::*[last()][self::LCURLY]]" />
 125         </module>
 126         <module name="WhitespaceAfter">
 127             <property name="tokens"
 128                 value="COMMA, SEMI, TYPECAST, LITERAL_IF, LITERAL_ELSE,
 129                     LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, DO_WHILE" />
 130         </module>
 131         <module name="WhitespaceAround">
 132             <property name="allowEmptyConstructors" value="true" />
 133             <property name="allowEmptyLambdas" value="true" />
 134             <property name="allowEmptyMethods" value="true" />
 135             <property name="allowEmptyTypes" value="true" />
 136             <property name="allowEmptyLoops" value="true" />
 137             <property name="tokens"
 138                 value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR,
 139                     BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND,
 140                     LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY,
 141                     LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED,
 142                      LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN,
 143                      NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR,
 144                      SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND" />
 145             <message key="ws.notFollowed"
 146                 value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)" />
 147             <message key="ws.notPreceded" value="WhitespaceAround: ''{0}'' is not preceded with whitespace." />
 148         </module>
 149         <module name="OneStatementPerLine" />
 150         <module name="MultipleVariableDeclarations" />
 151         <module name="ArrayTypeStyle" />
 152         <module name="MissingSwitchDefault" />
 153         <module name="FallThrough" />
 154         <module name="UpperEll" />
 155         <module name="ModifierOrder" />
 156         <module name="EmptyLineSeparator">
 157             <property name="tokens"
 158                 value="PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
 159                     STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF" />
 160             <property name="allowNoEmptyLineBetweenFields" value="true" />
 161         </module>
 162         <module name="SeparatorWrap">
 163             <property name="id" value="SeparatorWrapDot" />
 164             <property name="tokens" value="DOT" />
 165             <property name="option" value="nl" />
 166         </module>
 167         <module name="SeparatorWrap">
 168             <property name="id" value="SeparatorWrapComma" />
 169             <property name="tokens" value="COMMA" />
 170             <property name="option" value="EOL" />
 171         </module>
 172         <module name="SeparatorWrap">
 173             <!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/258 -->
 174             <property name="id" value="SeparatorWrapEllipsis" />
 175             <property name="tokens" value="ELLIPSIS" />
 176             <property name="option" value="EOL" />
 177         </module>
 178         <module name="SeparatorWrap">
 179             <!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/259 -->
 180             <property name="id" value="SeparatorWrapArrayDeclarator" />
 181             <property name="tokens" value="ARRAY_DECLARATOR" />
 182             <property name="option" value="EOL" />
 183         </module>
 184         <module name="SeparatorWrap">
 185             <property name="id" value="SeparatorWrapMethodRef" />
 186             <property name="tokens" value="METHOD_REF" />
 187             <property name="option" value="nl" />
 188         </module>
 189         <module name="PackageName">
 190             <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
 191             <message key="name.invalidPattern" value="Package name ''{0}'' must match pattern ''{1}''." />
 192         </module>
 193         <module name="TypeName">
 194             <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF" />
 195             <message key="name.invalidPattern" value="Type name ''{0}'' must match pattern ''{1}''." />
 196         </module>
 197         <module name="MemberName">
 198             <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$" />
 199             <message key="name.invalidPattern" value="Member name ''{0}'' must match pattern ''{1}''." />
 200         </module>
 201         <module name="ParameterName">
 202             <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$" />
 203             <message key="name.invalidPattern" value="Parameter name ''{0}'' must match pattern ''{1}''." />
 204         </module>
 205         <module name="LambdaParameterName">
 206             <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$" />
 207             <message key="name.invalidPattern" value="Lambda parameter name ''{0}'' must match pattern ''{1}''." />
 208         </module>
 209         <module name="CatchParameterName">
 210             <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$" />
 211             <message key="name.invalidPattern" value="Catch parameter name ''{0}'' must match pattern ''{1}''." />
 212         </module>
 213         <module name="LocalVariableName">
 214             <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$" />
 215             <message key="name.invalidPattern" value="Local variable name ''{0}'' must match pattern ''{1}''." />
 216         </module>
 217         <module name="ClassTypeParameterName">
 218             <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
 219             <message key="name.invalidPattern" value="Class type name ''{0}'' must match pattern ''{1}''." />
 220         </module>
 221         <module name="MethodTypeParameterName">
 222             <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
 223             <message key="name.invalidPattern" value="Method type name ''{0}'' must match pattern ''{1}''." />
 224         </module>
 225         <module name="InterfaceTypeParameterName">
 226             <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
 227             <message key="name.invalidPattern" value="Interface type name ''{0}'' must match pattern ''{1}''." />
 228         </module>
 229         <module name="NoFinalizer" />
 230         <module name="GenericWhitespace">
 231             <message key="ws.followed" value="GenericWhitespace ''{0}'' is followed by whitespace." />
 232             <message key="ws.preceded" value="GenericWhitespace ''{0}'' is preceded with whitespace." />
 233             <message key="ws.illegalFollow" value="GenericWhitespace ''{0}'' should followed by whitespace." />
 234             <message key="ws.notPreceded" value="GenericWhitespace ''{0}'' is not preceded with whitespace." />
 235         </module>
 236         <module name="Indentation">
 237             <property name="basicOffset" value="4" />
 238             <property name="braceAdjustment" value="0" />
 239             <property name="caseIndent" value="4" />
 240             <property name="throwsIndent" value="4" />
 241             <property name="lineWrappingIndentation" value="4" />
 242             <property name="arrayInitIndent" value="4" />
 243         </module>
 244         <module name="AbbreviationAsWordInName">
 245             <property name="ignoreFinal" value="false" />
 246             <property name="allowedAbbreviationLength" value="1" />
 247             <property name="tokens"
 248                 value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF,
 249                     PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF" />
 250         </module>
 251         <module name="OverloadMethodsDeclarationOrder" />
 252         <module name="VariableDeclarationUsageDistance" />
 253         <module name="CustomImportOrder">
 254             <property name="sortImportsInGroupAlphabetically" value="true" />
 255             <property name="separateLineBetweenGroups" value="true" />
 256             <property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE" />
 257             <property name="tokens" value="IMPORT, STATIC_IMPORT, PACKAGE_DEF" />
 258         </module>
 259         <module name="MethodParamPad">
 260             <property name="tokens"
 261                 value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF,
 262                     SUPER_CTOR_CALL, ENUM_CONSTANT_DEF" />
 263         </module>
 264         <module name="NoWhitespaceBefore">
 265             <property name="tokens"
 266                 value="COMMA, SEMI, POST_INC, POST_DEC, DOT, ELLIPSIS,
 267                     LABELED_STAT, METHOD_REF" />
 268             <property name="allowLineBreaks" value="true" />
 269         </module>
 270         <module name="ParenPad">
 271             <property name="tokens"
 272                 value="ANNOTATION, ANNOTATION_FIELD_DEF, CTOR_CALL, CTOR_DEF, DOT, ENUM_CONSTANT_DEF,
 273                     EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW,
 274                     LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL,
 275                     METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA" />
 276         </module>
 277         <module name="OperatorWrap">
 278             <property name="option" value="NL" />
 279             <property name="tokens"
 280                 value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,
 281                     LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF " />
 282         </module>
 283         <module name="AnnotationLocation">
 284             <property name="id" value="AnnotationLocationMostCases" />
 285             <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF" />
 286         </module>
 287         <module name="AnnotationLocation">
 288             <property name="id" value="AnnotationLocationVariables" />
 289             <property name="tokens" value="VARIABLE_DEF" />
 290             <property name="allowSamelineMultipleAnnotations" value="true" />
 291         </module>
 292         <module name="NonEmptyAtclauseDescription" />
 293         <module name="InvalidJavadocPosition" />
 294         <module name="JavadocTagContinuationIndentation" />
 295         <module name="SummaryJavadoc">
 296             <property name="forbiddenSummaryFragments"
 297                 value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )" />
 298         </module>
 299         <module name="JavadocParagraph" />
 300         <module name="AtclauseOrder">
 301             <property name="tagOrder" value="@param, @return, @throws, @deprecated" />
 302             <property name="target"
 303                 value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF" />
 304         </module>
 305         <module name="JavadocMethod">
 306             <property name="allowMissingParamTags" value="true" />
 307             <property name="allowMissingReturnTag" value="true" />
 308             <property name="allowedAnnotations" value="Override, Test" />
 309             <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF" />
 310         </module>
 311         <module name="MissingJavadocMethod">
 312             <property name="minLineCount" value="2" />
 313             <property name="allowedAnnotations" value="Override, Test" />
 314             <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF" />
 315             <property name="ignoreMethodNamesRegex" value="^(test|before|after)[a-zA-Z0-9_]*$" />
 316         </module>
 317         <module name="MethodName">
 318             <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$" />
 319             <message key="name.invalidPattern" value="Method name ''{0}'' must match pattern ''{1}''." />
 320         </module>
 321         <module name="SingleLineJavadoc">
 322             <property name="ignoreInlineTags" value="false" />
 323         </module>
 324         <module name="EmptyCatchBlock">
 325             <property name="exceptionVariableName" value="expected" />
 326         </module>
 327         <module name="CommentsIndentation">
 328             <property name="tokens" value="SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN" />
 329         </module>
 330         <!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter -->
 331         <module name="SuppressionXpathFilter">
 332             <property name="file" value="${org.checkstyle.google.suppressionxpathfilter.config}"
 333                 default="checkstyle-xpath-suppressions.xml" />
 334             <property name="optional" value="true" />
 335         </module>
 336         <module name="SuppressWarningsHolder"/>
 337     </module>
 338 </module>