net.sourceforge.pmd.util.OptionalBool Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pmd-core Show documentation

PMD is an extensible multilanguage static code analyzer. It finds common programming flaws like unused variables, empty catch blocks, unnecessary object creation, and so forth. It's mainly concerned with Java and Apex, but supports 16 other languages. It comes with 400+ built-in rules. It can be extended with custom rules. It uses JavaCC and Antlr to parse source files into abstract syntax trees (AST) and runs rules against them to find violations. Rules can be written in Java or using a XPath query. Currently, PMD supports Java, JavaScript, Salesforce.com Apex and Visualforce, Kotlin, Swift, Modelica, PLSQL, Apache Velocity, JSP, WSDL, Maven POM, HTML, XML and XSL. Scala is supported, but there are currently no Scala rules available. Additionally, it includes CPD, the copy-paste-detector. CPD finds duplicated code in Coco, C/C++, C#, Dart, Fortran, Gherkin, Go, Groovy, HTML, Java, JavaScript, JSP, Julia, Kotlin, Lua, Matlab, Modelica, Objective-C, Perl, PHP, PLSQL, Python, Ruby, Salesforce.com Apex and Visualforce, Scala, Swift, T-SQL, Typescript, Apache Velocity, WSDL, XML and XSL.

There is a newer version: 7.5.0-metrics

Show newest version

/*
 * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
 */

package net.sourceforge.pmd.util;

/** Represents a boolean that may not be present. Use as a non-null type. */
public enum OptionalBool {
    NO, UNKNOWN, YES;

    /**
     * Returns the logical complement.
     * {@code
     * yes -> no
     * unk -> unk
     * no -> yes
     * }
     */
    public OptionalBool complement() {
        switch (this) {
        case YES:
            return NO;
        case NO:
            return YES;
        default:
            return this;
        }
    }

    public static OptionalBool max(OptionalBool a, OptionalBool b) {
        return a.compareTo(b) > 0 ? a : b;
    }

    public static OptionalBool min(OptionalBool a, OptionalBool b) {
        return a.compareTo(b) < 0 ? a : b;
    }

    /**
     * If both values are the same, return it. Otherwise return UNKNOWN.
     * {@code
     * yes, yes -> yes
     * no, no -> no
     * everything else -> unk
     * }
     */
    public static OptionalBool join(OptionalBool a, OptionalBool b) {
        return a != b ? UNKNOWN : a;
    }

    /** Returns true this is not {@link #UNKNOWN}. */
    public boolean isKnown() {
        return this != UNKNOWN;
    }

    /** Returns true if this is {@link #YES}. */
    public boolean isTrue() {
        return this == YES;
    }

    /** Returns either YES or NO depending on the given boolean. */
    public static OptionalBool definitely(boolean a) {
        return a ? YES : NO;
    }

    public static OptionalBool unless(boolean a) {
        return a ? NO : YES;
    }
}