Package io.jenkins.plugins.coverage.model.visualization.dashboard

Klasse ProjectCoverage

java.lang.Object

io.jenkins.plugins.coverage.model.visualization.dashboard.CoverageColumnType

io.jenkins.plugins.coverage.model.visualization.dashboard.ProjectCoverage

public class ProjectCoverage
extends CoverageColumnType

Concrete implementation of CoverageColumnType which represents the project coverage.

Autor:

Florian Orendi

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
ProjectCoverage()	Creates a column type to be used for representing the project coverage.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
String	formatCoverage(CoveragePercentage coverage, Locale locale)	Formats the passed coverage using the passed Locale.
Optional<CoveragePercentage>	getCoverage(CoverageBuildAction action, CoverageMetric metric)	Gets the coverage of the passed metric from the passed action.
ColorProvider.DisplayColors	getDisplayColors(CoveragePercentage coverage)	Gets the display colors which are used for visualizing the passed coverage.

Von Klasse geerbte Methoden io.jenkins.plugins.coverage.model.visualization.dashboard.CoverageColumnType

getAnchor, getAvailableCoverageTypeNames, getColorProvider, getDisplayName

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Konstruktordetails

ProjectCoverage

public ProjectCoverage()

Creates a column type to be used for representing the project coverage.

Methodendetails

getCoverage

public Optional<CoveragePercentage> getCoverage(CoverageBuildAction action,
 CoverageMetric metric)

Beschreibung aus Klasse kopiert: CoverageColumnType

Gets the coverage of the passed metric from the passed action.

Angegeben von:

getCoverage in Klasse CoverageColumnType

Parameter:

action - The action which contains the coverage

metric - The coverage metric

Gibt zurück:

the coverage as optional or an empty optional if no coverage has been found

getDisplayColors

public ColorProvider.DisplayColors getDisplayColors(CoveragePercentage coverage)

Beschreibung aus Klasse kopiert: CoverageColumnType

Gets the display colors which are used for visualizing the passed coverage.

Angegeben von:

getDisplayColors in Klasse CoverageColumnType

Parameter:

coverage - The coverage percentage

Gibt zurück:

the display colors

formatCoverage

public String formatCoverage(CoveragePercentage coverage,
 Locale locale)

Beschreibung aus Klasse kopiert: CoverageColumnType

Formats the passed coverage using the passed Locale.

Angegeben von:

formatCoverage in Klasse CoverageColumnType

Parameter:

coverage - The coverage to be formatted

locale - The locale

Gibt zurück:

the formatted coverage string