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

Class CoverageAppearanceConfiguration

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

io.jenkins.plugins.util.GlobalConfigurationItem

io.jenkins.plugins.coverage.metrics.steps.CoverageAppearanceConfiguration

All Implemented Interfaces:

ExtensionPoint, Describable<GlobalConfiguration>, Saveable, Loadable, OnMaster

@Extension
@Symbol("coverage")
public class CoverageAppearanceConfiguration
extends io.jenkins.plugins.util.GlobalConfigurationItem

Global appearance configuration for the Coverage Plugin.

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
CoverageAppearanceConfiguration()	Creates the global configuration and loads the initial values from the corresponding XML file.

Method Summary

Modifier and Type	Method	Description
ListBoxModel	doFillDefaultMetricItems()	Returns a model with all metrics that can be used in the column.
GlobalConfigurationCategory	getCategory()
edu.hm.hafner.coverage.Metric	getDefaultMetric()	Returns the default metric to be used.
String	getDefaultName()	Returns the default name for the coverage column.
static CoverageAppearanceConfiguration	getInstance()	Returns the singleton instance of this CoverageAppearanceConfiguration.
boolean	isEnableColumnByDefault()	Returns whether the coverage column should be displayed by default.
void	setDefaultMetric(edu.hm.hafner.coverage.Metric defaultMetric)	Sets the default metric to be used.
void	setDefaultName(String defaultName)	Sets the default name for the coverage column.
void	setEnableColumnByDefault(boolean enableColumnByDefault)	Enables or disables the coverage column by default.

Methods inherited from class io.jenkins.plugins.util.GlobalConfigurationItem

clearRepeatableProperties, configure, load, readResolve, save

Methods inherited from class jenkins.model.GlobalConfiguration

all, configure, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, newInstance, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Details

CoverageAppearanceConfiguration

@DataBoundConstructor
public CoverageAppearanceConfiguration()

Creates the global configuration and loads the initial values from the corresponding XML file.

Method Details

getInstance

public static CoverageAppearanceConfiguration getInstance()

Returns the singleton instance of this CoverageAppearanceConfiguration.

Returns:

the singleton instance

getCategory

@NonNull
public GlobalConfigurationCategory getCategory()

Overrides:

getCategory in class Descriptor<GlobalConfiguration>

isEnableColumnByDefault

public boolean isEnableColumnByDefault()

Returns whether the coverage column should be displayed by default.

Returns:

true if the coverage column is shown by default, false otherwise

setEnableColumnByDefault

@DataBoundSetter
public void setEnableColumnByDefault(boolean enableColumnByDefault)

Enables or disables the coverage column by default.

Parameters:

enableColumnByDefault - true to enable the coverage column by default, false to disable it

getDefaultMetric

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

Returns the default metric to be used.

Returns:

the default metric

setDefaultMetric

@DataBoundSetter
public void setDefaultMetric(edu.hm.hafner.coverage.Metric defaultMetric)

Sets the default metric to be used.

Parameters:

defaultMetric - the default metric to use

getDefaultName

public String getDefaultName()

Returns the default name for the coverage column.

Returns:

the default name for the coverage column

setDefaultName

@DataBoundSetter
public void setDefaultName(String defaultName)

Sets the default name for the coverage column.

Parameters:

defaultName - the default name for the coverage column

doFillDefaultMetricItems

@POST
public ListBoxModel doFillDefaultMetricItems()

Returns a model with all metrics that can be used in the column.

Returns:

a model with all metrics.