hudson.plugins.checkstyle.util.HealthDescriptor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of checkstyle Show documentation

This plug-in generates the trend report for Checkstyle, an open source static code analysis program.

There is a newer version: 3.12

package hudson.plugins.checkstyle.util;

import hudson.plugins.checkstyle.util.model.Priority;

import java.io.Serializable;


/**
 * A health descriptor defines the parameters to create the build health. It
 * consists of the following constraints:
 * 
 * A flag to determine whether a build should be marked unstable if the
 * number of annotations reaches a given threshold.
 * A flag to determine whether a build should change its healthiness
 * according to the number of warnings. The healthiness is interpolated between
 * the specified minimum and maximum values.
 * 
 *
 * @author Ulli Hafner
 */
public interface HealthDescriptor extends Serializable {
    /**
     * Determines whether a threshold has been defined.
     *
     * @return true if a threshold has been defined
     */
    boolean isThresholdEnabled();

    /**
     * Returns the threshold to be reached if a build should be considered as
     * unstable.
     *
     * @return the threshold to be reached if a build should be considered as
     *         unstable
     */
    int getMinimumAnnotations();

    /**
     * Determines whether a health report should be created.
     *
     * @return true if a health report should be created
     */
    boolean isHealthyReportEnabled();

    /**
     * Returns the healthy threshold for annotations, i.e. when health is reported as 100%.
     *
     * @return the 100% healthiness
     */
    int getHealthyAnnotations();

    /**
     * Returns the unhealthy threshold of annotations, i.e. when health is reported as 0%.
     *
     * @return the 0% unhealthiness
     */
    int getUnHealthyAnnotations();

    /**
     * Returns the minimum priority that should be considered when computing
     * build health and stability. E.g., if {@link Priority#NORMAL} is
     * returned, then annotations with priority {@link Priority#LOW} are
     * ignored.
     *
     * @return the minimum priority to consider
     */
    Priority getMinimumPriority();
}