com.qualinsight.plugins.sonarqube.badges.ws.gate.QualityGateBadge Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of qualinsight-plugins-sonarqube-badges Show documentation

This plugin adds a webservice to SonarQube that allows the retrieval of different types of badges that display as a SVG image the quality of a project or a view.

There is a newer version: 3.0.1

Show newest version

/*
 * qualinsight-plugins-sonarqube-badges
 * Copyright (c) 2015-2016, QualInsight
 * http://www.qualinsight.com/
 *
 * 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, you can retrieve a copy
 * from .
 */
package com.qualinsight.plugins.sonarqube.badges.ws.gate;

import static com.qualinsight.plugins.sonarqube.badges.ws.SVGImageColor.GRAY;
import static com.qualinsight.plugins.sonarqube.badges.ws.SVGImageColor.GREEN;
import static com.qualinsight.plugins.sonarqube.badges.ws.SVGImageColor.ORANGE;
import static com.qualinsight.plugins.sonarqube.badges.ws.SVGImageColor.RED;
import com.qualinsight.plugins.sonarqube.badges.ws.SVGImageColor;

/**
 * Possible badges for a SonarQube project or view. Each badge holds information about how it has to be displayed as a SVG image.
 *
 * @author Michel Pawlak
 */
public enum QualityGateBadge {
    /**
     * No gate is active for the project or view.
     */
    NONE("not set",
        GRAY),
    /**
     * The project / view passes the quality gate.
     */
    OK("passing",
        GREEN),
    /**
     * The project / view does not pass the quality gate due to gate warnings.
     */
    WARN("warning",
        ORANGE),
    /**
     * The project / view does not pass the quality gate due to gate errors.
     */
    ERROR("failing",
        RED),
    /**
     * The project / view could not be found on the SonarQube's server.
     */
    NOT_FOUND("not found",
        RED),
    /**
     * Access to the project / view is restricted (see issue #15)
     */
    FORBIDDEN("forbidden",
        RED);

    private final String displayText;

    private final SVGImageColor displayBackgroundColor;

    private QualityGateBadge(final String displayText, final SVGImageColor displayBackgroundColor) {
        this.displayText = displayText;
        this.displayBackgroundColor = displayBackgroundColor;
    }

    /**
     * Text to be displayed for the badge type
     *
     * @return text to be displayed
     */
    public String displayText() {
        return this.displayText;
    }

    /**
     * Background color to be displayed for the badge type
     *
     * @return background color to be displayed
     */
    public SVGImageColor displayBackgroundColor() {
        return this.displayBackgroundColor;
    }

}