jetbrains.buildServer.serverSide

Class BuildMetric

java.lang.Object

jetbrains.buildServer.serverSide.BuildMetric

All Implemented Interfaces:

ServerExtension, TeamCityExtension

Direct Known Subclasses:

StatisticsBuildMetric

public abstract class BuildMetric
extends java.lang.Object
implements ServerExtension

A named build metric. Can calculate some number by build.

Since:

7.0

Author:

kir

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	myDescription
protected java.lang.String	myFormat
protected java.lang.String	myKey

Constructor Summary

Constructors

Constructor and Description
BuildMetric(java.lang.String key, java.lang.String description)
BuildMetric(java.lang.String key, java.lang.String description, java.lang.String format) Creates new build metric with the specified key, description and format

Method Summary

Modifier and Type	Method and Description
abstract java.math.BigDecimal	calculateMetric(SBuild build) Metric calculator
java.lang.String	getDescription() Human-readable metric description in lower case
java.lang.String	getFormat() Metric format used for metric value representation.
java.lang.String	getKey() Return metric key.

Methods inherited from class java.lang.Object

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

Field Detail

myKey

@NotNull
protected final java.lang.String myKey

myDescription

@NotNull
protected final java.lang.String myDescription

myFormat

@Nullable
protected final java.lang.String myFormat

Constructor Detail

BuildMetric

public BuildMetric(@NotNull
                   java.lang.String key,
                   @NotNull
                   java.lang.String description)

BuildMetric

public BuildMetric(@NotNull
                   java.lang.String key,
                   @NotNull
                   java.lang.String description,
                   @Nullable
                   java.lang.String format)

Creates new build metric with the specified key, description and format

Parameters:

key - getKey()

description - getDescription()

format - getFormat()

Method Detail

getKey

@NotNull
public java.lang.String getKey()

Return metric key. The key should be unique throughout the system. If two metrics have the same key, one of them will override another

Returns:

see above

getDescription

@NotNull
public java.lang.String getDescription()

Human-readable metric description in lower case

Returns:

see above

getFormat

@Nullable
public java.lang.String getFormat()

Metric format used for metric value representation. For supported formats see ValueType.getValueFormat()}

Returns:

see above

calculateMetric

@Nullable
public abstract java.math.BigDecimal calculateMetric(SBuild build)

Metric calculator

Returns:

metric value