123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357 |
- <?xml version="1.0"?>
- <!DOCTYPE module PUBLIC
- "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
- "https://checkstyle.org/dtds/configuration_1_3.dtd">
- <module name = "Checker">
- <property name="charset" value="UTF-8"/>
- <property name="severity" value="error"/>
- <property name="fileExtensions" value="java"/>
- <!-- See https://checkstyle.org/config_filefilters.html -->
- <module name="BeforeExecutionExclusionFileFilter">
- <property name="fileNamePattern" value=".*dataobject |.*Test.*$"/>
- </module>
- <module name="TreeWalker">
- <module name="EmptyLineSeparator">
- <property name="allowMultipleEmptyLines" value="false"/>
- <property name="tokens" value="METHOD_DEF"/>
- </module>
- </module>
- <module name="SuppressionFilter">
- <property name="file" value="check/checkstyle/suppressions.xml"/>
- <property name="optional" value="true"/>
- </module>
- <module name="SuppressWithPlainTextCommentFilter">
- <property name="offCommentFormat" value="CHECKSTYLE OFF"/>
- <property name="onCommentFormat" value="CHECKSTYLE ON"/>
- </module>
- <module name="FileTabCharacter">
- <property name="eachLine" value="true"/>
- </module>
- <module name="LineLength">
- <property name="fileExtensions" value="java"/>
- <property name="max" value="150"/>
- <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
- </module>
- <module name="RegexpSingleline">
- <property name="format" value="<<<<<<<"/>
- <property name="message" value="Merge conflicts unresolved."/>
- </module>
- <module name="RegexpSingleline">
- <property name="format" value="\s+$"/>
- <property name="message" value="Trailing whitespace found."/>
- <property name="fileExtensions" value=".java"/>
- </module>
- <module name="TreeWalker">
- <!-- filter -->
- <module name="SuppressWithNearbyCommentFilter">
- <property name="commentFormat" value="CHECKSTYLE IGNORE THIS LINE"/>
- </module>
- <!-- Annotations -->
- <module name="AnnotationLocation">
- <property name="id" value="AnnotationLocationMostCases"/>
- <property name="tokens"
- value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF,
- RECORD_DEF, COMPACT_CTOR_DEF"/>
- </module>
- <module name="AnnotationLocation">
- <property name="id" value="AnnotationLocationVariables"/>
- <property name="tokens" value="VARIABLE_DEF"/>
- <property name="allowSamelineMultipleAnnotations" value="true"/>
- </module>
- <module name="MissingOverride"/>
- <!-- Block Checks -->
- <module name="EmptyBlock">
- <property name="option" value="TEXT"/>
- <property name="tokens"
- value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
- </module>
- <module name="EmptyCatchBlock">
- <property name="exceptionVariableName" value="expected"/>
- </module>
- <module name="NeedBraces">
- <property name="tokens"
- value="LITERAL_DO, LITERAL_ELSE, LITERAL_FOR, LITERAL_IF, LITERAL_WHILE"/>
- </module>
- <module name="LeftCurly">
- <property name="tokens"
- value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF,
- INTERFACE_DEF, LAMBDA, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT,
- LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF,
- LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF,
- OBJBLOCK, STATIC_INIT, RECORD_DEF, COMPACT_CTOR_DEF"/>
- </module>
- <module name="RightCurly">
- <property name="id" value="RightCurlySame"/>
- <property name="tokens"
- value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE,
- LITERAL_DO"/>
- </module>
- <module name="RightCurly">
- <property name="id" value="RightCurlyAlone"/>
- <property name="option" value="alone"/>
- <property name="tokens"
- value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,
- INSTANCE_INIT, ANNOTATION_DEF, ENUM_DEF, INTERFACE_DEF, RECORD_DEF,
- COMPACT_CTOR_DEF"/>
- </module>
- <module name="SuppressionXpathSingleFilter">
- <!-- suppresion is required till https://github.com/checkstyle/checkstyle/issues/7541 -->
- <property name="id" value="RightCurlyAlone"/>
- <property name="query" value="//RCURLY[parent::SLIST[count(./*)=1]
- or preceding-sibling::*[last()][self::LCURLY]]"/>
- </module>
- <!-- Class Design -->
- <module name="OneTopLevelClass"/>
- <!-- Coding -->
- <!-- <module name="DeclarationOrder"/>-->
- <module name="FallThrough"/>
- <module name="IllegalTokenText">
- <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
- <property name="format"
- 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)"/>
- <property name="message"
- value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
- </module>
- <module name="MissingSwitchDefault"/>
- <module name="MultipleVariableDeclarations"/>
- <module name="NoFinalizer"/>
- <module name="OneStatementPerLine"/>
- <module name="OverloadMethodsDeclarationOrder"/>
- <module name="StringLiteralEquality"/>
- <module name="UnusedLocalVariable"/>
- <!-- Headers -->
- <!-- Imports -->
- <module name="AvoidStarImport"/>
- <module name="RedundantImport"/>
- <module name="UnusedImports"/>
- <module name="EmptyStatement"/>
- <!-- Disallow the use of commons-lang -->
- <module name="Regexp">
- <property name="format" value="org\.apache\.commons\.lang\."/>
- <property name="illegalPattern" value="true"/>
- <property name="message" value="Use commons-lang3 instead of commons-lang."/>
- </module>
- <!-- Metrics -->
- <!-- Miscellaneous -->
- <module name="ArrayTypeStyle"/>
- <module name="AvoidEscapedUnicodeCharacters">
- <property name="allowEscapesForControlCharacters" value="true"/>
- <property name="allowByTailComment" value="true"/>
- <property name="allowNonPrintableEscapes" value="true"/>
- </module>
- <module name="CommentsIndentation">
- <property name="tokens" value="SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN"/>
- </module>
- <!-- <module name="Indentation">-->
- <!-- <property name="basicOffset" value="4"/>-->
- <!-- <property name="braceAdjustment" value="0"/>-->
- <!-- <property name="caseIndent" value="4"/>-->
- <!-- <property name="throwsIndent" value="4"/>-->
- <!-- <property name="lineWrappingIndentation" value="4"/>-->
- <!-- <property name="arrayInitIndent" value="4"/>-->
- <!-- </module>-->
- <module name="OuterTypeFilename"/>
- <module name="UpperEll"/>
- <!-- Modifiers -->
- <module name="ModifierOrder"/>
- <!-- Naming Conventions -->
- <module name="AbbreviationAsWordInName">
- <property name="ignoreFinal" value="false"/>
- <property name="allowedAbbreviationLength" value="4"/>
- <property name="tokens"
- value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF,
- PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, PATTERN_VARIABLE_DEF, RECORD_DEF,
- RECORD_COMPONENT_DEF"/>
- </module>
- <module name="CatchParameterName">
- <property name="format" value="^([a-z0-9][a-zA-Z0-9]*)?$"/>
- <message key="name.invalidPattern"
- value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
- </module>
- <module name="ClassTypeParameterName">
- <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*$)"/>
- <message key="name.invalidPattern"
- value="Class type name ''{0}'' must match pattern ''{1}''."/>
- </module>
- <module name="InterfaceTypeParameterName">
- <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*$)"/>
- <message key="name.invalidPattern"
- value="Interface type name ''{0}'' must match pattern ''{1}''."/>
- </module>
- <module name="LambdaParameterName">
- <property name="format" value="^([a-z][a-zA-Z0-9]*)?$"/>
- <message key="name.invalidPattern"
- value="Lambda parameter name ''{0}'' must match pattern ''{1}''."/>
- </module>
- <module name="LocalVariableName">
- <property name="format" value="^([a-z0-9][a-zA-Z0-9]*)?$"/>
- <message key="name.invalidPattern"
- value="Local variable name ''{0}'' must match pattern ''{1}''."/>
- </module>
- <module name="MemberName">
- <property name="format" value="^([a-z][a-zA-Z0-9]*)?$"/>
- <message key="name.invalidPattern"
- value="Member name ''{0}'' must match pattern ''{1}''."/>
- </module>
- <module name="MethodName">
- <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
- <message key="name.invalidPattern"
- value="Method name ''{0}'' must match pattern ''{1}''."/>
- </module>
- <module name="MethodTypeParameterName">
- <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*$)"/>
- <message key="name.invalidPattern"
- value="Method type name ''{0}'' must match pattern ''{1}''."/>
- </module>
- <module name="PackageName">
- <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
- <message key="name.invalidPattern"
- value="Package name ''{0}'' must match pattern ''{1}''."/>
- </module>
- <module name="ParameterName">
- <property name="format" value="^([a-z0-9][a-zA-Z0-9]*)?$"/>
- <message key="name.invalidPattern"
- value="Parameter name ''{0}'' must match pattern ''{1}''."/>
- </module>
- <module name="PatternVariableName">
- <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
- <message key="name.invalidPattern"
- value="Pattern variable name ''{0}'' must match pattern ''{1}''."/>
- </module>
- <module name="RecordComponentName">
- <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
- <message key="name.invalidPattern"
- value="Record component name ''{0}'' must match pattern ''{1}''."/>
- </module>
- <module name="RecordTypeParameterName">
- <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*$)"/>
- <message key="name.invalidPattern"
- value="Record type name ''{0}'' must match pattern ''{1}''."/>
- </module>
- <module name="TypeName">
- <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
- ANNOTATION_DEF, RECORD_DEF"/>
- <message key="name.invalidPattern"
- value="Type name ''{0}'' must match pattern ''{1}''."/>
- </module>
- <!-- Regexp -->
- <!-- Size Violations -->
- <!-- Whitespace -->
- <module name="GenericWhitespace">
- <message key="ws.followed"
- value="GenericWhitespace ''{0}'' is followed by whitespace."/>
- <message key="ws.preceded"
- value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
- <message key="ws.illegalFollow"
- value="GenericWhitespace ''{0}'' should followed by whitespace."/>
- <message key="ws.notPreceded"
- value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
- </module>
- <module name="MethodParamPad">
- <property name="tokens"
- value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF,
- SUPER_CTOR_CALL, ENUM_CONSTANT_DEF, RECORD_DEF"/>
- </module>
- <module name="NoLineWrap">
- <property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT"/>
- </module>
- <module name="NoWhitespaceBefore">
- <property name="tokens"
- value="COMMA, SEMI, POST_INC, POST_DEC, DOT,
- LABELED_STAT, METHOD_REF"/>
- <property name="allowLineBreaks" value="true"/>
- </module>
- <module name="NoWhitespaceBeforeCaseDefaultColon"/>
- <module name="OperatorWrap">
- <property name="option" value="NL"/>
- <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, METHOD_REF,
- TYPE_EXTENSION_AND "/>
- </module>
- <module name="ParenPad">
- <property name="tokens"
- value="ANNOTATION, ANNOTATION_FIELD_DEF, CTOR_CALL, CTOR_DEF, DOT, ENUM_CONSTANT_DEF,
- EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW,
- LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL,
- METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA,
- RECORD_DEF"/>
- </module>
- <module name="SeparatorWrap">
- <property name="id" value="SeparatorWrapDot"/>
- <property name="tokens" value="DOT"/>
- <property name="option" value="nl"/>
- </module>
- <module name="SeparatorWrap">
- <property name="id" value="SeparatorWrapComma"/>
- <property name="tokens" value="COMMA"/>
- <property name="option" value="EOL"/>
- </module>
- <module name="SeparatorWrap">
- <!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/259 -->
- <property name="id" value="SeparatorWrapEllipsis"/>
- <property name="tokens" value="ELLIPSIS"/>
- <property name="option" value="EOL"/>
- </module>
- <module name="SeparatorWrap">
- <!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/258 -->
- <property name="id" value="SeparatorWrapArrayDeclarator"/>
- <property name="tokens" value="ARRAY_DECLARATOR"/>
- <property name="option" value="EOL"/>
- </module>
- <module name="SeparatorWrap">
- <property name="id" value="SeparatorWrapMethodRef"/>
- <property name="tokens" value="METHOD_REF"/>
- <property name="option" value="nl"/>
- </module>
- <module name="SingleSpaceSeparator"/>
- <module name="WhitespaceAfter">
- <property name="tokens"
- value="COMMA, SEMI, TYPECAST, LITERAL_IF, LITERAL_ELSE,
- LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, DO_WHILE"/>
- </module>
- <module name="WhitespaceAround">
- <property name="allowEmptyConstructors" value="true"/>
- <property name="allowEmptyLambdas" value="true"/>
- <property name="allowEmptyMethods" value="true"/>
- <property name="allowEmptyTypes" value="true"/>
- <property name="allowEmptyLoops" value="true"/>
- <property name="ignoreEnhancedForColon" value="false"/>
- <property name="tokens"
- value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR,
- BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND,
- LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY,
- LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED,
- LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN,
- NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR,
- SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND"/>
- <message key="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)"/>
- <message key="ws.notPreceded"
- value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
- </module>
- <!-- filter -->
- <!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter -->
- <module name="SuppressionXpathFilter">
- <property name="file" value="${org.checkstyle.google.suppressionxpathfilter.config}"
- default="checkstyle-xpath-suppressions.xml" />
- <property name="optional" value="true"/>
- </module>
- </module>
- </module>
|