bt-checkstyle.xml

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
		"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
		"https://checkstyle.org/dtds/configuration_1_3.dtd">

<!-- Based on sun_checks.xml V9.3 (https://github.com/checkstyle/checkstyle/blob/checkstyle-9.3/src/main/resources/sun_checks.xml) -->

<!--
Checkstyle configuration that checks the sun coding conventions from:
	- the Java Language Specification at
	  https://docs.oracle.com/javase/specs/jls/se11/html/index.html
	- the Sun Code Conventions at https://www.oracle.com/java/technologies/javase/codeconventions-contents.html
	- the Javadoc guidelines at
	  https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html
	- the JDK Api documentation https://docs.oracle.com/en/java/javase/11/
	- some best practices
  Checkstyle is very configurable. Be sure to read the documentation at
  https://checkstyle.org (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.
  To suppress certain violations please review suppression filters.
  Finally, it is worth reading the documentation.
-->

<module name="Checker">
	<!--
		If you set the basedir property below, then all reported file
		names will be relative to the specified directory. See
		https://checkstyle.org/config.html#Checker
		<property name="basedir" value="${basedir}"/>
	-->
	<property name="severity" value="error"/>

	<!-- BorderTech: Override for how many spaces a tab takes from 8 to 4 when Checkstyle prints messages. -->
	<property name="tabWidth" value="4"/>

	<!-- BorderTech: Filter out Checkstyle warnings that have been suppressed with the @SuppressWarnings annotation. -->
	<!-- SuppressWarningsFilter and SuppressWarningsHolder have to be used together. -->
	<module name="SuppressWarningsFilter"/>

	<!-- BorderTech: only check java files
		<property name="fileExtensions" value="java, properties, xml"/>
	-->
	<property name="fileExtensions" value="java"/>

	<!-- Excludes all 'module-info.java' files              -->
	<!-- See https://checkstyle.org/config_filefilters.html -->
	<module name="BeforeExecutionExclusionFileFilter">
		<property name="fileNamePattern" value="module\-info\.java$"/>
	</module>

	<!-- https://checkstyle.org/config_filters.html#SuppressionFilter -->
	<module name="SuppressionFilter">
		<property name="file" value="${org.checkstyle.sun.suppressionfilter.config}"
				  default="checkstyle-suppressions.xml"/>
		<property name="optional" value="true"/>
	</module>

	<!-- Checks that a package-info.java file exists for each package.     -->
	<!-- See https://checkstyle.org/config_javadoc.html#JavadocPackage -->
	<module name="JavadocPackage">
		<!-- BorderTech: Override to warning -->
		<property name="severity" value="warning"/>
	</module>

	<!-- Checks whether files end with a new line.                        -->
	<!-- See https://checkstyle.org/config_misc.html#NewlineAtEndOfFile -->
	<module name="NewlineAtEndOfFile"/>

	<!-- Checks that property files contain the same keys.         -->
	<!-- See https://checkstyle.org/config_misc.html#Translation -->
	<module name="Translation"/>

	<!-- Checks for Size Violations.                    -->
	<!-- See https://checkstyle.org/config_sizes.html -->
	<module name="FileLength">
		<!-- BorderTech: Override to warning -->
		<property name="severity" value="warning"/>
	</module>
	<module name="LineLength">
		<property name="fileExtensions" value="java"/>
		<!-- BorderTech: Override from 80 to 150 -->
		<property name="max" value="150"/>
		<!-- BorderTech: Override to warning -->
		<property name="severity" value="warning"/>
	</module>

	<!-- See https://checkstyle.org/config_whitespace.html -->
	<!-- BorderTech: This check is removed as it fails if there are tabs
	<module name="FileTabCharacter"/>
	-->

	<!-- BorderTech: Use tabs for indenting -->
	<module name="RegexpSingleline">
		<property name="format" value="^(\t*( +\t*(?! \*|\S))|(  ))"/>
		<property name="message" value="Indentation should be tabs."/>
	</module>

	<!-- Miscellaneous other checks.                   -->
	<!-- See https://checkstyle.org/config_misc.html -->
	<module name="RegexpSingleline">
		<property name="format" value="\s+$"/>
		<property name="minimum" value="0"/>
		<property name="maximum" value="0"/>
		<property name="message" value="Line has trailing spaces."/>
		<!-- BorderTech: Override to warning -->
		<property name="severity" value="warning"/>
	</module>

	<!-- Checks for Headers                                -->
	<!-- See https://checkstyle.org/config_header.html   -->
	<!-- <module name="Header"> -->
	<!--   <property name="headerFile" value="${checkstyle.header.file}"/> -->
	<!--   <property name="fileExtensions" value="java"/> -->
	<!-- </module> -->

	<module name="TreeWalker">

		<!-- BorderTech: Make the @SuppressWarnings annotations available to Checkstyle -->
		<!-- SuppressWarningsFilter and SuppressWarningsHolder have to be used together. -->
		<module name="SuppressWarningsHolder"/>

		<!-- Checks for Javadoc comments.                     -->
		<!-- See https://checkstyle.org/config_javadoc.html -->
		<module name="InvalidJavadocPosition">
			<!-- BorderTech: Override to warning -->
			<property name="severity" value="warning"/>
		</module>

		<module name="JavadocMethod">
			<!-- BorderTech: Javadoc not required for methods with these annotations -->
			<property name="allowedAnnotations" value="Override,Test,Before,After,BeforeClass,AfterClass"/>
		</module>
		<module name="JavadocType"/>
		<module name="JavadocVariable">
			<!-- BorderTech: Push scope that is checked from private to protected -->
			<property name="scope" value="protected"/>
		</module>
		<module name="JavadocStyle"/>
		<module name="MissingJavadocMethod"/>

		<!-- Checks for Naming Conventions.                  -->
		<!-- See https://checkstyle.org/config_naming.html -->
		<module name="ConstantName"/>
		<module name="LocalFinalVariableName"/>
		<module name="LocalVariableName"/>
		<module name="MemberName"/>
		<module name="MethodName"/>
		<module name="PackageName"/>
		<module name="ParameterName"/>
		<module name="StaticVariableName"/>
		<module name="TypeName"/>

		<!-- Checks for imports                              -->
		<!-- See https://checkstyle.org/config_imports.html -->
		<module name="AvoidStarImport"/>
		<module name="IllegalImport"/> <!-- defaults to sun.* packages -->
		<module name="RedundantImport"/>
		<module name="UnusedImports">
			<!-- BorderTech: Check javadoc as well -->
			<property name="processJavadoc" value="true"/>
		</module>

		<!-- Checks for Size Violations.                    -->
		<!-- See https://checkstyle.org/config_sizes.html -->
		<module name="MethodLength">
			<!-- BorderTech: Override to warning -->
			<property name="severity" value="warning"/>
		</module>
		<module name="ParameterNumber">
			<!-- BorderTech: Override to warning -->
			<property name="severity" value="warning"/>
		</module>

		<!-- Checks for whitespace                               -->
		<!-- See https://checkstyle.org/config_whitespace.html -->
		<module name="EmptyForIteratorPad">
			<!-- BorderTech: Override to warning as IntelliJ does not currently allow for this-->
			<property name="severity" value="warning"/>
		</module>
		<module name="GenericWhitespace"/>
		<module name="MethodParamPad"/>
		<module name="NoWhitespaceAfter">
			<!-- BorderTech: Tokens to check -->
			<property name="tokens" value="BNOT,DEC,DOT,INC,LNOT,UNARY_MINUS,UNARY_PLUS"/>
		</module>
		<module name="NoWhitespaceBefore"/>
		<module name="OperatorWrap"/>
		<module name="ParenPad"/>
		<module name="TypecastParenPad"/>
		<module name="WhitespaceAfter"/>
		<module name="WhitespaceAround"/>

		<!-- Modifier Checks                                    -->
		<!-- See https://checkstyle.org/config_modifiers.html -->
		<module name="ModifierOrder"/>
		<module name="RedundantModifier">
			<!-- BorderTech: Override to warning -->
			<property name="severity" value="warning"/>
		</module>

		<!-- Checks for blocks. You know, those {}'s         -->
		<!-- See http://checkstyle.sourceforge.net/config_blocks.html -->
		<module name="AvoidNestedBlocks">
			<!-- BorderTech: Allow a nested block in a switch -->
			<property name="allowInSwitchCase" value="true"/>
		</module>
		<module name="EmptyBlock">
			<!-- BorderTech: Override to warning -->
			<property name="severity" value="warning"/>
		</module>
		<module name="LeftCurly"/>
		<module name="NeedBraces"/>
		<module name="RightCurly"/>

		<!-- Checks for common coding problems               -->
		<!-- See https://checkstyle.org/config_coding.html -->
		<module name="EmptyStatement">
			<!-- BorderTech: Override to warning -->
			<property name="severity" value="warning"/>
		</module>
		<module name="EqualsHashCode"/>
		<module name="HiddenField">
			<!-- BorderTech: Override from false for constructor parameters -->
			<property name="ignoreConstructorParameter" value = "true"/>
			<!-- BorderTech: Override from false for setter parameters -->
			<property name="ignoreSetter" value = "true"/>
			<!-- BorderTech: Override to warning -->
			<property name="severity" value="warning"/>
		</module>
		<module name="IllegalInstantiation"/>
		<module name="InnerAssignment"/>
		<module name="MagicNumber">
			<!-- BorderTech: Override from false for hash code methods -->
			<property name="ignoreHashCodeMethod" value = "true"/>
			<!-- BorderTech: Override from false for annotation methods -->
			<property name="ignoreAnnotation" value = "true"/>
			<!-- BorderTech: Override to warning -->
			<property name="severity" value="warning"/>
		</module>
		<module name="MissingSwitchDefault">
			<!-- BorderTech: Override to warning -->
			<property name="severity" value="warning"/>
		</module>
		<module name="MultipleVariableDeclarations"/>
		<module name="SimplifyBooleanExpression"/>
		<module name="SimplifyBooleanReturn"/>

		<!-- Checks for class design                         -->
		<!-- See https://checkstyle.org/config_design.html -->
		<!-- BorderTech: This check is specific for library projects (not applications)
		<module name="DesignForExtension"/>
		-->
		<module name="FinalClass"/>
		<module name="HideUtilityClassConstructor"/>
		<module name="InterfaceIsType"/>
		<module name="VisibilityModifier"/>

		<!-- Miscellaneous other checks.                   -->
		<!-- See https://checkstyle.org/config_misc.html -->
		<!--
		<module name="ArrayTypeStyle"/>
		-->
		<module name="FinalParameters"/>
		<module name="TodoComment">
			<!-- BorderTech: Override to warning -->
			<property name="severity" value="warning"/>
		</module>
		<module name="UpperEll"/>

		<!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter -->
		<module name="SuppressionXpathFilter">
			<property name="file" value="${org.checkstyle.sun.suppressionxpathfilter.config}"
					  default="checkstyle-xpath-suppressions.xml"/>
			<property name="optional" value="true"/>
		</module>

	</module>

</module>