net.openhft.chronicle.testframework.apimetrics

Interface ApiMetrics.ApiMetricsBuilder

Enclosing interface:

ApiMetrics

public static interface ApiMetrics.ApiMetricsBuilder

Method Summary

Modifier and Type	Method and Description
ApiMetrics.ApiMetricsBuilder	addAccumulator(Supplier<Accumulator> accumulator)
ApiMetrics.ApiMetricsBuilder	addMetric(Metric<?> metric) Add the provided metric as applicable when analysing the set of packages.
default ApiMetrics.ApiMetricsBuilder	addPackage(Package paket) Adds the provided paket and all its underlying packages to the set of packages to analyze.
ApiMetrics.ApiMetricsBuilder	addPackage(String packageName) Adds the provided packageName and all its underlying packages to the set of packages to analyze.
default ApiMetrics.ApiMetricsBuilder	addPackageExclusion(Package paket) Adds the provided paket and all its underlying packages to the set of excluded packages not to analyze.
ApiMetrics.ApiMetricsBuilder	addPackageExclusion(String packageName) Adds the provided packageName and all its underlying packages to the set of excluded packages not to analyze.
ApiMetrics.ApiMetricsBuilder	addStandardAccumulators()
ApiMetrics.ApiMetricsBuilder	addStandardMetrics() Add a set of standard metrics as applicable when analysing the set of packages.
ApiMetrics	build() Analyses and returns ApiMetrics thereby applying all the metrics and accumulators to the set of packages to analyse.

Method Detail

addPackage

default ApiMetrics.ApiMetricsBuilder addPackage(Package paket)

Adds the provided paket and all its underlying packages to the set of packages to analyze.

Parameters:

paket - to analyze (non-null)

Returns:

this builder

addPackage

ApiMetrics.ApiMetricsBuilder addPackage(String packageName)

Adds the provided packageName and all its underlying packages to the set of packages to analyze.

Parameters:

packageName - to analyze (non-null)

Returns:

this builder

addPackageExclusion

default ApiMetrics.ApiMetricsBuilder addPackageExclusion(Package paket)

Adds the provided paket and all its underlying packages to the set of excluded packages not to analyze.

Parameters:

paket - not to analyze (non-null)

Returns:

this builder

addPackageExclusion

ApiMetrics.ApiMetricsBuilder addPackageExclusion(String packageName)

Adds the provided packageName and all its underlying packages to the set of excluded packages not to analyze.

Parameters:

packageName - not to analyze (non-null)

Returns:

this builder

addMetric

ApiMetrics.ApiMetricsBuilder addMetric(Metric<?> metric)

Add the provided metric as applicable when analysing the set of packages.

Parameters:

metric - to add (non-null)

Returns:

this builder

addStandardMetrics

ApiMetrics.ApiMetricsBuilder addStandardMetrics()

Add a set of standard metrics as applicable when analysing the set of packages.

Returns:

this builder

addAccumulator

ApiMetrics.ApiMetricsBuilder addAccumulator(Supplier<Accumulator> accumulator)

addStandardAccumulators

ApiMetrics.ApiMetricsBuilder addStandardAccumulators()

build

ApiMetrics build()

Analyses and returns ApiMetrics thereby applying all the metrics and accumulators to the set of packages to analyse.

Returns:

the ApiMetrics