Class HealthDescriptor

  • All Implemented Interfaces:
    Serializable

    public class HealthDescriptor
    extends Object
    implements Serializable
    A health descriptor defines the parameters to create the build health.
    Author:
    Ullrich Hafner
    See Also:
    Serialized Form
    • Constructor Detail

      • HealthDescriptor

        public HealthDescriptor​(int healthy,
                                int unhealthy,
                                edu.hm.hafner.analysis.Severity minimumSeverity)
        Creates a new HealthDescriptor.
        Parameters:
        healthy - the healthy threshold, i.e. when health is reported as 100%.
        unhealthy - the unhealthy threshold, i.e. when health is reported as 0%.
        minimumSeverity - the minimum severity that should be considered when computing build health
    • Method Detail

      • getHealthy

        public int getHealthy()
        Returns the healthy threshold, i.e. when health is reported as 100%.
        Returns:
        the 100% healthiness
      • getUnhealthy

        public int getUnhealthy()
        Returns the unhealthy threshold, i.e. when health is reported as 0%.
        Returns:
        the 0% unhealthiness
      • getMinimumSeverity

        public edu.hm.hafner.analysis.Severity getMinimumSeverity()
        Returns the minimum severity that should be considered when computing build health. E.g., if Severity.WARNING_NORMAL is returned, then annotations with severity Severity.WARNING_LOW are ignored.
        Returns:
        the minimum severity to consider
      • isEnabled

        public boolean isEnabled()
        Determines whether health reporting is enabled.
        Returns:
        true if health reporting is enabled, false otherwise
      • isValid

        public boolean isValid()
        Determines whether health reporting is enabled.
        Returns:
        true if health reporting is enabled, false otherwise