Package net.sourceforge.pmd.lang.metrics

Language-independent framework to represent code metrics. If you want to compute code metrics in your rules, then you should find the language-specific enums containing MetricKeys in the relevant language modules.

Metrics are cached by default on the nodes they're computed on. Many APIs here are deprecated, this is because metrics were previously cached in big static maps, which is replaced by caching on nodes.

Interface Summary

Interface	Description
LanguageMetricsProvider<T extends QualifiableNode,O extends QualifiableNode>	Language-specific provider for metrics.
Metric<N extends Node>	Object computing a metric on a node.
MetricKey<N extends Node>	Key identifying a metric.
MetricMemoizer<N extends Node>	Deprecated. See package description
MetricOption	Option to pass to a metric.
MetricsComputer<T extends QualifiableNode,O extends QualifiableNode>	Deprecated. See package description
ProjectMemoizer<T extends QualifiableNode,O extends QualifiableNode>	Deprecated. See package description
SigMask<T extends Signature<?>>	Generic signature mask.
Signature<N extends SignedNode<N>>	Signature of a node.

Class Summary

Class	Description
AbstractMetric<N extends Node>	Abstract class for all metrics.
AbstractMetricsComputer<T extends QualifiableNode,O extends QualifiableNode>	Deprecated. See package description
AbstractMetricsFacade<T extends QualifiableNode,O extends QualifiableNode>	Deprecated. See package description
BasicMetricMemoizer<N extends Node>	Deprecated. See package description
BasicProjectMemoizer<T extends QualifiableNode,O extends QualifiableNode>	Deprecated. See package description
MetricKeyUtil	Holds the key creation method until we move it to the MetricKey interface.
MetricOptions	Bundles a set of options to pass to a metric.
MetricsUtil	Utilities to use Metric instances.
ParameterizedMetricKey<N extends Node>	Deprecated. Is internal API

Enum Summary

Enum	Description
ResultOption	Options to calculate a result aggregated on the operations of a class.