Package net.sourceforge.pmd.lang.java.metrics.api

Enum JavaClassMetricKey

java.lang.Object

java.lang.Enum<JavaClassMetricKey>

net.sourceforge.pmd.lang.java.metrics.api.JavaClassMetricKey

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JavaClassMetricKey>, net.sourceforge.pmd.lang.metrics.MetricKey<ASTAnyTypeDeclaration>

public enum JavaClassMetricKey
extends java.lang.Enum<JavaClassMetricKey>
implements net.sourceforge.pmd.lang.metrics.MetricKey<ASTAnyTypeDeclaration>

Keys identifying standard class metrics.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ATFD	Access to Foreign Data.
LOC	Lines of Code.
NCSS	Non Commenting Source Statements.
NOAM	Number of Accessor Methods.
NOPA	Number of Public Attributes.
TCC	Tight Class Cohesion.
WMC	Weighed Method Count.
WOC	Weight of class.

Method Summary

Modifier and Type	Method	Description
JavaClassMetric	getCalculator()
boolean	supports(ASTAnyTypeDeclaration node)
static JavaClassMetricKey	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static JavaClassMetricKey[]	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 interface net.sourceforge.pmd.lang.metrics.MetricKey

name

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ATFD

public static final JavaClassMetricKey ATFD

Access to Foreign Data.

See Also:

AtfdMetric

WMC

public static final JavaClassMetricKey WMC

Weighed Method Count.

See Also:

WmcMetric

NCSS

public static final JavaClassMetricKey NCSS

Non Commenting Source Statements.

See Also:

NcssMetric

LOC

public static final JavaClassMetricKey LOC

Lines of Code.

See Also:

LocMetric

NOPA

public static final JavaClassMetricKey NOPA

Number of Public Attributes.

See Also:

NopaMetric

NOAM

public static final JavaClassMetricKey NOAM

Number of Accessor Methods.

See Also:

NopaMetric

WOC

public static final JavaClassMetricKey WOC

Weight of class.

See Also:

WocMetric

TCC

public static final JavaClassMetricKey TCC

Tight Class Cohesion.

See Also:

TccMetric

Method Detail

values

public static JavaClassMetricKey[] 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 (JavaClassMetricKey c : JavaClassMetricKey.values())
    System.out.println(c);

Returns:

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

valueOf

public static JavaClassMetricKey valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getCalculator

public JavaClassMetric getCalculator()

Specified by:

getCalculator in interface net.sourceforge.pmd.lang.metrics.MetricKey<ASTAnyTypeDeclaration>

supports

public boolean supports(ASTAnyTypeDeclaration node)

Specified by:

supports in interface net.sourceforge.pmd.lang.metrics.MetricKey<ASTAnyTypeDeclaration>