net.sourceforge.pmd.lang.java.oom.metrics

Class LocMetric

java.lang.Object

net.sourceforge.pmd.lang.java.oom.AbstractMetric

net.sourceforge.pmd.lang.java.oom.metrics.LocMetric

All Implemented Interfaces:

ClassMetric, Metric, OperationMetric

public final class LocMetric
extends AbstractMetric
implements ClassMetric, OperationMetric

Lines of Code. Equates the length in lines of code of the measured entity, counting everything including blank lines and comments from the class declaration to the last closing brace. Import statements are not counted, for nested classes to be comparable to outer ones.

Since:

June 2017

Author:

Clément Fournier

See Also:

NcssMetric

Nested Class Summary

Nested classes/interfaces inherited from interface net.sourceforge.pmd.lang.java.oom.api.Metric

Metric.Version

Constructor Summary

Constructors

Constructor and Description
LocMetric()

Method Summary

Methods

Modifier and Type	Method and Description
double	computeFor(ASTClassOrInterfaceDeclaration node, MetricVersion version) Actually computes the value of a metric for an AST node.
double	computeFor(ASTMethodOrConstructorDeclaration node, MetricVersion version) Actually computes the value of a metric for an AST node.
boolean	supports(AccessNode node) Default implementation of the supports method, which filters out abstract nodes.

Methods inherited from class net.sourceforge.pmd.lang.java.oom.AbstractMetric

averageMetricOverOperations, findAllCalls, findOperations, getTopLevelPackageStats, highestMetricOverOperations, sumMetricOverOperations

Methods inherited from class java.lang.Object

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

Constructor Detail

LocMetric

public LocMetric()

Method Detail

supports

public boolean supports(AccessNode node)

Description copied from class: AbstractMetric

Default implementation of the supports method, which filters out abstract nodes. Metrics that support abstract nodes should override this method.

Specified by:

supports in interface Metric

Overrides:

supports in class AbstractMetric

Parameters:

node - The node to check.

Returns:

True if the metric can be computed on this node.

computeFor

public double computeFor(ASTClassOrInterfaceDeclaration node,
                MetricVersion version)

Description copied from interface: ClassMetric

Actually computes the value of a metric for an AST node.

Specified by:

computeFor in interface ClassMetric

Parameters:

node - The node.

version - The version of the metric.

Returns:

The value of the metric.

computeFor

public double computeFor(ASTMethodOrConstructorDeclaration node,
                MetricVersion version)

Description copied from interface: OperationMetric

Actually computes the value of a metric for an AST node.

Specified by:

computeFor in interface OperationMetric

Parameters:

node - The node.

version - The version of the metric.

Returns:

The value of the metric.