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

<ruleset name="Design"

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 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">

<description>

Rules that help you discover design issues.

</description>

<rule name="CyclomaticComplexity"

language="plsql"

since="5.1"

message = "The {0} ''{1}'' has a Cyclomatic Complexity of {2}."

class="net.sourceforge.pmd.lang.plsql.rule.design.CyclomaticComplexityRule"

externalInfoUrl="${pmd.website.baseurl}/pmd_rules_plsql_design.html#cyclomaticcomplexity">

<description>

Complexity directly affects maintenance costs is determined by the number of decision points in a method

plus one for the method entry. The decision points include 'if', 'while', 'for', and 'case labels' calls.

Generally, numbers ranging from 1-4 denote low complexity, 5-7 denote moderate complexity, 8-10 denote

high complexity, and 11+ is very high complexity.

</description>

<priority>3</priority>

<example>

</example>

</rule>

<rule name="ExcessiveMethodLength"

language="plsql"

deprecated="true"

since="5.1"

message="Avoid really long methods ({0} lines found, threshold is {1})."

class="net.sourceforge.pmd.lang.plsql.rule.design.ExcessiveMethodLengthRule"

externalInfoUrl="${pmd.website.baseurl}/pmd_rules_plsql_design.html#excessivemethodlength">

<description>

When methods are excessively long this usually indicates that the method is doing more than its

name/signature might suggest. They also become challenging for others to digest since excessive

scrolling causes readers to lose focus.

Try to reduce the method length by creating helper methods and removing any copy/pasted code.

**Deprecated:** This rule is deprecated since PMD 7.19.0 and will be removed with PMD 8.0.0. Use {%rule NcssCount %} to find big methods.

</description>

<priority>3</priority>

<example>

</example>

</rule>

<rule name="ExcessiveObjectLength"

language="plsql"

deprecated="true"

since="5.1"

message="Avoid really long Oracle object specifications and bodies ({0} lines found, threshold is {1})."

class="net.sourceforge.pmd.lang.plsql.rule.design.ExcessiveObjectLengthRule"

externalInfoUrl="${pmd.website.baseurl}/pmd_rules_plsql_design.html#excessiveobjectlength">

<description>

Excessive object line lengths are usually indications that the object may be burdened with excessive

responsibilities that could be provided by other objects. In breaking these methods

apart the code becomes more manageable and ripe for reuse.

**Deprecated:** This rule is deprecated since PMD 7.19.0 and will be removed with PMD 8.0.0. Use {%rule NcssCount %} to find big objects.

</description>

<priority>3</priority>

<example>

</example>

</rule>

<rule name="ExcessivePackageBodyLength"

language="plsql"

deprecated="true"

since="5.1"

message="Avoid really long Object Type and Package bodies ({0} lines found, threshold is {1})."

class="net.sourceforge.pmd.lang.plsql.rule.design.ExcessivePackageBodyLengthRule"

externalInfoUrl="${pmd.website.baseurl}/pmd_rules_plsql_design.html#excessivepackagebodylength">

<description>

Excessive class file lengths are usually indications that the class may be burdened with excessive

responsibilities that could be provided by external classes or functions. In breaking these methods

apart the code becomes more manageable and ripe for reuse.

**Deprecated:** This rule is deprecated since PMD 7.19.0 and will be removed with PMD 8.0.0. Use {%rule NcssCount %} to find big objects.

</description>

<priority>3</priority>

<example>

</example>

</rule>

<rule name="ExcessivePackageSpecificationLength"

language="plsql"

deprecated="true"

since="5.1"

message="Avoid really long Package Specifications ({0} lines found, threshold is {1})."

class="net.sourceforge.pmd.lang.plsql.rule.design.ExcessivePackageSpecificationLengthRule"

externalInfoUrl="${pmd.website.baseurl}/pmd_rules_plsql_design.html#excessivepackagespecificationlength">

<description>

Excessive class file lengths are usually indications that the class may be burdened with excessive

responsibilities that could be provided by external classes or functions. In breaking these methods

apart the code becomes more manageable and ripe for reuse.

**Deprecated:** This rule is deprecated since PMD 7.19.0 and will be removed with PMD 8.0.0. Use {%rule NcssCount %} to find big objects.

</description>

<priority>3</priority>

<example>

</example>

</rule>

<rule name="ExcessiveParameterList"

language="plsql"

since="5.1"

message="Avoid long parameter lists ({0} parameters found, threshold is {1})."

class="net.sourceforge.pmd.lang.plsql.rule.design.ExcessiveParameterListRule"

externalInfoUrl="${pmd.website.baseurl}/pmd_rules_plsql_design.html#excessiveparameterlist">

<description>

Methods with numerous parameters are a challenge to maintain, especially if most of them share the

same datatype. These situations usually denote the need for new objects to wrap the numerous parameters.

</description>

<priority>3</priority>

<example>

</example>

</rule>

<rule name="ExcessiveTypeLength"

language="plsql"

deprecated="true"

since="5.1"

message="Avoid really long Object Type specifications ({0} lines found, threshold is {1})."

class="net.sourceforge.pmd.lang.plsql.rule.design.ExcessiveTypeLengthRule"

externalInfoUrl="${pmd.website.baseurl}/pmd_rules_plsql_design.html#excessivetypelength">

<description>

Excessive class file lengths are usually indications that the class may be burdened with excessive

responsibilities that could be provided by external classes or functions. In breaking these methods

apart the code becomes more manageable and ripe for reuse.

**Deprecated:** This rule is deprecated since PMD 7.19.0 and will be removed with PMD 8.0.0. Use {%rule NcssCount %} to find big objects.

</description>

<priority>3</priority>

<example>

</example>

</rule>

<rule name="NcssCount"

language="plsql"

message="The {0} ''{1}'' has a NCSS line count of {2} (limit: {3})."

since="7.19.0"

class="net.sourceforge.pmd.lang.plsql.rule.design.NcssCountRule"

externalInfoUrl="${pmd.website.baseurl}/pmd_rules_plsql_design.html#ncsscount">

<description>

This rule uses the NCSS (Non-Commenting Source Statements) metric to determine the number of lines

of code in a plsql type or method. NCSS ignores comments, blank lines, and only counts actual

statements. For more details on the calculation, see the documentation

{% jdoc plsql::lang.plsql.metrics.PlsqlMetrics#NCSS %}.

</description>

<priority>3</priority>

<example><![CDATA[

</example>

</rule>

<rule name="NcssMethodCount"

message="The method {0}() has an NCSS line count of {1} (threshold is {2})"

language="plsql"

deprecated="true"

since="5.1"

class="net.sourceforge.pmd.lang.plsql.rule.design.NcssMethodCountRule"

externalInfoUrl="${pmd.website.baseurl}/pmd_rules_plsql_design.html#ncssmethodcount">

<description>

This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of lines

of code for a given method. NCSS ignores comments, and counts actual statements. Using this algorithm,

lines of code that are split are counted as one.

**Deprecated:** This rule is deprecated since PMD 7.19.0 and will be removed with PMD 8.0.0. Use {% rule NcssCount %} instead.

</description>

<priority>3</priority>

<example>

</example>

</rule>

<rule name="NcssObjectCount"

message="The Oracle object {0} has a NCSS line count of {1} (threshold is {2})"

language="plsql"

deprecated="true"

since="5.1"

class="net.sourceforge.pmd.lang.plsql.rule.design.NcssObjectCountRule"

externalInfoUrl="${pmd.website.baseurl}/pmd_rules_plsql_design.html#ncssobjectcount">

<description>

This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of lines

of code for a given Oracle object. NCSS ignores comments, and counts actual statements. Using this algorithm,

lines of code that are split are counted as one.

**Deprecated:** This rule is deprecated since PMD 7.19.0 and will be removed with PMD 8.0.0. Use {% rule NcssCount %} instead.

</description>

<priority>3</priority>

<example>

</example>

</rule>

<rule name="NPathComplexity"

language="plsql"

since="5.1"

message="The method {0}() has an NPath complexity of {1} (threshold is {2})"

class="net.sourceforge.pmd.lang.plsql.rule.design.NPathComplexityRule"

externalInfoUrl="${pmd.website.baseurl}/pmd_rules_plsql_design.html#npathcomplexity">

<description>

The NPath complexity of a method is the number of acyclic execution paths through that method.

A threshold of 200 is generally considered the point where measures should be taken to reduce

complexity and increase readability.

</description>

<priority>3</priority>

<example>

</example>

</rule>

<rule name="TooManyFields"

language="plsql"

since="5.1"

message="Too many fields"

class="net.sourceforge.pmd.lang.plsql.rule.design.TooManyFieldsRule"

externalInfoUrl="${pmd.website.baseurl}/pmd_rules_plsql_design.html#toomanyfields">

<description>

Classes that have too many fields can become unwieldy and could be redesigned to have fewer fields,

possibly through grouping related fields in new objects. For example, a class with individual

city/state/zip fields could park them within a single Address field.

</description>

<priority>3</priority>

<example>

</example>

</rule>

<rule name="TooManyMethods"

language="plsql"

since="5.1"

class="net.sourceforge.pmd.lang.rule.xpath.XPathRule"

message="This object has too many methods, consider refactoring it."

externalInfoUrl="${pmd.website.baseurl}/pmd_rules_plsql_design.html#toomanymethods">

<description>

A package or type with too many methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to

have more fine grained objects.

</description>

<priority>3</priority>

<properties>

<property name="maxmethods" type="Integer" description="The method count reporting threshold" min="1" max="1000" value="1"/>

<property name="xpath">

<value>

</value>

</property>

</properties>

</rule>

</ruleset>