com.qualinsight.plugins.sonarqube.badges.ws.measure.MeasureHolder 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.measure;

import java.io.Serializable;
import java.util.NoSuchElementException;
import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sonar.api.measures.CoreMetrics;
import org.sonar.api.measures.Metric;
import org.sonarqube.ws.WsMeasures.Measure;
import com.qualinsight.plugins.sonarqube.badges.ws.SVGImageColor;

/**
 * Holds measure data.
 *
 * @author Michel Pawlak
 */
public class MeasureHolder {

    private static final Logger LOGGER = LoggerFactory.getLogger(MeasureHolder.class);

    private static final String NA = "N/A";

    private String metricName;

    private String value;

    /**
     * Constructs a MeasureHolder from a metric key.
     *
     * @param metricKey key used to retrieve the metric name for which the MeasureHolder is built
     */
    public MeasureHolder(final String metricKey) {
        try {
            this.metricName = CoreMetrics.getMetric(metricKey)
                .getName()
                .replace(" (%)", "")
                .toLowerCase();
        } catch (final NoSuchElementException e) {
            LOGGER.debug("Metric '{}' is not referenced in CoreMetrics.", metricKey, e);
            this.metricName = metricKey;
        }
        this.value = NA;
    }

    /**
     * Constructs a MeasureHolder from a Measure object.
     *
     * @param measure used to retrieve the metric name for which the MeasureHolder is built
     */
    @SuppressWarnings("unchecked")
    public MeasureHolder(final Measure measure) {
        final Metric metric = CoreMetrics.getMetric(measure.getMetric());
        this.metricName = metric.getName()
            .replace(" (%)", "")
            .toLowerCase();
        this.value = measure.getValue() + (metric.isPercentageType() ? "%" : "");
    }

    /**
     * Name of measured metric.
     *
     * @return name of measured metric
     */
    public String metricName() {
        return this.metricName;
    }

    /**
     * Measured value.
     *
     * @return measured value
     */
    public String value() {
        return this.value;
    }

    /**
     * Background color to be used in SVG image.
     *
     * @return background color as HEX string
     */
    public SVGImageColor backgroundColor() {
        return SVGImageColor.GRAY;
    }

    @Override
    public int hashCode() {
        return new HashCodeBuilder().append(this.metricName)
            .append(this.value)
            .toHashCode();
    }

    @Override
    public boolean equals(final Object obj) {
        if (!(obj instanceof MeasureHolder)) {
            return false;
        }
        final MeasureHolder other = (MeasureHolder) obj;
        return new EqualsBuilder().append(this.metricName, other.metricName)
            .append(this.value, other.value)
            .isEquals();
    }

}