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="warning"/>
  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="OuterTypeFilename"/>
  40         <module name="IllegalTokenText">
  41             <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
  42             <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)"/>
  43             <property name="message" value="Avoid using corresponding octal or Unicode escape."/>
  44         </module>
  45     <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
  46         <module name="AvoidEscapedUnicodeCharacters">
  47             <property name="allowEscapesForControlCharacters" value="true"/>
  48             <property name="allowByTailComment" value="true"/>
  49             <property name="allowNonPrintableEscapes" value="true"/>
  50         </module>
  51     -->
  52         <module name="LineLength">
  53             <property name="max" value="120"/><!-- ODL projects use 120 max line length -->
  54             <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
  55         </module>
  56         <module name="AvoidStarImport"/>
  57     <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
  58         <module name="OneTopLevelClass"/>
  59         <module name="NoLineWrap"/>
  60     -->
  61         <module name="EmptyBlock">
  62             <property name="option" value="TEXT"/>
  63             <property name="tokens" value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
  64         </module>
  65         <module name="NeedBraces"/>
  66         <module name="LeftCurly">
  67             <property name="maxLineLength" value="100"/>
  68         </module>
  69         <module name="RightCurly"/>
  70         <module name="RightCurly">
  71             <property name="option" value="alone"/>
  72             <property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/>
  73         </module>
  74         <module name="WhitespaceAround">
  75             <property name="allowEmptyConstructors" value="true"/>
  76             <property name="allowEmptyMethods" value="true"/>
  77         <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
  78             <property name="allowEmptyTypes" value="true"/>
  79             <property name="allowEmptyLoops" value="true"/>
  80         -->
  81             <message key="ws.notFollowed"
  82              value="WhitespaceAround: ''{0}'' is not followed by whitespace."/>
  83              <message key="ws.notPreceded"
  84              value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
  85         </module>
  86         <module name="OneStatementPerLine"/>
  87         <module name="MultipleVariableDeclarations"/>
  88         <module name="ArrayTypeStyle"/>
  89         <module name="MissingSwitchDefault"/>
  90         <module name="FallThrough"/>
  91         <module name="UpperEll"/>
  92         <module name="ModifierOrder"/>
  93     <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
  94         <module name="EmptyLineSeparator">
  95             <property name="allowNoEmptyLineBetweenFields" value="true"/>
  96         </module>
  97         <module name="SeparatorWrap">
  98             <property name="tokens" value="DOT"/>
  99             <property name="option" value="nl"/>
 100         </module>
 101         <module name="SeparatorWrap">
 102             <property name="tokens" value="COMMA"/>
 103             <property name="option" value="EOL"/>
 104         </module>
 105     -->
 106         <module name="PackageName">
 107             <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
 108             <message key="name.invalidPattern"
 109              value="Package name ''{0}'' must match pattern ''{1}''."/>
 110         </module>
 111         <module name="TypeName">
 112             <message key="name.invalidPattern"
 113              value="Type name ''{0}'' must match pattern ''{1}''."/>
 114         </module>
 115         <module name="MemberName">
 116             <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
 117             <message key="name.invalidPattern"
 118              value="Member name ''{0}'' must match pattern ''{1}''."/>
 119         </module>
 120         <module name="ParameterName">
 121             <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
 122             <message key="name.invalidPattern"
 123              value="Parameter name ''{0}'' must match pattern ''{1}''."/>
 124         </module>
 125         <module name="LocalVariableName">
 126             <property name="tokens" value="VARIABLE_DEF"/>
 127             <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
 128         <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
 129             <property name="allowOneCharVarInForLoop" value="true"/>
 130         -->
 131             <message key="name.invalidPattern"
 132              value="Local variable name ''{0}'' must match pattern ''{1}''."/>
 133         </module>
 134         <module name="ClassTypeParameterName">
 135             <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
 136             <message key="name.invalidPattern"
 137              value="Class type name ''{0}'' must match pattern ''{1}''."/>
 138         </module>
 139         <module name="MethodTypeParameterName">
 140             <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
 141             <message key="name.invalidPattern"
 142              value="Method type name ''{0}'' must match pattern ''{1}''."/>
 143         </module>
 144         <module name="NoFinalizer"/>
 145         <module name="GenericWhitespace">
 146             <message key="ws.followed"
 147              value="GenericWhitespace ''{0}'' is followed by whitespace."/>
 148              <message key="ws.preceded"
 149              value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
 150              <message key="ws.illegalFollow"
 151              value="GenericWhitespace ''{0}'' should followed by whitespace."/>
 152              <message key="ws.notPreceded"
 153              value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
 154         </module>
 155         <module name="Indentation">
 156             <property name="basicOffset" value="4"/>
 157             <property name="braceAdjustment" value="0"/>
 158             <property name="caseIndent" value="4"/>
 159             <property name="throwsIndent" value="4"/>
 160         <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
 161             <property name="lineWrappingIndentation" value="4"/>
 162             <property name="arrayInitIndent" value="4"/>
 163         -->
 164         </module>
 165     <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
 166         <module name="AbbreviationAsWordInName">
 167             <property name="ignoreFinal" value="false"/>
 168             <property name="allowedAbbreviationLength" value="1"/>
 169         </module>
 170         <module name="OverloadMethodsDeclarationOrder"/>
 171         <module name="VariableDeclarationUsageDistance"/>
 172         <module name="CustomImportOrder">
 173             <property name="thirdPartyPackageRegExp" value=".*"/>
 174             <property name="specialImportsRegExp" value="com.google"/>
 175             <property name="sortImportsInGroupAlphabetically" value="true"/>
 176             <property name="customImportOrderRules" value="STATIC###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE"/>
 177         </module>
 178     -->
 179         <module name="MethodParamPad"/>
 180         <module name="OperatorWrap">
 181             <property name="option" value="NL"/>
 182             <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 "/>
 183         </module>
 184     <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
 185         <module name="AnnotationLocation">
 186             <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
 187         </module>
 188         <module name="AnnotationLocation">
 189             <property name="tokens" value="VARIABLE_DEF"/>
 190             <property name="allowSamelineMultipleAnnotations" value="true"/>
 191         </module>
 192         <module name="NonEmptyAtclauseDescription"/>
 193         <module name="JavadocTagContinuationIndentation"/>
 194         <module name="SummaryJavadocCheck">
 195             <property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
 196         </module>
 197         <module name="JavadocParagraph"/>
 198         <module name="AtclauseOrder">
 199             <property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
 200             <property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
 201         </module>
 202     -->
 203         <!--sh<module name="JavadocMethod">
 204             <property name="scope" value="public"/>
 205             <property name="allowMissingParamTags" value="true"/>
 206             <property name="allowMissingThrowsTags" value="true"/>
 207             <property name="allowMissingReturnTag" value="true"/>sh-->
 208         <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
 209             <property name="minLineCount" value="2"/>
 210             <property name="allowedAnnotations" value="Override, Test"/>
 211         -->
 212             <!--sh<property name="allowThrowsTagsForSubclasses" value="true"/>
 213         </module>-->
 214         <module name="MethodName">
 215             <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
 216             <message key="name.invalidPattern"
 217              value="Method name ''{0}'' must match pattern ''{1}''."/>
 218         </module>
 219     <!-- Not yet supported https://jira.codehaus.org/browse/MCHECKSTYLE-261
 220         <module name="SingleLineJavadoc"/>
 221     -->
 222
 223     </module>
 224
 225     <!--<module name="RegexpHeader">
 226         <property name="headerFile" value="${checkstyle.header.file}"/>
 227         <property name="multiLines" value="2"/>
 228     </module>-->
 229 </module>