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