hudson.plugins.pmd.util
Interface HealthDescriptor

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AbstractHealthDescriptor, HealthAwareMavenReporter, HealthAwarePublisher, NullHealthDescriptor, PmdHealthDescriptor, PmdPublisher, PmdReporter

public interface HealthDescriptor
extends 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

Method Summary

int	getHealthyAnnotations() Returns the healthy threshold for annotations, i.e. when health is reported as 100%.
int	getMinimumAnnotations() Returns the threshold to be reached if a build should be considered as unstable.
Priority	getMinimumPriority() Returns the minimum priority that should be considered when computing build health and stability.
int	getUnHealthyAnnotations() Returns the unhealthy threshold of annotations, i.e. when health is reported as 0%.
boolean	isHealthyReportEnabled() Determines whether a health report should be created.
boolean	isThresholdEnabled() Determines whether a threshold has been defined.

Method Detail

isThresholdEnabled

boolean isThresholdEnabled()

Determines whether a threshold has been defined.

Returns:

true if a threshold has been defined

getMinimumAnnotations

int getMinimumAnnotations()

Returns the threshold to be reached if a build should be considered as unstable.

Returns:

the threshold to be reached if a build should be considered as unstable

isHealthyReportEnabled

boolean isHealthyReportEnabled()

Determines whether a health report should be created.

Returns:

true if a health report should be created

getHealthyAnnotations

int getHealthyAnnotations()

Returns the healthy threshold for annotations, i.e. when health is reported as 100%.

Returns:

the 100% healthiness

getUnHealthyAnnotations

int getUnHealthyAnnotations()

Returns the unhealthy threshold of annotations, i.e. when health is reported as 0%.

Returns:

the 0% unhealthiness

getMinimumPriority

Priority getMinimumPriority()

Returns the minimum priority that should be considered when computing build health and stability. E.g., if Priority.NORMAL is returned, then annotations with priority Priority.LOW are ignored.

Returns:

the minimum priority to consider