net.sourceforge.pmd.lang.java.oom

Class Metrics

java.lang.Object

net.sourceforge.pmd.lang.java.oom.Metrics

public final class Metrics
extends Object

User bound façade of the Metrics Framework. Provides a uniform interface for the calculation of metrics.

Author:

Clément Fournier

Method Summary

Methods

Modifier and Type	Method and Description
static double	get(ClassMetricKey key, ASTClassOrInterfaceDeclaration node) Computes the standard value of the metric identified by its code on a class AST node.
static double	get(ClassMetricKey key, ASTClassOrInterfaceDeclaration node, MetricVersion version) Computes a metric identified by its code on a class AST node, possibly selecting a variant with the MetricVersion parameter.
static double	get(OperationMetricKey key, ASTClassOrInterfaceDeclaration node, MetricVersion version, ResultOption option) Compute the sum, average, or highest value of the operation metric on all operations of the class node.
static double	get(OperationMetricKey key, ASTMethodOrConstructorDeclaration node) Computes the standard version of the metric identified by the key on a operation AST node.
static double	get(OperationMetricKey key, ASTMethodOrConstructorDeclaration node, MetricVersion version) Computes a metric identified by its key on a operation AST node.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static double get(ClassMetricKey key,
         ASTClassOrInterfaceDeclaration node)

Computes the standard value of the metric identified by its code on a class AST node.

Parameters:

key - The key identifying the metric to be computed

node - The node on which to compute the metric

Returns:

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

get

public static double get(ClassMetricKey key,
         ASTClassOrInterfaceDeclaration node,
         MetricVersion version)

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

Parameters:

key - The key identifying the metric to be computed

node - The node on which to compute the metric

version - The version of the metric.

Returns:

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

get

public static double get(OperationMetricKey key,
         ASTMethodOrConstructorDeclaration node)

Computes the standard version of the metric identified by the 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

Returns:

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

get

public static double get(OperationMetricKey key,
         ASTMethodOrConstructorDeclaration node,
         MetricVersion version)

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

version - The version of the metric.

Returns:

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

get

public static double get(OperationMetricKey key,
         ASTClassOrInterfaceDeclaration node,
         MetricVersion version,
         ResultOption option)

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

version - The version of the metric.

option - The result option to use.

Returns:

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