Package io.jenkins.plugins.coverage.metrics.steps

Klasse CoverageMetricColumn

java.lang.Object

hudson.views.ListViewColumn

io.jenkins.plugins.coverage.metrics.steps.CoverageMetricColumn

Alle implementierten Schnittstellen:

ExtensionPoint, Describable<ListViewColumn>

public class CoverageMetricColumn
extends ListViewColumn

Dashboard column model which represents coverage metrics of different coverage types.

Autor:

Florian Orendi

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	CoverageMetricColumn.CoverageMetricColumnDescriptor	Descriptor of the column.

Von Schnittstelle geerbte verschachtelte Klassen/Schnittstellen hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Feldübersicht

Von Klasse geerbte Felder hudson.views.ListViewColumn

DEFAULT_COLUMNS_ORDINAL_ACTIONS_END, DEFAULT_COLUMNS_ORDINAL_ACTIONS_START, DEFAULT_COLUMNS_ORDINAL_ICON_END, DEFAULT_COLUMNS_ORDINAL_ICON_START, DEFAULT_COLUMNS_ORDINAL_PROPERTIES_END, DEFAULT_COLUMNS_ORDINAL_PROPERTIES_START, LIST

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
CoverageMetricColumn()	Creates a new column.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
String	formatMetric(edu.hm.hafner.coverage.Value value)	Returns a formatted and localized String representation of the specified value (without metric).
String	formatValue(edu.hm.hafner.coverage.Value value)	Returns a formatted and localized String representation of the specified value (without metric).
List<edu.hm.hafner.coverage.Value>	getAllValues(Job<?,?> job)	Returns all available values for the specified baseline.
String	getBackgroundColorFillPercentage(String percentage)	Transforms percentages with a ',' decimal separator to a representation using a '.' in order to use the percentage for styling HTML tags.
Baseline	getBaseline()
String	getColumnName()
String	getCoverageText(Job<?,?> job)	Provides a text which represents the coverage percentage of the selected coverage type and metric.
Optional<? extends edu.hm.hafner.coverage.Value>	getCoverageValue(Job<?,?> job)	Provides the coverage value of the selected coverage type and metric.
ColorProvider.DisplayColors	getDisplayColors(Job<?,?> job, Optional<? extends edu.hm.hafner.coverage.Value> coverage)	Provides the line color for representing the passed coverage value.
ElementFormatter	getFormatter()
edu.hm.hafner.coverage.Metric	getMetric()
String	getRelativeCoverageUrl(Job<?,?> job)	Provides the relative URL which can be used for accessing the coverage report.
void	setBaseline(Baseline baseline)	Sets the baseline of the values that will be shown.
void	setColumnName(String columnName)	Sets the display name of the column.
void	setMetric(edu.hm.hafner.coverage.Metric metric)	Sets the metric of the values that will be shown.

Von Klasse geerbte Methoden hudson.views.ListViewColumn

all, createDefaultInitialColumnList, createDefaultInitialColumnList, createDefaultInitialColumnList, getColumnCaption, getDescriptor, shownByDefault

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

CoverageMetricColumn

@DataBoundConstructor
public CoverageMetricColumn()

Creates a new column.

Methodendetails

getFormatter

public ElementFormatter getFormatter()

setColumnName

@DataBoundSetter
public void setColumnName(String columnName)

Sets the display name of the column.

Parameter:

columnName - the human-readable name of the column

getColumnName

public String getColumnName()

setBaseline

@DataBoundSetter
public void setBaseline(Baseline baseline)

Sets the baseline of the values that will be shown.

Parameter:

baseline - the baseline to use

getBaseline

public Baseline getBaseline()

setMetric

@DataBoundSetter
public void setMetric(edu.hm.hafner.coverage.Metric metric)

Sets the metric of the values that will be shown.

Parameter:

metric - the metric to use

getMetric

public edu.hm.hafner.coverage.Metric getMetric()

getAllValues

public List<edu.hm.hafner.coverage.Value> getAllValues(Job<?,?> job)

Returns all available values for the specified baseline.

Parameter:

job - the job in the current row

Gibt zurück:

the available values

formatMetric

public String formatMetric(edu.hm.hafner.coverage.Value value)

Returns a formatted and localized String representation of the specified value (without metric).

Parameter:

value - the value to format

Gibt zurück:

the value formatted as a string

formatValue

public String formatValue(edu.hm.hafner.coverage.Value value)

Returns a formatted and localized String representation of the specified value (without metric).

Parameter:

value - the value to format

Gibt zurück:

the value formatted as a string

getCoverageText

public String getCoverageText(Job<?,?> job)

Provides a text which represents the coverage percentage of the selected coverage type and metric.

Parameter:

job - the job in the current row

Gibt zurück:

the coverage text

getCoverageValue

public Optional<? extends edu.hm.hafner.coverage.Value> getCoverageValue(Job<?,?> job)

Provides the coverage value of the selected coverage type and metric.

Parameter:

job - the job in the current row

Gibt zurück:

the coverage percentage

getDisplayColors

public ColorProvider.DisplayColors getDisplayColors(Job<?,?> job,
 Optional<? extends edu.hm.hafner.coverage.Value> coverage)

Provides the line color for representing the passed coverage value.

Parameter:

job - the job in the current row

coverage - The coverage value as percentage

Gibt zurück:

the line color as hex string

getRelativeCoverageUrl

public String getRelativeCoverageUrl(Job<?,?> job)

Provides the relative URL which can be used for accessing the coverage report.

Parameter:

job - the job in the current row

Gibt zurück:

the relative URL or an empty string when there is no matching URL

getBackgroundColorFillPercentage

public String getBackgroundColorFillPercentage(String percentage)

Transforms percentages with a ',' decimal separator to a representation using a '.' in order to use the percentage for styling HTML tags.

Parameter:

percentage - The text representation of a percentage

Gibt zurück:

the formatted percentage string