Package org.myire.scent.metrics

Class ModularCompilationUnitMetrics

java.lang.Object

org.myire.scent.metrics.CodeElementMetrics

org.myire.scent.metrics.ModularCompilationUnitMetrics

@NotThreadSafe
public class ModularCompilationUnitMetrics
extends CodeElementMetrics

Source code metrics for a modular compilation unit. These metrics contain metrics for the module declaration and metrics for any comments associated with the compilation 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
ModularCompilationUnitMetrics(java.lang.String pName, ModuleDeclarationMetrics pModule)	Create a new ModularCompilationUnitMetrics.

Method Summary

Modifier and Type	Method	Description
ModuleDeclarationMetrics	getModule()	Get the metrics for the module declaration enclosed 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

ModularCompilationUnitMetrics

public ModularCompilationUnitMetrics(@Nonnull
                                     java.lang.String pName,
                                     @Nonnull
                                     ModuleDeclarationMetrics pModule)

Create a new ModularCompilationUnitMetrics.

Parameters:

pName - The name of the compilation unit.

pModule - The metrics for the compilation unit's module declaration.

Throws:

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

Method Detail

getModule

@Nonnull
public ModuleDeclarationMetrics getModule()

Get the metrics for the module declaration enclosed within the compilation unit.

Returns:

The module declaration's metrics, never null.