Package org.myire.scent.metrics

Class CodeElementMetrics

java.lang.Object

org.myire.scent.metrics.CodeElementMetrics

Direct Known Subclasses:

CompilationUnitMetrics, ModularCompilationUnitMetrics, ModuleDeclarationMetrics, PackageMetrics, StatementElementMetrics, TypeMetrics

@NotThreadSafe
public class CodeElementMetrics
extends java.lang.Object

Base class for metrics associated with a source code element such as a compilation unit, a field or a method. A source code element has a name and holds metrics for any comments associated with the element.

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

Author:

Peter Franzen

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CodeElementMetrics(java.lang.String pName)	Create a new CodeElementMetrics.

Method Summary

Modifier and Type	Method	Description
CommentMetrics	getComments()	Get the comment metrics associated with this code element.
java.lang.String	getName()	Get the name of this code element.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeElementMetrics

protected CodeElementMetrics(@Nonnull
                             java.lang.String pName)

Create a new CodeElementMetrics.

Parameters:

pName - The name of the code element.

Throws:

java.lang.NullPointerException - if pName is null.

Method Detail

getName

@Nonnull
public java.lang.String getName()

Get the name of this code element.

Returns:

The name, never null.

getComments

@Nonnull
public CommentMetrics getComments()

Get the comment metrics associated with this code element.

Returns:

The comment metrics, never null.