<!DOCTYPE module PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
-
-<!--
-
- Checkstyle configuration that checks the Google coding conventions from:
-
- - Google Java Style
- https://google-styleguide.googlecode.com/svn-history/r130/trunk/javaguide.html
-
- Checkstyle is very configurable. Be sure to read the documentation at
- http://checkstyle.sf.net (or in your downloaded distribution).
-
- Most Checks are configurable, be sure to consult the documentation.
-
- To completely disable a check, just comment it out or delete it from the file.
-
- Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
-
- -->
-
-<module name = "Checker">
+<module name="Checker">
<property name="charset" value="UTF-8"/>
-
<property name="severity" value="${checkstyle.violationSeverity}" default="warning"/>
<!-- Checks for whitespace -->
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
- <module name="FileTabCharacter">
- <property name="eachLine" value="true"/>
- </module>
-
+ <module name="FileTabCharacter">
+ <property name="eachLine" value="true"/>
+ </module>
+ <module name="RegexpSingleline">
+ <property name="format" value="\s+$"/>
+ <property name="message" value="Line has trailing spaces."/>
+ </module>
+ <module name="RegexpMultiline">
+ <property name="format" value="(?s:\r\n.*)"/>
+ <property name="message" value="File has Windows (CR+LF) instead of UNIX (LF) end of line (EOL) delimiters."/>
+ </module>
+ <module name="SuppressionFilter">
+ <property name="file" value="${checkstyle.suppressions.file}" />
+ </module>
<module name="SuppressWarningsFilter"/>
<module name="TreeWalker">
+ <module name="RegexpSinglelineJava">
+ <property name="format" value="System\.(out)|(err)\.print(ln)?\("/>
+ <property name="message" value="Line contains console output."/>
+ <property name="ignoreComments" value="false" />
+ </module>
+ <module name="RegexpSinglelineJava">
+ <property name="format" value="\.printStackTrace?\("/>
+ <property name="message" value="Line contains printStacktrace()."/>
+ <property name="ignoreComments" value="false" />
+ </module>
<module name="SuppressWarningsHolder" />
<module name="OuterTypeFilename"/>
<module name="IllegalTokenText">
<property name="max" value="120"/><!-- ODL projects use 120 max line length -->
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
</module>
- <module name="AvoidStarImport"/>
<module name="OneTopLevelClass"/>
<module name="NoLineWrap"/>
<module name="EmptyBlock">
<property name="tokens" value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
</module>
<module name="NeedBraces"/>
- <module name="LeftCurly">
- <property name="maxLineLength" value="100"/>
- </module>
- <module name="RightCurly"/>
+ <module name="LeftCurly" />
<module name="RightCurly">
<property name="option" value="alone"/>
- <property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/>
+ <property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, STATIC_INIT, INSTANCE_INIT"/>
</module>
<module name="WhitespaceAround">
<property name="allowEmptyConstructors" value="true"/>
<message key="ws.notPreceded"
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
</module>
+ <module name="ParenPad" />
<module name="OneStatementPerLine"/>
<module name="MultipleVariableDeclarations"/>
<module name="ArrayTypeStyle"/>
<module name="FallThrough"/>
<module name="UpperEll"/>
<module name="ModifierOrder"/>
+ <module name="RedundantModifier"/>
<module name="EmptyLineSeparator">
<property name="allowNoEmptyLineBetweenFields" value="true"/>
+ <!-- No PACKAGE_DEF token, as we like our license header to be glue to "package" statement, to save 1 line screen space -->
+ <property name="tokens" value="IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF, STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
</module>
<module name="SeparatorWrap">
<property name="tokens" value="DOT"/>
<property name="option" value="EOL"/>
</module>
<module name="PackageName">
- <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
+ <property name="format" value="^[a-z]+(\.[a-z][a-z0-9_]*)*$"/>
<message key="name.invalidPattern"
value="Package name ''{0}'' must match pattern ''{1}''."/>
</module>
<message key="name.invalidPattern"
value="Class type name ''{0}'' must match pattern ''{1}''."/>
</module>
+ <module name="MethodName">
+ <property name="format" value="^[a-z][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]*[T]$)"/>
<message key="name.invalidPattern"
value="Method type name ''{0}'' must match pattern ''{1}''."/>
</module>
+ <module name="ConstantName" />
<module name="NoFinalizer"/>
<module name="GenericWhitespace">
<message key="ws.followed"
<property name="throwsIndent" value="4"/>
<property name="lineWrappingIndentation" value="4"/>
<property name="arrayInitIndent" value="4"/>
+ <!-- yangtools' checkstyle-logging had:
+ <property name="caseIndent" value="0"/>
+ <property name="throwsIndent" value="8"/>
+ -->
</module>
<module name="AbbreviationAsWordInName">
<property name="ignoreFinal" value="false"/>
- <property name="allowedAbbreviationLength" value="3"/>
+ <property name="allowedAbbreviationLength" value="4"/>
</module>
<module name="OverloadMethodsDeclarationOrder"/>
<module name="VariableDeclarationUsageDistance"/>
+ <module name="AvoidStarImport"/>
+ <module name="UnusedImports"/>
<module name="CustomImportOrder">
<property name="thirdPartyPackageRegExp" value=".*"/>
- <property name="specialImportsRegExp" value="^com.*"/>
<property name="sortImportsInGroupAlphabetically" value="true"/>
- <property name="customImportOrderRules" value="STATIC###STANDARD_JAVA_PACKAGE###THIRD_PARTY_PACKAGE###SPECIAL_IMPORTS"/>
+ <property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
</module>
+ <module name="RedundantImport"/>
<module name="MethodParamPad"/>
<module name="OperatorWrap">
<property name="option" value="NL"/>
<module name="SummaryJavadocCheck">
<property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
</module>
- <module name="JavadocParagraph"/>
+ <!-- JavaDoc: Do NOT enforce JavaDoc presence, BUT if there is any, it must be uniform and well formed.
+ This is OpenDaylight's pragmatic compromise:
+ * Javadoc on every public method would take a long time to happen.
+ * We want to encourage informative javadocs, but "stub" javadocs are arguably worse than no javadocs.
+ * Javadocs on public methods of interfaces should be mandatory, but Checkstyle does not distinguish those
+ (yet; see https://github.com/sevntu-checkstyle/sevntu.checkstyle/issues/70).
+ -->
+ <module name="JavadocParagraph">
+ <property name="allowNewlineParagraph" value="false"/>
+ </module>
<module name="AtclauseOrder">
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
</module>
+<!-- Uncommenting this would JavaDoc mandatory
+ on all public methods, constructors and annotations, but not on all simple getters and setters (optional);
+ and on all public annotation types (refine "token" to make it on all public classes).
+
+ <module name="JavadocType">
+ <property name="scope" value="public"/>
+ <property name="tokens" value="ANNOTATION_DEF"/>
+ </module>
<module name="JavadocMethod">
<property name="scope" value="public"/>
+ <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF"/>
+ <property name="allowMissingPropertyJavadoc" value="true" />
<property name="allowMissingParamTags" value="true"/>
<property name="allowMissingThrowsTags" value="true"/>
<property name="allowMissingReturnTag" value="true"/>
<property name="allowedAnnotations" value="Override, Test"/>
<property name="allowThrowsTagsForSubclasses" value="true"/>
</module>
+ -->
+ <module name="JavadocStyle">
+ <!-- Do NOT 'scope' this one; any JavaDoc (public/protected/private) IFF present, should be style checked. -->
+ <property name="checkEmptyJavadoc" value="true" />
+ <!-- All except PACKAGE_DEF, due to a Checkstyle particularity (bug?):
+ For all tokens, JavadocStyle checks JavaDoc compliance IFF present;
+ only for package-info.java this ENFORCES that there is a JavaDoc
+ in each package-info.java. We believe this to be a bug because
+ JavadocPackage seems to be inteded for enforcement. Therefore,
+ in line with not enforcing JavaDoc everywhere, just checking when
+ it's present, we must therefore customize the tokens list here.
+ see https://github.com/checkstyle/checkstyle/issues/3416
+ -->
+ <property name="tokens" value="ANNOTATION_DEF, ANNOTATION_FIELD_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF, INTERFACE_DEF, METHOD_DEF, VARIABLE_DEF"/>
+ </module>
<module name="MethodName">
- <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
+ <property name="format" value="^[a-z][a-zA-Z0-9_]*$"/>
<message key="name.invalidPattern"
value="Method name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="SingleLineJavadoc"/>
+
+ <module name="HiddenField">
+ <property name="ignoreConstructorParameter" value="true" />
+ <property name="ignoreSetter" value="true" />
+ <property name="setterCanReturnItsClass" value="true" />
+ </module>
+ <module name="EmptyStatement"/>
+ <module name="EqualsHashCode"/>
+ <module name="FinalClass"/>
+ <module name="HideUtilityClassConstructor"/>
+ <module name="InnerAssignment"/>
+
+ <!-- Checks for Exception Handling Anti-Patterns -->
+ <module name="IllegalCatch"/>
+ <module name="IllegalThrows" />
+ <module name="MutableException"/>
+ <module name="com.github.sevntu.checkstyle.checks.coding.AvoidHidingCauseExceptionCheck" />
+
+ <!-- Checks for API conventions and the like -->
+ <module name="com.github.sevntu.checkstyle.checks.coding.ForbidCertainImportsCheck">
+ <property name="packageNameRegexp" value=".*" />
+ <property name="forbiddenImportsRegexp" value="com.google.common.base.Charsets" />
+ <property name="forbiddenImportsExcludesRegexp" value="" />
+ <message key="forbid.certain.imports" value="Use ''java.nio.charset.StandardCharsets'' instead of ''{0}''" />
+ </module>
</module>
</module>
Code Review / odlparent.git / blobdiff