net.sourceforge.pmd.lang.LanguagePropertyBundle 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.lang;

import org.checkerframework.checker.nullness.qual.NonNull;

import net.sourceforge.pmd.PMDConfiguration;
import net.sourceforge.pmd.properties.AbstractPropertySource;
import net.sourceforge.pmd.properties.PropertyDescriptor;
import net.sourceforge.pmd.properties.PropertyFactory;
import net.sourceforge.pmd.util.CollectionUtil;

/**
 * A bundle of properties used by languages (see {@link Language#newPropertyBundle()}).
 * This class declares language properties that are common to all languages.
 * Subclasses may define more properties and provide convenient accessors to them.
 *
 * @author Clément Fournier
 */
public class LanguagePropertyBundle extends AbstractPropertySource {

    // todo for now i think an empty value might interpret every comment
    //  as a suppression. I think it should disable suppression comments.
    //  #4846
    public static final PropertyDescriptor SUPPRESS_MARKER
        = PropertyFactory.stringProperty("suppressMarker")
                         .desc("Marker to identify suppression comments. "
                                   + "Eg a value of NOPMD will make `// NOPMD` a suppression comment in Java or JavaScript.")
                         .defaultValue(PMDConfiguration.DEFAULT_SUPPRESS_MARKER)
                         .build();
    public static final String LANGUAGE_VERSION = "version";

    private final PropertyDescriptor languageVersion;
    private final Language language;

    /**
     * Create a new bundle for the given language.
     */
    public LanguagePropertyBundle(@NonNull Language language) {
        this.language = language;

        definePropertyDescriptor(SUPPRESS_MARKER);

        languageVersion =
            PropertyFactory.enumProperty(
                               LANGUAGE_VERSION,
                               CollectionUtil.associateBy(language.getVersions(), LanguageVersion::getVersion)
                           )
                           .desc("Language version to use for this language. See the --use-version CLI switch as well.")

                           .defaultValue(language.getDefaultVersion())
                           .build();

        definePropertyDescriptor(languageVersion);
    }

    public void setLanguageVersion(String string) {
        setProperty(languageVersion, languageVersion.serializer().fromString(string));
    }

    @Override
    protected String getPropertySourceType() {
        return "Language";
    }

    @Override
    public String getName() {
        return language.getName();
    }

    public Language getLanguage() {
        return language;
    }

    public LanguageVersion getLanguageVersion() {
        return getProperty(languageVersion);
    }

    public String getSuppressMarker() {
        return getProperty(SUPPRESS_MARKER);
    }
}