pmdrules.xml

<?xml version="1.0"?>
<ruleset name="Kieker PMD ruleset"
	xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd"
	xsi:noNamespaceSchemaLocation="http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
	<description>
    This ruleset is checked for Kieker automatically.
  </description>

	<!-- exclude generated code -->
	<exclude-pattern>.*/src-gen/.*</exclude-pattern>
	<exclude-pattern>.*/test-gen/.*</exclude-pattern>

	<!-- We'll use the following rulesets -->
	<rule ref="rulesets/internal/all-java.xml">
		<exclude name="AvoidCatchingNPE" />
		<exclude name="AvoidDuplicateLiterals" />
		<exclude name="AvoidFinalLocalVariable" />
		<exclude name="AvoidInstantiatingObjectsInLoops" />
		<exclude name="AvoidLiteralsInIfCondition" />
		<exclude name="AvoidThrowingNullPointerException" />
		<exclude name="AvoidUsingVolatile" />
		<exclude name="BeanMembersShouldSerialize" />
		<exclude name="CallSuperInConstructor" />
		<exclude name="CommentSize" />
		<exclude name="ConfusingTernary" />
		<exclude name="CyclomaticComplexity" />
		<exclude name="DataflowAnomalyAnalysis" />
		<exclude name="DoNotCallSystemExit" />
		<exclude name="DoNotUseThreads" />
		<exclude name="ExcessiveImports" />
		<exclude name="ExcessiveMethodLength" />
		<exclude name="ExcessiveParameterList" />
		<exclude name="GodClass" />
		<exclude name="JUnitAssertionsShouldIncludeMessage" />
		<exclude name="LawOfDemeter" />
		<exclude name="LongVariable" />
		<exclude name="LoosePackageCoupling" />
		<exclude name="NPathComplexity" />
		<exclude name="OnlyOneReturn" />
		<exclude name="PackageCase" />
		<!-- startsWith is better: it returns false instead of an IndexOutOfBoundsException 
			and its name reflects its purpose -->
		<exclude name="SimplifyStartsWith" />
		<exclude name="ShortClassName" />
		<exclude name="ShortVariable" />
		<exclude name="SignatureDeclareThrowsException" />
		<!-- Java automatically compiles to StringBuilder and StringBuffer is unnecessarily 
			synchronized -->
		<exclude name="UseStringBufferForStringAppends" />
		<exclude name="TooManyMethods" />
		<exclude name="UnnecessaryConstructor" />
		<exclude name="UnnecessaryModifier" />
		<exclude name="UseObjectForClearerAPI" />
		<exclude name="UseProperClassLoader" />
		<exclude name="UselessParentheses" />
		<exclude name="UselessQualifiedThis"/>
		<exclude name="UseVarargs" />
	</rule>

	<rule ref="category/java/documentation.xml/CommentRequired">
		<!-- <priority>5</priority> -->
		<properties>
			<property name="violationSuppressXPath"
				value="//ClassOrInterfaceBodyDeclaration/MethodDeclaration/MethodDeclarator[matches(@Image,'(get|is|set)[\p{Lu}].*') and not(FormalParameters/FormalParameter)]" />
			<property name="fieldCommentRequirement" value="Ignored" />
			<property name="protectedMethodCommentRequirement" value="Ignored" />
			<property name="publicMethodCommentRequirement" value="Ignored" />
		</properties>
	</rule>

	<!-- <rule ref="rulesets/java/logging-jakarta-commons.xml/GuardLogStatement"> -->
	<!-- <priority>3</priority> -->
	<!-- </rule> -->

</ruleset>