google_checkstyle.xml

<?xml version="1.0"?>
<!DOCTYPEmodule PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">

<!--
 Adjusted from original Google Checkstyle config - https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml
 For details, see further comments in this file.
-->

<!--
 Checkstyle configuration that checks the Google coding conventions from Google Java Style
 that can be found at https://google.github.io/styleguide/javaguide.html.

 Checkstyle is very configurable. Be sure to read the documentation at
 http://checkstyle.sf.net (or in your downloaded distribution).

 To completely disable a check, just comment it out or delete it from the file.

 Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
-->

<modulename="Checker">
 <propertyname="charset"value="UTF-8"/>

 <propertyname="severity"value="warning"/>

 <propertyname="fileExtensions"value="java, properties, xml"/>
<!-- Checks for whitespace -->
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
 <modulename="FileTabCharacter">
 <propertyname="eachLine"value="true"/>
 </module>

 <modulename="TreeWalker">
 <modulename="OuterTypeFilename"/>
 <modulename="IllegalTokenText">
 <propertyname="tokens"value="STRING_LITERAL, CHAR_LITERAL"/>
 <propertyname="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)"/>
 <propertyname="message"value="Avoid using corresponding octal or Unicode escape."/>
 </module>
 <modulename="AvoidEscapedUnicodeCharacters">
 <propertyname="allowEscapesForControlCharacters"value="true"/>
 <propertyname="allowByTailComment"value="true"/>
 <propertyname="allowNonPrintableEscapes"value="true"/>
 </module>
 <modulename="LineLength">
 <propertyname="max"value="100"/>
 <propertyname="ignorePattern"value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
 </module>
 <modulename="AvoidStarImport"/>
 <modulename="OneTopLevelClass"/>
 <modulename="NoLineWrap"/>
 <modulename="EmptyBlock">
 <propertyname="option"value="TEXT"/>
 <propertyname="tokens"value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
 </module>
 <modulename="NeedBraces"/>
 <modulename="LeftCurly">
 <propertyname="maxLineLength"value="100"/>
 </module>
 <modulename="RightCurly"/>
 <modulename="RightCurly">
 <propertyname="option"value="alone"/>
 <propertyname="tokens"value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/>
 </module>
 <modulename="WhitespaceAround">
 <propertyname="allowEmptyConstructors"value="true"/>
 <propertyname="allowEmptyMethods"value="true"/>
 <propertyname="allowEmptyTypes"value="true"/>
 <propertyname="allowEmptyLoops"value="true"/>
 <messagekey="ws.notFollowed"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)"/>
 <messagekey="ws.notPreceded"value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
 </module>
 <modulename="OneStatementPerLine"/>
 <modulename="MultipleVariableDeclarations"/>
 <modulename="ArrayTypeStyle"/>
 <modulename="MissingSwitchDefault"/>
 <modulename="FallThrough"/>
 <modulename="UpperEll"/>
 <modulename="ModifierOrder"/>
 <modulename="EmptyLineSeparator">
 <propertyname="allowNoEmptyLineBetweenFields"value="true"/>
 </module>
 <modulename="SeparatorWrap">
 <propertyname="tokens"value="DOT"/>
 <propertyname="option"value="nl"/>
 </module>
 <modulename="SeparatorWrap">
 <propertyname="tokens"value="COMMA"/>
 <propertyname="option"value="EOL"/>
 </module>
 <modulename="PackageName">
 <propertyname="format"value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
 <messagekey="name.invalidPattern"value="Package name ''{0}'' must match pattern ''{1}''."/>
 </module>
 <modulename="TypeName">
 <messagekey="name.invalidPattern"value="Type name ''{0}'' must match pattern ''{1}''."/>
 </module>
 <modulename="MemberName">
 <propertyname="format"value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
 <messagekey="name.invalidPattern"value="Member name ''{0}'' must match pattern ''{1}''."/>
 </module>
 <modulename="ParameterName">
 <propertyname="format"value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
 <messagekey="name.invalidPattern"value="Parameter name ''{0}'' must match pattern ''{1}''."/>
 </module>
 <modulename="CatchParameterName">
 <propertyname="format"value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
 <messagekey="name.invalidPattern"value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
 </module>
 <modulename="LocalVariableName">
 <propertyname="tokens"value="VARIABLE_DEF"/>
 <propertyname="format"value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
 <propertyname="allowOneCharVarInForLoop"value="true"/>
 <messagekey="name.invalidPattern"value="Local variable name ''{0}'' must match pattern ''{1}''."/>
 </module>
 <modulename="ClassTypeParameterName">
 <propertyname="format"value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
 <messagekey="name.invalidPattern"value="Class type name ''{0}'' must match pattern ''{1}''."/>
 </module>
 <modulename="MethodTypeParameterName">
 <propertyname="format"value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
 <messagekey="name.invalidPattern"value="Method type name ''{0}'' must match pattern ''{1}''."/>
 </module>
 <modulename="InterfaceTypeParameterName">
 <propertyname="format"value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
 <messagekey="name.invalidPattern"value="Interface type name ''{0}'' must match pattern ''{1}''."/>
 </module>
 <modulename="NoFinalizer"/>
 <modulename="GenericWhitespace">
 <messagekey="ws.followed"value="GenericWhitespace ''{0}'' is followed by whitespace."/>
 <messagekey="ws.preceded"value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
 <messagekey="ws.illegalFollow"value="GenericWhitespace ''{0}'' should followed by whitespace."/>
 <messagekey="ws.notPreceded"value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
 </module>
 <modulename="Indentation">
<!-- Modified defaults for swagger-codegen (multiplied Google by 2)-->
 <propertyname="basicOffset"value="4"/>
 <propertyname="braceAdjustment"value="0"/>
 <propertyname="caseIndent"value="4"/>
 <propertyname="throwsIndent"value="8"/>
 <propertyname="lineWrappingIndentation"value="8"/>
 <propertyname="arrayInitIndent"value="4"/>
<!-- Actual Google Java Style defaults -->
<!--
 <property name="basicOffset" value="2"/>
 <property name="braceAdjustment" value="0"/>
 <property name="caseIndent" value="2"/>
 <property name="throwsIndent" value="4"/>
 <property name="lineWrappingIndentation" value="4"/>
 <property name="arrayInitIndent" value="2"/>
-->
 </module>
 <modulename="AbbreviationAsWordInName">
 <propertyname="ignoreFinal"value="false"/>
 <propertyname="allowedAbbreviationLength"value="1"/>
 </module>
 <modulename="OverloadMethodsDeclarationOrder"/>
 <modulename="VariableDeclarationUsageDistance"/>
 <modulename="CustomImportOrder">
 <propertyname="specialImportsRegExp"value="com.google"/>
 <propertyname="sortImportsInGroupAlphabetically"value="true"/>
 <propertyname="customImportOrderRules"value="STATIC###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE"/>
 </module>
 <modulename="MethodParamPad"/>
 <modulename="OperatorWrap">
 <propertyname="option"value="NL"/>
 <propertyname="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 "/>
 </module>
 <modulename="AnnotationLocation">
 <propertyname="tokens"value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
 </module>
 <modulename="AnnotationLocation">
 <propertyname="tokens"value="VARIABLE_DEF"/>
 <propertyname="allowSamelineMultipleAnnotations"value="true"/>
 </module>
 <modulename="NonEmptyAtclauseDescription"/>
 <modulename="JavadocTagContinuationIndentation"/>
 <modulename="SummaryJavadoc">
 <propertyname="forbiddenSummaryFragments"value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
 </module>
 <modulename="JavadocParagraph"/>
 <modulename="AtclauseOrder">
 <propertyname="tagOrder"value="@param, @return, @throws, @deprecated"/>
 <propertyname="target"value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
 </module>
 <modulename="JavadocMethod">
 <propertyname="scope"value="public"/>
 <propertyname="allowMissingParamTags"value="true"/>
 <propertyname="allowMissingThrowsTags"value="true"/>
 <propertyname="allowMissingReturnTag"value="true"/>
 <propertyname="minLineCount"value="2"/>
 <propertyname="allowedAnnotations"value="Override, Test"/>
 <propertyname="allowThrowsTagsForSubclasses"value="true"/>
 </module>
 <modulename="MethodName">
 <propertyname="format"value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
 <messagekey="name.invalidPattern"value="Method name ''{0}'' must match pattern ''{1}''."/>
 </module>
 <modulename="SingleLineJavadoc">
 <propertyname="ignoreInlineTags"value="false"/>
 </module>
 <modulename="EmptyCatchBlock">
 <propertyname="exceptionVariableName"value="expected"/>
 </module>
 <modulename="CommentsIndentation"/>
 </module>
</module>