checkstyle.xml

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
    "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
    "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">

	<!--

		Checkstyle configuration that checks the sun coding conventions from:

		- the Java Language Specification at
		http://java.sun.com/docs/books/jls/second_edition/html/index.html -
		the Sun Code Conventions at http://java.sun.com/docs/codeconv/ - the
		Javadoc guidelines at
		http://java.sun.com/j2se/javadoc/writingdoccomments/index.html - the
		JDK Api documentation http://java.sun.com/j2se/docs/api/index.html -
		some best practices 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. Finally, it is worth reading the
		documentation.
	-->

<module name="Checker">
	<property name="severity" value="warning" />

	<module name="SuppressionCommentFilter">
		<property name="offCommentFormat" value="CHECKSTYLEOFF ([\w\|]+)" />
		<property name="onCommentFormat" value="CHECKSTYLEON ([\w\|]+)" />
		<property name="checkFormat" value="$1" />
	</module>

	<module name="SuppressWithNearbyCommentFilter">
		<property name="commentFormat" value="SUPPRESS CHECKSTYLE ([\w\|]+)"/>
		<property name="checkFormat" value="$1" />
		<property name="influenceFormat" value="0"/>
	</module>
    <module name="SuppressWithNearbyCommentFilter">
        <property name="commentFormat" value="SUPPRESS CHECKSTYLE NEXT ([\w\|]+)"/>
        <property name="checkFormat" value="$1" />
        <property name="influenceFormat" value="1"/>
    </module>
    <module name="SuppressWithNearbyCommentFilter">
        <property name="commentFormat" value="SUPPRESS CHECKSTYLE NEXT (\d+) ([\w\|]+)"/>
        <property name="checkFormat" value="$2" />
        <property name="influenceFormat" value="$1"/>
    </module>
    <module name="SuppressWithNearbyCommentFilter">
        <property name="commentFormat" value="SUPPRESS CHECKSTYLE PREVIOUS ([\w\|]+)"/>
        <property name="checkFormat" value="$1" />
        <property name="influenceFormat" value="-1"/>
    </module>
    <module name="SuppressWithNearbyCommentFilter">
        <property name="commentFormat" value="SUPPRESS CHECKSTYLE PREVIOUS (\d+) ([\w\|]+)"/>
        <property name="checkFormat" value="$2" />
        <property name="influenceFormat" value="-$1"/>
    </module>
	<module name="SuppressWithNearbyCommentFilter">
		<property name="commentFormat" value="@generated"/>
		<property name="checkFormat" value=".*"/>
		<property name="influenceFormat" value="9999"/>
	</module>
	<module name="SuppressWithNearbyCommentFilter">
		<property name="commentFormat" value="@generated"/>
		<property name="checkFormat" value=".*"/>
		<property name="influenceFormat" value="-9999"/>
	</module>

	<!-- Checks for Headers                                -->
	<!-- See http://checkstyle.sf.net/config_header.html   -->
	<module name="RegexpHeader">
		<property name="header"
			value="^/\\*\n.*KIELER - Kiel Integrated Environment for Layout Eclipse Rich\s?Client.*\n" />
		<property name="fileExtensions"
			value="java,c,xtext,xtend"/>
	</module>

	<!-- Checks that a package-info.java file exists for each package. -->
	<!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
	<!-- cds: disabled since we don't care about package-info files anymore. -->
	<!-- <module name="JavadocPackage" /> -->

	<!-- Checks whether files end with a new line. -->
	<!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
	<!--
		cds: disabled, because doesn't work correctly on Windows.
        <module name="NewlineAtEndOfFile" />
	-->

	<!-- Checks that property files contain the same keys.         -->
	<!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
	<!--
		haf: disabled, because conflicting with other properties files of
		Eclipse
        <module name="Translation"/>
	-->

	<!-- Checks for Size Violations.                    -->
	<!-- See http://checkstyle.sf.net/config_sizes.html -->
	<module name="FileLength" />

	<!-- Checks for whitespace                               -->
	<!-- See http://checkstyle.sf.net/config_whitespace.html -->
	<module name="FileTabCharacter" />

	<!-- Miscellaneous other checks.                   -->
	<!-- See http://checkstyle.sf.net/config_misc.html -->
	<!--
		haf: disabled since it is too strict and not compatible with auto
		formatter <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."/> </module>
	-->

	<module name="TreeWalker">

		<!-- haf: Enables comments to be used as suppression filters -->
		<module name="FileContentsHolder" />


		<!-- Checks for Javadoc comments.                     -->
		<!-- See http://checkstyle.sf.net/config_javadoc.html -->
		<module name="JavadocMethod">
			<property name="scope" value="protected" />

            <!--
                cds: removed warning for documented, but undeclared runtime exceptions.
            -->
            <property name="allowUndeclaredRTE" value="true" />
		</module>
		<module name="JavadocVariable">
			<property name="scope" value="protected" />
		</module>
		<!--
			cds: removed HTML checks because they don't give correct results.
		-->
		<module name="JavadocStyle">
            <property name="checkHtml" value="false" />
        </module>
		<module name="JavadocType">
			<property name="authorFormat" value="\S*" />
		</module>


		<!-- Checks for Naming Conventions.                  -->
		<!-- See http://checkstyle.sf.net/config_naming.html -->
		<module name="ConstantName" />
		<module name="LocalFinalVariableName" />
		<module name="LocalVariableName" />
		<module name="MemberName" />
		<module name="MethodName" />
		<module name="ParameterName" />
		<module name="StaticVariableName" />
		<module name="TypeName" />
		<module name="PackageName">
			<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
		</module>

		<!-- Following interprets the header file as regular expressions. -->
		<!-- <module name="RegexpHeader"/>                                -->


		<!-- Checks for imports                              -->
		<!-- See http://checkstyle.sf.net/config_import.html -->
		<module name="AvoidStarImport" />
		<module name="IllegalImport" /> <!-- defaults to sun.* packages -->
		<module name="RedundantImport" />
		<module name="UnusedImports" />


		<!-- Checks for Size Violations.                    -->
		<!-- See http://checkstyle.sf.net/config_sizes.html -->
		<module name="LineLength">
			<property name="max" value="105" />
		</module>
		<module name="MethodLength">
			<property name="severity" value="info" />
		</module>
		<module name="ParameterNumber">
			<property name="severity" value="info" />
		</module>


		<!-- Checks for whitespace                               -->
		<!-- See http://checkstyle.sf.net/config_whitespace.html -->
		<module name="EmptyForIteratorPad" />
		<module name="GenericWhitespace" />
		<module name="MethodParamPad" />
		<!--
			haf: removed ARRAY_INIT, because not synchronized with Eclipse
			formatter
		-->
		<module name="NoWhitespaceAfter" >
			<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="WhitespaceAround" />
		<module name="WhitespaceAfter" />


		<!-- Modifier Checks                                    -->
		<!-- See http://checkstyle.sf.net/config_modifiers.html -->
		<module name="ModifierOrder" />
		<module name="RedundantModifier">
          <property name="tokens" value="METHOD_DEF, VARIABLE_DEF, ANNOTATION_FIELD_DEF, INTERFACE_DEF, CTOR_DEF"/>
		  <!--
              chsch: removed CLASS_DEF & ENUM_DEF
              as the checks introduced with https://github.com/checkstyle/checkstyle/issues/1242
              do IMO not reduce ambiguity but increase them, at least on the first glance
              
		      default setting is:
              <property name="tokens" value="METHOD_DEF, VARIABLE_DEF, ANNOTATION_FIELD_DEF, INTERFACE_DEF, CTOR_DEF, CLASS_DEF, ENUM_DEF" />
		   -->
		</module>


		<!-- Checks for blocks. You know, those {}'s         -->
		<!-- See http://checkstyle.sf.net/config_blocks.html -->
		<module name="AvoidNestedBlocks">
			<!-- cds: allow nested blocks in switch statements. -->
			<property name="allowInSwitchCase" value="true" />
		</module>
		<module name="LeftCurly" />
		<module name="NeedBraces" />
		<module name="RightCurly" />
		<!--  haf: allow empty catch blocks if there is some comment -->
		<module name="EmptyBlock">
			<property name="option" value="text" />
			<property name="tokens" value="LITERAL_CATCH" />
		</module>
		<module name="EmptyBlock">
			<property name="tokens"
				value="LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_IF, LITERAL_FOR, LITERAL_TRY, LITERAL_WHILE, INSTANCE_INIT, STATIC_INIT" />
		</module>


		<!-- Checks for common coding problems               -->
		<!-- See http://checkstyle.sf.net/config_coding.html -->
		<!--
			haf: deactivated, because msp and ctr use it sometimes
			<module name="AvoidInlineConditionals"/>
		-->
		<module name="EmptyStatement" />
		<module name="EqualsHashCode" />
        <!--
            cds: allow parameters of constructors and setters to have the
            same name as member variables.
        -->
		<module name="HiddenField">
            <property name="ignoreConstructorParameter" value="true" />
            <property name="ignoreSetter" value="true" />
        </module>
		<module name="InnerAssignment" />
		<module name="MagicNumber" />
		<!--
			haf: deactivated, because sometimes it's useful to not enforce all
			cases in a switch
			<module name="MissingSwitchDefault"/>
		-->
		<!--
			cds: deactivated due to the check's removal in Checkstyle 6.2.
		  <module name="RedundantThrows" />
	  -->
		<module name="SimplifyBooleanExpression" />
		<module name="SimplifyBooleanReturn" />
		<module name="IllegalInstantiation">
			<property name="classes" value="java.lang.Boolean" />
		</module>

		<!-- Checks for class design                         -->
		<!-- See http://checkstyle.sf.net/config_design.html -->
		<!--
			haf: deactivated, because implications are too high.
			<module name="DesignForExtension"/>
		-->
		<module name="FinalClass" />
		<module name="HideUtilityClassConstructor" />
		<module name="InterfaceIsType" />
		<module name="VisibilityModifier"/>


		<!-- Miscellaneous other checks.                   -->
		<!-- See http://checkstyle.sf.net/config_misc.html -->
		<module name="ArrayTypeStyle" />
		<module name="FinalParameters" />
		<!--
			haf: deactivated, because Eclipse has better ways to remind about
			todos <module name="TodoComment"/>
		-->
		<module name="UpperEll" />

	</module>

</module>