net.sourceforge.pmd.lang.java.oom.api

Enum ClassMetricKey

java.lang.Object

java.lang.Enum<ClassMetricKey>

net.sourceforge.pmd.lang.java.oom.api.ClassMetricKey

All Implemented Interfaces:

Serializable, Comparable<ClassMetricKey>, MetricKey<ClassMetric>

public enum ClassMetricKey
extends Enum<ClassMetricKey>
implements MetricKey<ClassMetric>

Keys identifying class metrics.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ATFD Access to Foreign Data.
CYCLO Cyclomatic complexity.
LOC Lines of Code.
NCSS Non Commenting Source Statements.
WMC Weighed Method Count.

Method Summary

Methods

Modifier and Type	Method and Description
ClassMetric	getCalculator() Returns the object used to calculate the metric.
static ClassMetricKey	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClassMetricKey[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sourceforge.pmd.lang.java.oom.api.MetricKey

name

Enum Constant Detail

ATFD

public static final ClassMetricKey ATFD

Access to Foreign Data.

WMC

public static final ClassMetricKey WMC

Weighed Method Count.

CYCLO

public static final ClassMetricKey CYCLO

Cyclomatic complexity.

NCSS

public static final ClassMetricKey NCSS

Non Commenting Source Statements.

LOC

public static final ClassMetricKey LOC

Lines of Code.

Method Detail

values

public static ClassMetricKey[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClassMetricKey c : ClassMetricKey.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ClassMetricKey valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getCalculator

public ClassMetric getCalculator()

Description copied from interface: MetricKey

Returns the object used to calculate the metric.

Specified by:

getCalculator in interface MetricKey<ClassMetric>

Returns:

The calculator.