tools/checkstyle/src/main/resources/cloud-pmd.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--

    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you 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="CloudStack PMD Ruleset"
  xmlns="http://pmd.sourceforge.net/ruleset/2.0.0">

  <description>
    CloudStack PMD ruleset. Enables all PMD 7 categories with
    project-specific exclusions for rules that are too noisy
    or incompatible with CloudStack conventions.
  </description>

  <rule ref="category/java/bestpractices.xml">
    <exclude name="AbstractClassWithoutAbstractMethod" />
    <exclude name="GuardLogStatement" />
    <!-- <exclude name="LiteralsFirstInComparisons" /> -->
    <!-- <exclude name="PreserveStackTrace" /> -->
    <!-- <exclude name="AvoidReassigningParameters" /> -->
    <!-- <exclude name="LooseCoupling" /> -->
    <!-- <exclude name="UseCollectionIsEmpty" /> -->
    <!-- <exclude name="MissingOverride" /> -->
    <!-- <exclude name="UnusedAssignment" /> -->
  </rule>

  <rule ref="category/java/codestyle.xml">
    <exclude name="ShortVariable" />
    <exclude name="AtLeastOneConstructor" />
    <exclude name="CallSuperInConstructor" />
    <!-- <exclude name="LocalVariableCouldBeFinal" />
    <exclude name="MethodArgumentCouldBeFinal" /> -->
    <!-- <exclude name="OnlyOneReturn" /> -->
    <!-- <exclude name="CommentDefaultAccessModifier" /> -->
    <!-- <exclude name="FieldNamingConventions" /> -->
    <!-- <exclude name="UseDiamondOperator" /> -->
    <!-- <exclude name="UselessParentheses" /> -->
    <!-- <exclude name="PrematureDeclaration" /> -->
    <!-- <exclude name="UnnecessaryBoxing" /> -->
    <!-- <exclude name="ControlStatementBraces" /> -->
    <!-- <exclude name="FieldDeclarationsShouldBeAtStartOfClass" /> -->
    <!-- <exclude name="ConfusingTernary" /> -->
    <!-- <exclude name="UnnecessaryFullyQualifiedName" /> -->
    <!-- <exclude name="LocalVariableNamingConventions" /> -->
    <!-- <exclude name="UnnecessaryModifier" /> -->
    <exclude name="LongVariable" />
  </rule>

  <rule ref="category/java/design.xml">
    <exclude name="ExcessiveImports" />
    <exclude name="LawOfDemeter"/>
    <!-- <exclude name="CyclomaticComplexity" /> -->
    <!-- <exclude name="CognitiveComplexity" /> -->
    <!-- <exclude name="NPathComplexity" /> -->
    <!-- <exclude name="AvoidCatchingGenericException" /> -->
    <!-- <exclude name="AvoidUncheckedExceptionsInSignatures" /> -->
    <!-- <exclude name="ImmutableField" /> -->
    <!-- <exclude name="NcssCount" /> -->
    <!-- <exclude name="CollapsibleIfStatements" /> -->
    <!-- <exclude name="MutableStaticState" />
    <exclude name="CouplingBetweenObjects" />
    <exclude name="TooManyMethods" />
    <exclude name="GodClass" /> -->
  </rule>

  <rule ref="category/java/documentation.xml">
    <exclude name="CommentSize" />
    <exclude name="CommentRequired" />
  </rule>

  <rule ref="category/java/errorprone.xml">
    <exclude name="AssignmentInOperand" />
    <exclude name="NullAssignment" />
    <exclude name="ConstructorCallsOverridableMethod"/>
    <!-- <exclude name="AvoidDuplicateLiterals" />
    <exclude name="ReplaceJavaUtilDate" />
    <exclude name="AvoidLiteralsInIfCondition" />
    <exclude name="UseLocaleWithCaseConversions" />
    <exclude name="CompareObjectsWithEquals" /> -->
  </rule>

  <rule ref="category/java/multithreading.xml">
    <exclude name="UseConcurrentHashMap" />
    <exclude name="AvoidSynchronizedAtMethodLevel"/>
    <!-- <exclude name="DoNotUseThreads" /> -->
  </rule>

  <rule ref="category/java/performance.xml">
    <!-- <exclude name="AvoidInstantiatingObjectsInLoops" />
    <exclude name="RedundantFieldInitializer" /> -->
  </rule>
  <rule ref="category/java/security.xml" />

</ruleset>