net.openhft.chronicle.testframework.apimetrics

Interface Metric<T>

Type Parameters:

T - The type of element to which this metric can be applied.

public interface Metric<T>

The Metric interface provides a contract for defining metrics that can be applied to different types like classes, methods, and fields. This is used to measure various properties, such as visibility and extendability, based on defined weights for each metric.

Method Summary

Modifier and Type	Method and Description
boolean	isApplicable(T node) Checks whether the metric is applicable to the given node.
Class<T>	nodeType() Gets the class type that the metric is applicable to.
static <T> Metric<T>	of(Class<T> nodeType, Predicate<? super T> filter, String name, double weight) Factory method to create a new instance of a Metric with the given parameters.
double	weight() Gets the weight of the metric.

Method Detail

nodeType

Class<T> nodeType()

Gets the class type that the metric is applicable to.

Returns:

The class type.

isApplicable

boolean isApplicable(T node)

Checks whether the metric is applicable to the given node.

Parameters:

node - The node to check.

Returns:

True if the metric is applicable, false otherwise.

weight

double weight()

Gets the weight of the metric. The weight represents the importance or the value of the metric and can be used to calculate a cumulative score.

Returns:

The weight of the metric.

of

static <T> Metric<T> of(Class<T> nodeType,
                        Predicate<? super T> filter,
                        String name,
                        double weight)

Factory method to create a new instance of a Metric with the given parameters.

Type Parameters:

T - The type of element to which this metric can be applied.

Parameters:

nodeType - The class type of the element.

filter - The predicate to determine if the metric is applicable.

name - The name of the metric.

weight - The weight of the metric.

Returns:

A new Metric instance.