rulesets.java.ali-flowcontrol.xml Maven / Gradle / Ivy

Go to download
<?xml version="1.0"?>

<ruleset name="AlibabaJavaFlowControl" 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>AlibabaJavaFlowControl</description>

    <rule name="SwitchStatementRule"
          language="java"
          message="java.flowcontrol.SwitchStatementRule.rule.msg"
          class="com.xenoamess.p3c.pmd.lang.java.rule.flowcontrol.SwitchStatementRule">
        <priority>2</priority>

        <example>
            <![CDATA[
    switch (x) {
        case 1:
            break;
        case 2:
            break;
        default:
    }
			]]>
        </example>
    </rule>

    <rule name="SwitchExpressionRule"
          language="java"
          message="java.flowcontrol.SwitchExpressionRule.rule.msg"
          class="com.xenoamess.p3c.pmd.lang.java.rule.flowcontrol.SwitchExpressionRule">
        <priority>2</priority>

        <example>
            <![CDATA[
    int b = switch (x) {
        case 1 -> 4;
        case 2 -> 5;
        default -> 6;
    }
			]]>
        </example>
    </rule>

    <rule name="NeedBraceRule"
          language="java"
          message="java.flowcontrol.NeedBraceRule.rule.msg"
          class="com.xenoamess.p3c.pmd.lang.java.rule.flowcontrol.NeedBraceRule">
        <priority>1</priority>

        <example>
            <![CDATA[
    if (flag) {
            System.out.println("hello world");
    }
			]]>
        </example>
    </rule>

    <rule name="AvoidComplexConditionRule"
          language="java"
          message="java.flowcontrol.AvoidComplexConditionRule.rule.msg"
          class="com.xenoamess.p3c.pmd.lang.java.rule.flowcontrol.AvoidComplexConditionRule">
        <description>java.flowcontrol.AvoidComplexConditionRule.rule.desc</description>
        <priority>3</priority>

        <example>
            <![CDATA[
Negative example:
    if ((file.open(fileName, "w") != null) && (...) || (...)) {
        // ...
    }
			]]>
        </example>
        <example>
            <![CDATA[
Positive example:
    boolean existed = (file.open(fileName, "w") != null) && (...) || (...);
    if (existed) {
        //...
    }
			]]>
        </example>
    </rule>

    <rule name="AvoidNegationOperatorRule"
          language="java"
          message="java.flowcontrol.AvoidNegationOperatorRule.rule.msg"
          class="com.xenoamess.p3c.pmd.lang.java.rule.flowcontrol.AvoidNegationOperatorRule">
        <description>java.flowcontrol.AvoidNegationOperatorRule.rule.desc</description>
        <priority>3</priority>

        <example>
            <![CDATA[
Negative example:
    // Use `if (!(x >= 628))` to represent that x is less than 628.
    if (!(x >= 628)) {
        // ...
    }
			]]>
        </example>
        <example>
            <![CDATA[
Positive example:
    // Use `if (x < 628)` to represent that x is less than 628.
    if (x < 628)) {
        // ...
    }
			]]>
        </example>
    </rule>
</ruleset>