pmd-rules.xml

<?xml version="1.0"?>
<!--

    Copyright 2018 Telefonaktiebolaget LM Ericsson

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

-->
<ruleset name="Custom 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">
    <description>
        ecChronos mandatory ruleset.
    </description>
    <rule ref="category/java/design.xml">
        <exclude name="TooManyMethods" />
        <exclude name="LawOfDemeter" />
        <exclude name="AvoidCatchingGenericException" /> <!-- Should consider fixing this -->
        <exclude name="LoosePackageCoupling" />
        <exclude name="DataClass" />
        <exclude name="ExcessiveImports" />
        <exclude name="AvoidUncheckedExceptionsInSignatures" />
    </rule>

    <rule ref="category/java/bestpractices.xml">
    </rule>

    <rule ref="category/java/errorprone.xml">
        <exclude name="BeanMembersShouldSerialize" />
        <exclude name="DataflowAnomalyAnalysis" />
        <exclude name="AvoidBranchingStatementAsLastInLoop" />
        <exclude name="AvoidFieldNameMatchingMethodName" />
        <exclude name="CloseResource" />
    </rule>

    <!-- Skip avoidDuplicateLiterals for annotations -->
    <rule ref="category/java/errorprone.xml/AvoidDuplicateLiterals">
        <properties>
            <property name="skipAnnotations" value="true" />
        </properties>
    </rule>
</ruleset>