Package org.myire.scent.metrics

Class PackageMetrics

java.lang.Object

org.myire.scent.metrics.CodeElementMetrics

org.myire.scent.metrics.PackageMetrics

@NotThreadSafe
public class PackageMetrics
extends CodeElementMetrics

Source code metrics for a java package. A package's metrics contain the metrics of all compilation units that have the same package declaration. It may also contain comments, e.g. JavaDocs, from a package declaration in a package-info.java file. Comments adjacent to the package declaration in any other compilation unit are not associated with the package but with the compilation unit.

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

Author:

Peter Franzen

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	add(CompilationUnitMetrics pCompilationUnit)	Add metrics for a compilation unit to this instance.
java.lang.Iterable<CompilationUnitMetrics>	getCompilationUnits()	Get an Iterable that iterates over the metrics for each compilation unit belonging to the package.
int	getNumCompilationUnits()	Get the number of compilation units that declare this package.

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

PackageMetrics

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

Create a new PackageMetrics.

Parameters:

pName - The name of the package.

Throws:

java.lang.NullPointerException - if pName is null.

Method Detail

getNumCompilationUnits

public int getNumCompilationUnits()

Get the number of compilation units that declare this package.

Returns:

The number of compilation units.

getCompilationUnits

@Nonnull
public java.lang.Iterable<CompilationUnitMetrics> getCompilationUnits()

Get an Iterable that iterates over the metrics for each compilation unit belonging to the package.

Returns:

An Iterable for the compilation units' metrics, never null.

add

public void add(@Nonnull
                CompilationUnitMetrics pCompilationUnit)

Add metrics for a compilation unit to this instance.

Parameters:

pCompilationUnit - The compilation unit metrics.

Throws:

java.lang.NullPointerException - if pCompilationUnit is null.