Package org.myire.scent.metrics

Class MethodMetrics

java.lang.Object

org.myire.scent.metrics.CodeElementMetrics

org.myire.scent.metrics.StatementElementMetrics

org.myire.scent.metrics.MethodMetrics

@NotThreadSafe
public class MethodMetrics
extends StatementElementMetrics

Source code metrics for a constructor, initializer, or method.

Instances of this class are not safe for use by multiple threads without external synchronization.

Author:

Peter Franzen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MethodMetrics.Kind	The kinds of method for which metrics are collected.

Constructor Summary

Constructors

Constructor	Description
MethodMetrics(java.lang.String pName, MethodMetrics.Kind pKind)	Create a new MethodMetrics.

Method Summary

Modifier and Type	Method	Description
void	add(TypeMetrics pLocalType)	Add metrics for a local type to this instance.
MethodMetrics.Kind	getKind()	Get the method's kind.
java.lang.Iterable<TypeMetrics>	getLocalTypes()	Get an Iterable that iterates over the metrics for each local type defined in the method.
int	getNumLocalTypes()	Get the number of local types defined in the method.

Methods inherited from class org.myire.scent.metrics.CodeElementMetrics

getComments, getName

Methods inherited from class java.lang.Object

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

Methods inherited from class org.myire.scent.metrics.StatementElementMetrics

getStatements

Constructor Detail

MethodMetrics

public MethodMetrics(@Nonnull
                     java.lang.String pName,
                     @Nonnull
                     MethodMetrics.Kind pKind)

Create a new MethodMetrics.

Parameters:

pName - The name of the method.

pKind - The method's kind.

Throws:

java.lang.NullPointerException - if any of the parameters is null.

Method Detail

getKind

@Nonnull
public MethodMetrics.Kind getKind()

Get the method's kind.

Returns:

The method's kind, never null.

getNumLocalTypes

public int getNumLocalTypes()

Get the number of local types defined in the method.

Returns:

The number of local types.

getLocalTypes

@Nonnull
public java.lang.Iterable<TypeMetrics> getLocalTypes()

Get an Iterable that iterates over the metrics for each local type defined in the method.

Returns:

An Iterable for the local types' metrics, never null.

add

public void add(@Nonnull
                TypeMetrics pLocalType)

Add metrics for a local type to this instance.

Parameters:

pLocalType - The local type metrics.

Throws:

java.lang.NullPointerException - if pLocalType is null.