io.jenkins.plugins.metrics.model.metric

Class MetricDefinition

java.lang.Object

io.jenkins.plugins.metrics.model.metric.MetricDefinition

All Implemented Interfaces:

Serializable

public class MetricDefinition
extends Object
implements Serializable

A definition of a metric.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricDefinition.Scope The scope of a MetricDefinition.

Constructor Summary

Constructors

Constructor and Description
MetricDefinition(String id) Create a new MetricDefinition.
MetricDefinition(String id, String displayName, String description, String reportedBy, int priority, MetricDefinition.Scope[] scopes) Create a new MetricDefinition.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDescription()
String	getDisplayName()
String	getId()
int	getPriority()
String	getReportedBy()
MetricDefinition.Scope[]	getScopes()
int	hashCode()
void	setDescription(String description)
void	setDisplayName(String displayName)
void	setId(String id)
void	setPriority(int priority)
void	setReportedBy(String reportedBy)
void	setScopes(MetricDefinition.Scope[] scopes)
String	toString()
boolean	validForScope(MetricDefinition.Scope scope) Determine if this MetricDefinition is valid for a certain MetricDefinition.Scope.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MetricDefinition

public MetricDefinition(String id)

Create a new MetricDefinition.

Parameters:

id - the id of the metric

MetricDefinition

public MetricDefinition(String id,
                        String displayName,
                        String description,
                        String reportedBy,
                        int priority,
                        MetricDefinition.Scope[] scopes)

Create a new MetricDefinition.

Parameters:

id - the id of the metric

displayName - the name to display

description - the description of the metric

reportedBy - the id of the tool which reported a metric

priority - the priority of a metric

scopes - the scopes of a metric (class, method, or both)

Method Detail

getDisplayName

public String getDisplayName()

setDisplayName

public void setDisplayName(String displayName)

getId

public String getId()

setId

public void setId(String id)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getReportedBy

public String getReportedBy()

setReportedBy

public void setReportedBy(String reportedBy)

getPriority

public int getPriority()

setPriority

public void setPriority(int priority)

getScopes

public MetricDefinition.Scope[] getScopes()

setScopes

public void setScopes(MetricDefinition.Scope[] scopes)

validForScope

public boolean validForScope(MetricDefinition.Scope scope)

Determine if this MetricDefinition is valid for a certain MetricDefinition.Scope.

Parameters:

scope - the MetricDefinition.Scope to check for

Returns:

true, if this MetricDefinition is valid for the provided MetricDefinition.Scope, false otherwise

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object