Package net.sourceforge.pmd.lang.metrics.internal

Class AbstractLanguageMetricsProvider<T extends QualifiableNode,O extends QualifiableNode>

java.lang.Object

net.sourceforge.pmd.lang.metrics.internal.AbstractLanguageMetricsProvider<T,O>

All Implemented Interfaces:

LanguageMetricsProvider<T,O>

public abstract class AbstractLanguageMetricsProvider<T extends QualifiableNode,O extends QualifiableNode>
extends Object
implements LanguageMetricsProvider<T,O>

Base implementation for LanguageMetricsProvider.

Since:

6.11.0

Author:

Clément Fournier

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractLanguageMetricsProvider(Class<T> tClass, Class<O> oClass)

Method Summary

Modifier and Type	Method	Description
O	asOperationNode(Node anyNode)	Returns the given node casted to LanguageMetricsProvider if it's of the correct type, otherwise returns null.
T	asTypeNode(Node anyNode)	Returns the given node casted to LanguageMetricsProvider if it's of the correct type, otherwise returns null.
Map<MetricKey<?>,Double>	computeAllMetricsFor(Node node)	Computes all metrics available on the given node.
double	computeForOperation(MetricKey<O> key, O node, MetricOptions options)	Like MetricsComputer.computeForOperation(MetricKey, QualifiableNode, boolean, MetricOptions, MetricMemoizer) but performs no memoisation.
double	computeForType(MetricKey<T> key, T node, MetricOptions options)	Like MetricsComputer.computeForType(MetricKey, QualifiableNode, boolean, MetricOptions, MetricMemoizer), but performs no memoisation.
double	computeWithResultOption(MetricKey<O> key, T node, MetricOptions options, ResultOption resultOption)	Like MetricsComputer.computeWithResultOption(MetricKey, QualifiableNode, boolean, MetricOptions, ResultOption, ProjectMemoizer) but performs no memoisation.
protected abstract List<O>	findOps(T t)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.pmd.lang.metrics.LanguageMetricsProvider

getAvailableOperationMetrics, getAvailableTypeMetrics

Constructor Detail

AbstractLanguageMetricsProvider

protected AbstractLanguageMetricsProvider(Class<T> tClass,
                                          Class<O> oClass)

Method Detail

asTypeNode

public T asTypeNode(Node anyNode)

Description copied from interface: LanguageMetricsProvider

Returns the given node casted to LanguageMetricsProvider if it's of the correct type, otherwise returns null.

Specified by:

asTypeNode in interface LanguageMetricsProvider<T extends QualifiableNode,O extends QualifiableNode>

asOperationNode

public O asOperationNode(Node anyNode)

Description copied from interface: LanguageMetricsProvider

Returns the given node casted to LanguageMetricsProvider if it's of the correct type, otherwise returns null.

Specified by:

asOperationNode in interface LanguageMetricsProvider<T extends QualifiableNode,O extends QualifiableNode>

computeForType

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

Description copied from interface: LanguageMetricsProvider

Like MetricsComputer.computeForType(MetricKey, QualifiableNode, boolean, MetricOptions, MetricMemoizer), but performs no memoisation.

Specified by:

computeForType in interface LanguageMetricsProvider<T extends QualifiableNode,O extends QualifiableNode>

computeForOperation

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

Description copied from interface: LanguageMetricsProvider

Like MetricsComputer.computeForOperation(MetricKey, QualifiableNode, boolean, MetricOptions, MetricMemoizer) but performs no memoisation.

Specified by:

computeForOperation in interface LanguageMetricsProvider<T extends QualifiableNode,O extends QualifiableNode>

computeWithResultOption

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

Description copied from interface: LanguageMetricsProvider

Like MetricsComputer.computeWithResultOption(MetricKey, QualifiableNode, boolean, MetricOptions, ResultOption, ProjectMemoizer) but performs no memoisation.

Specified by:

computeWithResultOption in interface LanguageMetricsProvider<T extends QualifiableNode,O extends QualifiableNode>

findOps

protected abstract List<O> findOps(T t)

computeAllMetricsFor

public Map<MetricKey<?>,Double> computeAllMetricsFor(Node node)

Description copied from interface: LanguageMetricsProvider

Computes all metrics available on the given node. The returned results may contain Double.NaN as a value.

Specified by:

computeAllMetricsFor in interface LanguageMetricsProvider<T extends QualifiableNode,O extends QualifiableNode>

Parameters:

node - Node to inspect

Returns:

A map of metric key to their result, possibly empty, but with no null value