org.sonar.plugins.pmd.xml.PmdRule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-pmd-plugin Show documentation
Sonar-PMD is a plugin that provides coding rules from PMD.
The newest version!
/*
 * SonarQube PMD Plugin
 * Copyright (C) 2012-2021 SonarSource SA and others
 * mailto:jborgers AT jpinpoint DOT com; peter.paul.bakker AT stokpop DOT nl
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.plugins.pmd.xml;

import java.util.ArrayList;
import java.util.List;
import javax.annotation.Nullable;

import org.sonar.plugins.pmd.PmdConstants;

public class PmdRule {

    private String ref;
    private Integer priority;
    private String name;
    private String message;
    private String clazz;
    private String language;
    private List properties = new ArrayList<>();

    public PmdRule(String ref) {
        this(ref, null);
    }

    public PmdRule(String ref, @Nullable Integer priority) {
        this.ref = ref;
        this.priority = priority;
    }

    @Nullable
    public String getRef() {
        return ref;
    }

    public void setRef(@Nullable String ref) {
        this.ref = ref;
    }

    public List getProperties() {
        return properties;
    }

    public void setProperties(List properties) {
        this.properties = properties;
    }

    public PmdProperty getProperty(String propertyName) {
        for (PmdProperty prop : properties) {
            if (propertyName.equals(prop.getName())) {
                return prop;
            }
        }
        return null;
    }

    @Nullable
    public Integer getPriority() {
        return priority;
    }

    public void setPriority(Integer priority) {
        this.priority = priority;
    }

    public void addProperty(PmdProperty property) {
        properties.add(property);
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public String getClazz() {
        return clazz;
    }

    public void setClazz(String clazz) {
        this.clazz = clazz;
    }

    public void removeProperty(String propertyName) {
        PmdProperty prop = getProperty(propertyName);
        properties.remove(prop);
    }

    public boolean hasProperties() {
        return !properties.isEmpty();
    }

    @Nullable
    public String getLanguage() {
        return language;
    }

    public void setLanguage(String language) {
        this.language = language;
    }

    public void processXpath(String sonarRuleKey) {
        if (PmdConstants.XPATH_CLASS.equals(ref)) {
            ref = null;
            PmdProperty xpathMessage = getProperty(PmdConstants.XPATH_MESSAGE_PARAM);
            if (xpathMessage == null) {
                throw new IllegalArgumentException("Property '" + PmdConstants.XPATH_MESSAGE_PARAM + "' should be set for PMD rule " + sonarRuleKey);
            }

            message = xpathMessage.getValue();
            removeProperty(PmdConstants.XPATH_MESSAGE_PARAM);
            PmdProperty xpathExp = getProperty(PmdConstants.XPATH_EXPRESSION_PARAM);

            if (xpathExp == null) {
                throw new IllegalArgumentException("Property '" + PmdConstants.XPATH_EXPRESSION_PARAM + "' should be set for PMD rule " + sonarRuleKey);
            }

            xpathExp.setCdataValue(xpathExp.getValue());
            clazz = PmdConstants.XPATH_CLASS;
            language = PmdConstants.LANGUAGE_KEY;
            name = sonarRuleKey;
        }
    }
}