commons/parent/src/main/resources/ovsdb_checks.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE module PUBLIC
   3           "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
   4           "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
   5
   6 <!--
   7
   8     Checkstyle configuration that checks the Google coding conventions from:
   9
  10     -  Google Java Style
  11        https://google-styleguide.googlecode.com/svn-history/r130/trunk/javaguide.html
  12
  13     Checkstyle is very configurable. Be sure to read the documentation at
  14     http://checkstyle.sf.net (or in your downloaded distribution).
  15
  16     Most Checks are configurable, be sure to consult the documentation.
  17
  18     To completely disable a check, just comment it out or delete it from the file.
  19
  20     Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
  21
  22  -->
  23
  24 <module name = "Checker">
  25     <property name="charset" value="UTF-8"/>
  26     <!-- Change to error to fail the build. Having severity here
  27          ignores the FailsOnError setting in the pom.xml -->
  28     <property name="severity" value="error"/>
  29
  30     <!-- Checks for whitespace                               -->
  31     <!-- See http://checkstyle.sf.net/config_whitespace.html -->
  32         <module name="FileTabCharacter">
  33             <property name="eachLine" value="true"/>
  34         </module>
  35
  36     <module name="SuppressWarningsFilter"/>
  37     <module name="TreeWalker">
  38         <module name="SuppressWarningsHolder"/>
  39         <module name="UnusedImports"/>
  40         <module name="OuterTypeFilename"/>
  41         <module name="IllegalTokenText">
  42             <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
  43             <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)"/>
  44             <property name="message" value="Avoid using corresponding octal or Unicode escape."/>
  45         </module>
  46     <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
  47         <module name="AvoidEscapedUnicodeCharacters">
  48             <property name="allowEscapesForControlCharacters" value="true"/>
  49             <property name="allowByTailComment" value="true"/>
  50             <property name="allowNonPrintableEscapes" value="true"/>
  51         </module>
  52     -->
  53         <module name="LineLength">
  54             <property name="max" value="120"/><!-- ODL projects use 120 max line length -->
  55             <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
  56         </module>
  57         <module name="AvoidStarImport"/>
  58     <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
  59         <module name="OneTopLevelClass"/>
  60         <module name="NoLineWrap"/>
  61     -->
  62         <module name="EmptyBlock">
  63             <property name="option" value="TEXT"/>
  64             <property name="tokens" value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
  65         </module>
  66         <module name="NeedBraces"/>
  67         <module name="LeftCurly">
  68             <property name="maxLineLength" value="100"/>
  69         </module>
  70         <module name="RightCurly"/>
  71         <module name="RightCurly">
  72             <property name="option" value="alone"/>
  73             <property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/>
  74         </module>
  75         <module name="WhitespaceAround">
  76             <property name="allowEmptyConstructors" value="true"/>
  77             <property name="allowEmptyMethods" value="true"/>
  78         <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
  79             <property name="allowEmptyTypes" value="true"/>
  80             <property name="allowEmptyLoops" value="true"/>
  81         -->
  82             <message key="ws.notFollowed"
  83              value="WhitespaceAround: ''{0}'' is not followed by whitespace."/>
  84              <message key="ws.notPreceded"
  85              value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
  86         </module>
  87         <module name="OneStatementPerLine"/>
  88         <module name="MultipleVariableDeclarations"/>
  89         <module name="ArrayTypeStyle"/>
  90         <module name="MissingSwitchDefault"/>
  91         <module name="FallThrough"/>
  92         <module name="UpperEll"/>
  93         <module name="ModifierOrder"/>
  94     <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
  95         <module name="EmptyLineSeparator">
  96             <property name="allowNoEmptyLineBetweenFields" value="true"/>
  97         </module>
  98         <module name="SeparatorWrap">
  99             <property name="tokens" value="DOT"/>
 100             <property name="option" value="nl"/>
 101         </module>
 102         <module name="SeparatorWrap">
 103             <property name="tokens" value="COMMA"/>
 104             <property name="option" value="EOL"/>
 105         </module>
 106     -->
 107         <module name="PackageName">
 108             <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
 109             <message key="name.invalidPattern"
 110              value="Package name ''{0}'' must match pattern ''{1}''."/>
 111         </module>
 112         <module name="TypeName">
 113             <message key="name.invalidPattern"
 114              value="Type name ''{0}'' must match pattern ''{1}''."/>
 115         </module>
 116         <module name="MemberName">
 117             <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
 118             <message key="name.invalidPattern"
 119              value="Member name ''{0}'' must match pattern ''{1}''."/>
 120         </module>
 121         <module name="ParameterName">
 122             <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
 123             <message key="name.invalidPattern"
 124              value="Parameter name ''{0}'' must match pattern ''{1}''."/>
 125         </module>
 126         <module name="LocalVariableName">
 127             <property name="tokens" value="VARIABLE_DEF"/>
 128             <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
 129         <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
 130             <property name="allowOneCharVarInForLoop" value="true"/>
 131         -->
 132             <message key="name.invalidPattern"
 133              value="Local variable name ''{0}'' must match pattern ''{1}''."/>
 134         </module>
 135         <module name="ClassTypeParameterName">
 136             <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
 137             <message key="name.invalidPattern"
 138              value="Class type name ''{0}'' must match pattern ''{1}''."/>
 139         </module>
 140         <module name="MethodTypeParameterName">
 141             <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
 142             <message key="name.invalidPattern"
 143              value="Method type name ''{0}'' must match pattern ''{1}''."/>
 144         </module>
 145         <module name="NoFinalizer"/>
 146         <module name="GenericWhitespace">
 147             <message key="ws.followed"
 148              value="GenericWhitespace ''{0}'' is followed by whitespace."/>
 149              <message key="ws.preceded"
 150              value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
 151              <message key="ws.illegalFollow"
 152              value="GenericWhitespace ''{0}'' should followed by whitespace."/>
 153              <message key="ws.notPreceded"
 154              value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
 155         </module>
 156         <module name="Indentation">
 157             <property name="basicOffset" value="4"/>
 158             <property name="braceAdjustment" value="0"/>
 159             <property name="caseIndent" value="4"/>
 160             <property name="throwsIndent" value="4"/>
 161         <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
 162             <property name="lineWrappingIndentation" value="4"/>
 163             <property name="arrayInitIndent" value="4"/>
 164         -->
 165         </module>
 166     <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
 167         <module name="AbbreviationAsWordInName">
 168             <property name="ignoreFinal" value="false"/>
 169             <property name="allowedAbbreviationLength" value="1"/>
 170         </module>
 171         <module name="OverloadMethodsDeclarationOrder"/>
 172         <module name="VariableDeclarationUsageDistance"/>
 173         <module name="CustomImportOrder">
 174             <property name="thirdPartyPackageRegExp" value=".*"/>
 175             <property name="specialImportsRegExp" value="com.google"/>
 176             <property name="sortImportsInGroupAlphabetically" value="true"/>
 177             <property name="customImportOrderRules" value="STATIC###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE"/>
 178         </module>
 179     -->
 180         <module name="MethodParamPad"/>
 181         <module name="OperatorWrap">
 182             <property name="option" value="NL"/>
 183             <property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR "/>
 184         </module>
 185     <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
 186         <module name="AnnotationLocation">
 187             <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
 188         </module>
 189         <module name="AnnotationLocation">
 190             <property name="tokens" value="VARIABLE_DEF"/>
 191             <property name="allowSamelineMultipleAnnotations" value="true"/>
 192         </module>
 193         <module name="NonEmptyAtclauseDescription"/>
 194         <module name="JavadocTagContinuationIndentation"/>
 195         <module name="SummaryJavadocCheck">
 196             <property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
 197         </module>
 198         <module name="JavadocParagraph"/>
 199         <module name="AtclauseOrder">
 200             <property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
 201             <property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
 202         </module>
 203     -->
 204         <!--sh<module name="JavadocMethod">
 205             <property name="scope" value="public"/>
 206             <property name="allowMissingParamTags" value="true"/>
 207             <property name="allowMissingThrowsTags" value="true"/>
 208             <property name="allowMissingReturnTag" value="true"/>sh-->
 209         <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
 210             <property name="minLineCount" value="2"/>
 211             <property name="allowedAnnotations" value="Override, Test"/>
 212         -->
 213             <!--sh<property name="allowThrowsTagsForSubclasses" value="true"/>
 214         </module>-->
 215         <module name="MethodName">
 216             <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
 217             <message key="name.invalidPattern"
 218              value="Method name ''{0}'' must match pattern ''{1}''."/>
 219         </module>
 220     <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
 221         <module name="SingleLineJavadoc"/>
 222     -->
 223
 224     </module>
 225
 226     <!--<module name="RegexpHeader">
 227         <property name="headerFile" value="${checkstyle.header.file}"/>
 228         <property name="multiLines" value="2"/>
 229     </module>-->
 230 </module>