io.jenkins.plugins.metrics.column

Class ProjectMetricsColumn

java.lang.Object

hudson.views.ListViewColumn

io.jenkins.plugins.metrics.column.ProjectMetricsColumn

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.views.ListViewColumn>

public class ProjectMetricsColumn
extends hudson.views.ListViewColumn

Column for displaying metrics in the project overview.

Author:

Andreas Pabst

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProjectMetricsColumn.MetricsTableColumnDescriptor Extension point registration.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class 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

Constructor Summary

Constructors

Constructor and Description
ProjectMetricsColumn() Create a new ProjectMetricsColumn.

Method Summary

Modifier and Type	Method and Description
String	getMetricId()
Optional<String>	getMetricValue(hudson.model.Job<?,?> job) Returns the total number of issues for the selected static analysis tool in a given job.
String	getName()
String	getUrl(hudson.model.Job<?,?> job) Returns the URL to the metrics view of a run.
void	setMetricId(String metricId) Defines which metric should be shown in the column.
void	setName(String name) Sets the display name of the column.

Methods inherited from class hudson.views.ListViewColumn

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectMetricsColumn

@DataBoundConstructor
public ProjectMetricsColumn()

Create a new ProjectMetricsColumn.

Method Detail

getName

public String getName()

setName

@DataBoundSetter
public void setName(String name)

Sets the display name of the column.

Parameters:

name - the name of the column

getMetricId

public String getMetricId()

setMetricId

@DataBoundSetter
public void setMetricId(String metricId)

Defines which metric should be shown in the column.

Parameters:

metricId - the metric id to show

getMetricValue

public Optional<String> getMetricValue(hudson.model.Job<?,?> job)

Returns the total number of issues for the selected static analysis tool in a given job.

Parameters:

job - the job to select

Returns:

the number of issues for a tool in a given job

getUrl

public String getUrl(hudson.model.Job<?,?> job)

Returns the URL to the metrics view of a run.

Parameters:

job - the job to select

Returns:

the URL to the metrics