Package com.parasoft.findings.jenkins.coverage.api.metrics.model

Enum Baseline

java.lang.Object

java.lang.Enum<Baseline>

com.parasoft.findings.jenkins.coverage.api.metrics.model.Baseline

All Implemented Interfaces:

Serializable, Comparable<Baseline>

public enum Baseline
extends Enum<Baseline>

The baseline for the code coverage computation.

Enum Constant Summary

Enum Constants

Enum Constant	Description
MODIFIED_LINES	Coverage of the modified lines (e.g., within the modified lines of a pull or merge request) will focus on new or modified code only.
PROJECT	Coverage of the whole project.

Method Summary

Modifier and Type	Method	Description
ColorProvider.DisplayColors	getDisplayColors(double value, ColorProvider colorProvider)	Returns the display colors to use render a value of this baseline.
String	getTitle()
String	getUrl()
static Baseline	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Baseline[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PROJECT

public static final Baseline PROJECT

Coverage of the whole project. This is an absolute value that might not change much from build to build.

MODIFIED_LINES

public static final Baseline MODIFIED_LINES

Coverage of the modified lines (e.g., within the modified lines of a pull or merge request) will focus on new or modified code only.

Method Detail

values

public static Baseline[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Baseline c : Baseline.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Baseline valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getTitle

public String getTitle()

getUrl

public String getUrl()

getDisplayColors

public ColorProvider.DisplayColors getDisplayColors(double value,
                                                    ColorProvider colorProvider)

Returns the display colors to use render a value of this baseline.

Parameters:

value - the value to render

colorProvider - the color provider to use

Returns:

the display colors to use