<!--
Checkstyle modules
- for Checkstyle 8.18 or later
+ for Checkstyle 8.45 or later
[ https://checkstyle.org/ ]
- Copyright(c) 2010 olyutorskii
+ Copyright(c) 2019 olyutorskii
-->
<property name="localeCountry" value="JP" />
<property name="localeLanguage" value="en" />
<!--property name="localeLanguage" value="ja" /-->
- <property name="fileExtensions" value="java, xml, properties" />
+ <property name="fileExtensions" value="java, properties, xml, xsd, md, txt" />
<property name="severity" value="error" />
<!-- Filters -->
+
<module name="SeverityMatchFilter" />
<!--module name="SuppressionFilter" /-->
+ <!--module name="SuppressionSingleFilter" /-->
<module name="SuppressWarningsFilter" />
<module name="SuppressWithPlainTextCommentFilter" />
<!-- Headers -->
+
<module name="Header">
<property name="header" value="<?xml version="1.0" encoding="UTF-8" ?>" />
<property name="fileExtensions" value="xml" />
<!-- Javadoc Comments -->
+
<module name="JavadocPackage" />
<!-- Miscellaneous -->
+
<module name="NewlineAtEndOfFile">
- <property name="fileExtensions" value="java" />
+ <property name="fileExtensions" value="java, properties, xml, xsd, md, txt" />
</module>
+ <module name="OrderedProperties" />
<module name="Translation" />
<module name="UniqueProperties" />
<!-- Regexp -->
+
<module name="RegexpMultiline">
<property name="format" value="[\u000b\f\u001a]" />
</module>
<!-- Size Violations -->
- <module name="FileLength">
- <property name="max" value="2000"/>
+
+ <module name="FileLength" />
+ <module name="LineLength">
+ <property name="fileExtensions" value="java" />
+ <property name="max" value="100" />
</module>
<!-- Whitespace -->
+
<module name="FileTabCharacter" />
<module name="InterfaceIsType" />
<module name="MutableException" />
<module name="OneTopLevelClass" />
- <module name="ThrowsCount">
- <property name="max" value="4" />
- </module>
+ <module name="ThrowsCount" />
<module name="VisibilityModifier" />
<!-- Coding -->
<module name="ArrayTrailingComma" />
+ <module name="AvoidDoubleBraceInitialization" />
<module name="AvoidInlineConditionals" />
+ <module name="AvoidNoArgumentSuperConstructorCall" />
<module name="CovariantEquals" />
<module name="DeclarationOrder" />
<module name="DefaultComesLast" />
<module name="IllegalToken">
<property name="tokens" value="LITERAL_NATIVE" />
</module>
- <module name="IllegalTokenText">
- <property name="tokens" value="NUM_INT, NUM_LONG" />
- <property name="format" value="^0_*[0-7]" />
- <property name="message" value="inhibit octal number" />
- </module>
+ <module name="IllegalTokenText" />
<module name="IllegalType" />
<module name="InnerAssignment" />
<module name="MagicNumber" />
+ <module name="MatchXpath" />
<module name="MissingCtor" />
<module name="MissingSwitchDefault" />
<module name="ModifiedControlVariable" />
<module name="NestedForDepth" />
<module name="NestedIfDepth" />
<module name="NestedTryDepth" />
+ <module name="NoArrayTrailingComma" />
<module name="NoClone" />
+ <module name="NoEnumTrailingComma" />
<module name="NoFinalizer" />
<module name="OneStatementPerLine" />
<module name="OverloadMethodsDeclarationOrder" />
<module name="ParameterAssignment" />
<module name="RequireThis">
<property name="checkMethods" value="false" />
+ <property name="validateOnlyOverlapping" value="false" />
</module>
- <module name="ReturnCount">
- <property name="max" value="5" />
- </module>
+ <module name="ReturnCount" />
<module name="SimplifyBooleanExpression" />
<module name="SimplifyBooleanReturn" />
<module name="StringLiteralEquality" />
<module name="SuperClone" />
<module name="SuperFinalize" />
<module name="UnnecessaryParentheses" />
- <module name="VariableDeclarationUsageDistance">
- <property name="allowedDistance" value="5" />
- </module>
+ <module name="UnnecessarySemicolonAfterOuterTypeDeclaration" />
+ <module name="UnnecessarySemicolonAfterTypeMemberDeclaration" />
+ <module name="UnnecessarySemicolonInEnumeration" />
+ <module name="UnnecessarySemicolonInTryWithResources" />
+ <module name="VariableDeclarationUsageDistance" />
<!-- Imports -->
<!-- Javadoc Comments -->
<module name="AtclauseOrder" />
+ <module name="InvalidJavadocPosition" />
+ <module name="JavadocBlockTagLocation" />
+ <module name="JavadocContentLocationCheck" />
<module name="JavadocMethod" />
+ <module name="JavadocMissingLeadingAsterisk" />
+ <module name="JavadocMissingWhitespaceAfterAsterisk" />
<module name="JavadocParagraph" />
<module name="JavadocStyle">
<property
<module name="JavadocVariable">
<property name="scope" value="protected" />
</module>
+ <module name="MissingJavadocMethod" />
+ <module name="MissingJavadocPackage" />
+ <module name="MissingJavadocType" />
<module name="NonEmptyAtclauseDescription" />
<module name="SingleLineJavadoc" />
<module name="SummaryJavadocCheck" />
<module name="Indentation">
<property name="caseIndent" value="0" />
</module>
+ <module name="NoCodeInFile" />
<module name="OuterTypeFilename" />
<module name="TodoComment">
<property name="format" value="TODO" />
<!-- Naming Conventions -->
<module name="AbbreviationAsWordInName" />
- <module name="AbstractClassName">
- <property
- name="format"
- value="^Abstract.*$|^.*Factory$|^.*Builder$|^.*Adapter$"
- />
- </module>
+ <module name="AbstractClassName" />
<module name="CatchParameterName" />
<module name="ClassTypeParameterName" />
<module name="ConstantName" />
+ <module name="IllegalIdentifierName" />
<module name="InterfaceTypeParameterName" />
<module name="LambdaParameterName" />
- <module name="LocalFinalVariableName">
- <property name="format" value="^[a-z][_a-zA-Z0-9]*$" />
- </module>
- <module name="LocalVariableName">
- <property name="format" value="^[a-z][_a-zA-Z0-9]*$" />
- </module>
- <module name="MemberName">
- <property name="format" value="^[a-z][_a-zA-Z0-9]*$" />
- </module>
+ <module name="LocalFinalVariableName" />
+ <module name="LocalVariableName" />
+ <module name="MemberName" />
<module name="MethodName" />
<module name="MethodTypeParameterName" />
<module name="PackageName" />
- <module name="ParameterName">
- <property name="format" value="^[a-z][_a-zA-Z0-9]*$" />
- </module>
- <module name="StaticVariableName">
- <property name="format" value="^[a-z][_a-zA-Z0-9]*$" />
- </module>
+ <module name="ParameterName" />
+ <module name="PatternVariableName" />
+ <module name="RecordComponentName" />
+ <module name="RecordTypeParameterName" />
+ <module name="StaticVariableName" />
<module name="TypeName" />
<module name="AnonInnerLength" />
<module name="ExecutableStatementCount" />
- <module name="LineLength">
- <property name="max" value="78" />
- </module>
+ <module name="LambdaBodyLength" />
<module name="MethodCount" />
<module name="MethodLength" />
<module name="OuterTypeNumber" />
<module name="ParameterNumber" />
+ <module name="RecordComponentNumber" />
<!-- Whitespace -->
<module name="EmptyForInitializerPad" />
<module name="EmptyForIteratorPad" />
<module name="EmptyLineSeparator">
- <property
- name="tokens"
- value="PACKAGE_DEF,
- IMPORT,
- CLASS_DEF,
- INTERFACE_DEF,
- ENUM_DEF,
- STATIC_INIT,
- INSTANCE_INIT,
- METHOD_DEF,
- CTOR_DEF,
- "
- />
+ <property name="allowNoEmptyLineBetweenFields" value="true" />
</module>
<module name="GenericWhitespace" />
- <module name="MethodParamPad">
- <property
- name="tokens"
- value="CTOR_DEF, LITERAL_NEW, METHOD_DEF, SUPER_CTOR_CALL"
- />
- </module>
+ <module name="MethodParamPad" />
<module name="NoLineWrap" />
- <module name="NoWhitespaceAfter">
- <property name="allowLineBreaks" value="false" />
- <property name="tokens" value="INC, DEC, DOT" />
- </module>
- <module name="NoWhitespaceBefore">
- <property name="allowLineBreaks" value="false" />
- <property name="tokens" value="COMMA, POST_INC, POST_DEC" />
- </module>
+ <module name="NoWhitespaceAfter" />
<module name="NoWhitespaceBefore">
<property name="allowLineBreaks" value="true" />
- <property name="tokens" value="SEMI" />
- </module>
- <module name="OperatorWrap">
- <property name="option" value="eol" />
- <property
- name="tokens"
- value="ASSIGN,
- BAND_ASSIGN, BOR_ASSIGN, BXOR_ASSIGN,
- PLUS_ASSIGN, MINUS_ASSIGN,
- STAR_ASSIGN, DIV_ASSIGN, MOD_ASSIGN,
- SL_ASSIGN, SR_ASSIGN, BSR_ASSIGN"
- />
- </module>
- <module name="OperatorWrap">
- <property name="option" value="nl" />
- <property
- name="tokens"
- value="QUESTION,
- BAND, BOR, BXOR,
- PLUS, MINUS, STAR, DIV, MOD,
- LAND, LOR,
- EQUAL, NOT_EQUAL"
- />
- </module>
- <module name="ParenPad">
- <property name="option" value="nospace" />
- <property
- name="tokens"
- value="CTOR_CALL, METHOD_CALL, SUPER_CTOR_CALL"
- />
- </module>
- <module name="SeparatorWrap">
- <property name="tokens" value="DOT" />
- <property name="option" value="nl" />
</module>
+ <module name="NoWhitespaceBeforeCaseDefaultColon" />
+ <module name="OperatorWrap" />
+ <module name="ParenPad" />
+ <module name="SeparatorWrap" />
<module name="SingleSpaceSeparator" />
<module name="TypecastParenPad" />
- <module name="WhitespaceAfter" >
- <property name="tokens" value="COMMA, SEMI," />
- </module>
- <module name="WhitespaceAround">
- <property
- name="tokens"
- value="ASSIGN,
- LAND, LOR,
- BAND, BOR, BXOR, BSR,
- BAND_ASSIGN, BOR_ASSIGN, BXOR_ASSIGN, BSR_ASSIGN,
- SL, SR,
- SL_ASSIGN, SR_ASSIGN,
- MINUS, STAR, DIV, MOD,
- PLUS_ASSIGN, MINUS_ASSIGN,
- STAR_ASSIGN, DIV_ASSIGN, MOD_ASSIGN,
- EQUAL, NOT_EQUAL, GT, GE, LT, LE,
- "
- />
- </module>
+ <module name="WhitespaceAfter" />
+ <module name="WhitespaceAround" />
</module>