MetricsMeasurement (Metrics Aggregation 0.2.0 API)

java.lang.Object
- io.jenkins.plugins.metrics.model.measurement.MetricsMeasurement

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ClassMetricsMeasurement, MethodMetricsMeasurement
```
public abstract class MetricsMeasurement
extends Object
implements Serializable
```
Measurement point of metrics. Combines the location of the measurement with the metrics measured there.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`className` The class name of the measurement.
`protected String`	`fileName` The file name of the measurement.
`protected Map<String,Metric>`	`metrics` The metrics reported for this measurement.
`protected String`	`packageName` The package name of the measurement.

Constructor Summary

Constructors
Constructor and Description

MetricsMeasurement()

Constructors
Constructor and Description
`MetricsMeasurement()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMetric(Metric metric)` Add a new `Metric`.
`String`	`getClassName()`
`String`	`getFileName()`
`Optional<Number>`	`getMetric(String id)` Get a metric based on its id.
`Map<String,Metric>`	`getMetrics()`
`String`	`getPackageName()`
`String`	`getQualifiedClassName()`
`abstract MetricsMeasurement`	`merge(MetricsMeasurement metricsMeasurement)` Merge a `MetricsMeasurement` with this one.
`void`	`setClassName(String className)`
`void`	`setFileName(String fileName)`
`void`	`setPackageName(String packageName)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - metrics
```
protected Map<String,Metric> metrics
```
    The metrics reported for this measurement.
  - fileName
```
protected String fileName
```
    The file name of the measurement.
  - packageName
```
protected String packageName
```
    The package name of the measurement.
  - className
```
protected String className
```
    The class name of the measurement.
- Constructor Detail
  - MetricsMeasurement
```
public MetricsMeasurement()
```
- Method Detail
  - getFileName
```
public String getFileName()
```
  - setFileName
```
public void setFileName(String fileName)
```
  - getPackageName
```
public String getPackageName()
```
  - setPackageName
```
public void setPackageName(String packageName)
```
  - getClassName
```
public String getClassName()
```
  - setClassName
```
public void setClassName(String className)
```
  - getQualifiedClassName
```
public String getQualifiedClassName()
```
  - addMetric
```
public void addMetric(Metric metric)
```
    Add a new Metric.
    
    Parameters:
    
    metric - the metric to add
  - getMetrics
```
public Map<String,Metric> getMetrics()
```
  - getMetric
```
public Optional<Number> getMetric(String id)
```
    Get a metric based on its id.
    
    Parameters:
    
    id - the id of the metric to look for
    
    Returns:
    
    an Optional containing the value of the metric, if it is present, an empty Optional otherwise
  - merge
```
public abstract MetricsMeasurement merge(MetricsMeasurement metricsMeasurement)
```
    Merge a MetricsMeasurement with this one.
    
    Parameters:
    
    metricsMeasurement - the MetricsMeasurement to merge
    
    Returns:
    
    the combined MetricsMeasurement

Class MetricsMeasurement

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

metrics

fileName

packageName

className

Constructor Detail

MetricsMeasurement

Method Detail

getFileName

setFileName

getPackageName

setPackageName

getClassName

setClassName

getQualifiedClassName

addMetric

getMetrics

getMetric

merge