net.openhft.chronicle.testframework.apimetrics

Interface ApiMetrics.ApiMetricsBuilder

Enclosing interface:

ApiMetrics

public static interface ApiMetrics.ApiMetricsBuilder

Interface for a builder that allows constructing an ApiMetrics object. This builder allows the specification of packages to analyze, packages to exclude from analysis, metrics to apply, and accumulators for aggregating metrics. The build method applies all the specifications and returns the final ApiMetrics object.

Method Summary

Modifier and Type	Method and Description
ApiMetrics.ApiMetricsBuilder	addAccumulator(Supplier<Accumulator> accumulator) Adds the supplied accumulator to the builder.
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() Adds a set of standard accumulators to the builder.
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. This method helps in specifying the packages that need to be included in the metrics analysis.

Parameters:

paket - Package 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. This method helps in specifying the packages that need to be included in the metrics analysis by name.

Parameters:

packageName - String representing the package 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. This method helps in specifying the packages that should be excluded from the metrics analysis.

Parameters:

paket - Package 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. This method helps in specifying the packages that should be excluded from the metrics analysis by name.

Parameters:

packageName - String representing the package 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. This allows customization of the metrics used in the analysis.

Parameters:

metric - 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. This method includes a predefined set of metrics suitable for general analysis.

Returns:

this builder

addAccumulator

ApiMetrics.ApiMetricsBuilder addAccumulator(Supplier<Accumulator> accumulator)

Adds the supplied accumulator to the builder. Accumulators help in aggregating metrics over a specified set of classes, methods, or fields.

Parameters:

accumulator - Supplier for the Accumulator to be added

Returns:

this builder

addStandardAccumulators

ApiMetrics.ApiMetricsBuilder addStandardAccumulators()

Adds a set of standard accumulators to the builder. Standard accumulators provide common aggregation functionalities for metrics analysis.

Returns:

this builder

build

ApiMetrics build()

Analyses and returns ApiMetrics thereby applying all the metrics and accumulators to the set of packages to analyse. This method constructs and returns the final ApiMetrics object, ready for use.

Returns:

the ApiMetrics