edu.hm.hafner.analysis.parser.fxcop.FxCopRule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of analysis-model Show documentation

This library provides a Java object model to read, aggregate, filter, and query static analysis reports. It is used by Jenkins' warnings next generation plug-in to visualize the warnings of individual builds. Additionally, this library is used by a GitHub action to autograde student software projects based on a given set of metrics (unit tests, code and mutation coverage, static analysis warnings).

There is a newer version: 12.9.1

Show newest version

package edu.hm.hafner.analysis.parser.fxcop;

import edu.umd.cs.findbugs.annotations.CheckForNull;

/**
 * Internal model for a FxCop rule.
 *
 * @author Erik Ramfelt
 */
@SuppressWarnings({"PMD", "all", "CheckStyle"})
public class FxCopRule {
    private final String typeName;
    private final String category;
    private final String checkId;
    @CheckForNull
    private String name;
    @CheckForNull
    private String url;
    @CheckForNull
    private String description;

    public FxCopRule(final String typeName, final String category, final String checkId) {
        this.typeName = typeName;
        this.category = category;
        this.checkId = checkId;
    }

    @CheckForNull
    public String getName() {
        return name;
    }

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

    @CheckForNull
    public String getUrl() {
        return url;
    }

    public void setUrl(final String url) {
        this.url = url;
    }

    @CheckForNull
    public String getDescription() {
        return description;
    }

    public void setDescription(final String description) {
        this.description = description;
    }

    public String getTypeName() {
        return typeName;
    }

    public String getCategory() {
        return category;
    }

    public String getCheckId() {
        return checkId;
    }
}