Package org.myire.scent.metrics

Class JavaMetrics

java.lang.Object

org.myire.scent.metrics.JavaMetrics

@NotThreadSafe
public class JavaMetrics
extends java.lang.Object

Source code metrics for a Java code base. The metrics are grouped by Java package, and each package's metrics contain the metrics for the individual compilation units declaring that they belong to the package in question.

In addition to the metrics grouped by package, an instance also contains metrics for any modular compilation units in the code base.

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

Author:

Peter Franzen

Constructor Summary

Constructors

Constructor	Description
JavaMetrics()

Method Summary

Modifier and Type	Method	Description
void	add(ModularCompilationUnitMetrics pMetrics)	Add metrics for a modular compilation unit to this instance.
java.lang.Iterable<ModularCompilationUnitMetrics>	getModularCompilationUnits()	Get an Iterable that iterates over the modular compilation unit metrics that have been collected in this instance.
int	getNumModularCompilationUnits()	Get the number of modular compilation units for which metrics have been collected in this instance.
int	getNumPackages()	Get the number of packages for which metrics have been collected in this instance.
java.lang.Iterable<PackageMetrics>	getPackages()	Get an Iterable that iterates over the package metrics that have been collected in this instance.
boolean	isEmpty()	Is this instance empty?
PackageMetrics	maybeCreate(java.lang.String pPackageName)	Get the PackageMetrics for a package with a specific name.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaMetrics

public JavaMetrics()

Method Detail

isEmpty

public boolean isEmpty()

Is this instance empty?

Returns:

True iff no package metrics or modular compilation unit metrics have been added to this instance.

getNumPackages

public int getNumPackages()

Get the number of packages for which metrics have been collected in this instance.

Returns:

The number of packages.

getPackages

@Nonnull
public java.lang.Iterable<PackageMetrics> getPackages()

Get an Iterable that iterates over the package metrics that have been collected in this instance.

Returns:

An Iterable for the package metrics, never null.

getNumModularCompilationUnits

public int getNumModularCompilationUnits()

Get the number of modular compilation units for which metrics have been collected in this instance.

Returns:

The number of modular compilation units.

getModularCompilationUnits

@Nonnull
public java.lang.Iterable<ModularCompilationUnitMetrics> getModularCompilationUnits()

Get an Iterable that iterates over the modular compilation unit metrics that have been collected in this instance.

Returns:

An Iterable for the modular compilation unit metrics, never null.

maybeCreate

@Nonnull
public PackageMetrics maybeCreate(@Nonnull
                                  java.lang.String pPackageName)

Get the PackageMetrics for a package with a specific name. If no package metrics with the specified name exists in this instance, a new PackageMetrics will be created and returned.

This method returns the same PackageMetrics instance when called repeatedly with the same package name.

Parameters:

pPackageName - The name of the package to get the PackageMetrics for. The default package is represented by an empty string.

Returns:

The PackageMetrics instance for the specified package name, never null.

add

public void add(@Nonnull
                ModularCompilationUnitMetrics pMetrics)

Add metrics for a modular compilation unit to this instance.

Parameters:

pMetrics - The modular compilation unit metrics.

Throws:

java.lang.NullPointerException - if pMetrics is null.