Package net.sourceforge.pmd.lang.metrics

Class AbstractMetricsFacade<T extends QualifiableNode,O extends QualifiableNode>

java.lang.Object

net.sourceforge.pmd.lang.metrics.AbstractMetricsFacade<T,O>

Type Parameters:

T - Type of type declaration nodes of the language

O - Type of operation declaration nodes of the language

public abstract class AbstractMetricsFacade<T extends QualifiableNode,O extends QualifiableNode>
extends Object

Base class for a façade that can compute metrics for types, operations and compute aggregate results with a result option.

Since:

6.0.0

Author:

Clément Fournier

Constructor Summary

Constructors

Constructor	Description
AbstractMetricsFacade()

Method Summary

Modifier and Type	Method	Description
double	computeForOperation(MetricKey<O> key, O node, MetricOptions options)	Computes a metric identified by its key on a operation AST node.
double	computeForType(MetricKey<T> key, T node, MetricOptions options)	Computes a metric identified by its code on a class AST node, possibly selecting a variant with the MetricOptions parameter.
double	computeWithResultOption(MetricKey<O> key, T node, MetricOptions options, ResultOption resultOption)	Compute the sum, average, or highest value of the operation metric on all operations of the class node.
protected abstract MetricsComputer<T,O>	getLanguageSpecificComputer()	Gets the language specific metrics computer.
protected abstract ProjectMemoizer<T,O>	getLanguageSpecificProjectMemoizer()	Gets the language-specific project memoizer.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMetricsFacade

public AbstractMetricsFacade()

Method Detail

getLanguageSpecificComputer

protected abstract MetricsComputer<T,O> getLanguageSpecificComputer()

Gets the language specific metrics computer.

Returns:

The metrics computer

getLanguageSpecificProjectMemoizer

protected abstract ProjectMemoizer<T,O> getLanguageSpecificProjectMemoizer()

Gets the language-specific project memoizer.

Returns:

The project memoizer

computeForType

public double computeForType(MetricKey<T> key,
                             T node,
                             MetricOptions options)

Computes a metric identified by its code on a class AST node, possibly selecting a variant with the MetricOptions parameter.

Parameters:

key - The key identifying the metric to be computed

node - The node on which to compute the metric

options - The options of the metric

Returns:

The value of the metric, or Double.NaN if the value couldn't be computed

computeForOperation

public double computeForOperation(MetricKey<O> key,
                                  O node,
                                  MetricOptions options)

Computes a metric identified by its key on a operation AST node.

Parameters:

key - The key identifying the metric to be computed

node - The node on which to compute the metric

options - The options of the metric

Returns:

The value of the metric, or Double.NaN if the value couldn't be computed

computeWithResultOption

public double computeWithResultOption(MetricKey<O> key,
                                      T node,
                                      MetricOptions options,
                                      ResultOption resultOption)

Compute the sum, average, or highest value of the operation metric on all operations of the class node. The type of operation is specified by the ResultOption parameter.

Parameters:

key - The key identifying the metric to be computed

node - The node on which to compute the metric

resultOption - The result option to use

options - The options of the metric

Returns:

The value of the metric, or Double.NaN if the value couldn't be computed or resultOption is null