Package org.myire.scent.metrics

Class CompilationUnitMetrics

java.lang.Object

org.myire.scent.metrics.CodeElementMetrics

org.myire.scent.metrics.CompilationUnitMetrics

@NotThreadSafe
public class CompilationUnitMetrics
extends CodeElementMetrics

Source code metrics for an ordinary compilation unit. These metrics contain the type(s) declared within the compilation unit and any comments associated with the unit itself, such as a file header.

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

Author:

Peter Franzen

Constructor Summary

Constructors

Constructor	Description
CompilationUnitMetrics(java.lang.String pName)	Create a new CompilationUnitMetrics.

Method Summary

Modifier and Type	Method	Description
void	add(TypeMetrics pType)	Add metrics for a type to this instance.
int	getNumTypes()	Get the number of types declared within the compilation unit.
java.lang.Iterable<TypeMetrics>	getTypes()	Get an Iterable that iterates over the metrics for each type contained within the compilation unit.

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

Constructor Detail

CompilationUnitMetrics

public CompilationUnitMetrics(@Nonnull
                              java.lang.String pName)

Create a new CompilationUnitMetrics.

Parameters:

pName - The name of the compilation unit.

Throws:

java.lang.NullPointerException - if pName is null.

Method Detail

getNumTypes

public int getNumTypes()

Get the number of types declared within the compilation unit.

Returns:

The number of types.

getTypes

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

Get an Iterable that iterates over the metrics for each type contained within the compilation unit.

Returns:

An Iterable for the types' metrics, never null.

add

public void add(@Nonnull
                TypeMetrics pType)

Add metrics for a type to this instance.

Parameters:

pType - The type metrics.

Throws:

java.lang.NullPointerException - if pType is null.