Package org.myire.scent.metrics

Class TypeMetrics

java.lang.Object

org.myire.scent.metrics.CodeElementMetrics

org.myire.scent.metrics.TypeMetrics

@NotThreadSafe
public class TypeMetrics
extends CodeElementMetrics

Source code metrics for a class, an interface, an enum, or an annotation. These metrics are a container for the metrics of the type's fields, methods and inner types.

Author:

Peter Franzen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TypeMetrics.Kind	The kinds of type for which metrics are collected.

Constructor Summary

Constructors

Constructor	Description
TypeMetrics(java.lang.String pName, TypeMetrics.Kind pKind)	Create a new TypeMetrics.

Method Summary

Modifier and Type	Method	Description
void	add(FieldMetrics pField)	Add metrics for a field to this instance.
void	add(MethodMetrics pMethod)	Add metrics for a method to this instance.
void	add(TypeMetrics pInnerType)	Add metrics for an inner type to this instance.
java.lang.Iterable<FieldMetrics>	getFields()	Get an Iterable that iterates over the metrics for each field defined within the type.
java.lang.Iterable<TypeMetrics>	getInnerTypes()	Get an Iterable that iterates over the metrics for each inner type defined within this type.
TypeMetrics.Kind	getKind()	Get the type's kind.
java.lang.Iterable<MethodMetrics>	getMethods()	Get an Iterable that iterates over the metrics for each method defined within the type.
int	getNumFields()	Get the number of fields defined within the type.
int	getNumInnerTypes()	Get the number of inner types defined within this type.
int	getNumMethods()	Get the number of methods defined within the type.

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

TypeMetrics

public TypeMetrics(@Nonnull
                   java.lang.String pName,
                   @Nonnull
                   TypeMetrics.Kind pKind)

Create a new TypeMetrics.

Parameters:

pName - The name of the type.

pKind - The type's kind.

Throws:

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

Method Detail

getKind

@Nonnull
public TypeMetrics.Kind getKind()

Get the type's kind.

Returns:

The type's kind, never null.

getNumFields

public int getNumFields()

Get the number of fields defined within the type.

Returns:

The number of fields.

getFields

@Nonnull
public java.lang.Iterable<FieldMetrics> getFields()

Get an Iterable that iterates over the metrics for each field defined within the type.

Returns:

An Iterable for the fields' metrics, never null.

getNumMethods

public int getNumMethods()

Get the number of methods defined within the type.

Returns:

The number of methods.

getMethods

@Nonnull
public java.lang.Iterable<MethodMetrics> getMethods()

Get an Iterable that iterates over the metrics for each method defined within the type.

Returns:

An Iterable for the methods' metrics, never null.

getNumInnerTypes

public int getNumInnerTypes()

Get the number of inner types defined within this type.

Returns:

The number of inner types.

getInnerTypes

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

Get an Iterable that iterates over the metrics for each inner type defined within this type.

Returns:

An Iterable for the inner types' metrics, never null.

add

public void add(@Nonnull
                FieldMetrics pField)

Add metrics for a field to this instance.

Parameters:

pField - The field metrics.

Throws:

java.lang.NullPointerException - if pField is null.

add

public void add(@Nonnull
                MethodMetrics pMethod)

Add metrics for a method to this instance.

Parameters:

pMethod - The method metrics.

Throws:

java.lang.NullPointerException - if pMethod is null.

add

public void add(@Nonnull
                TypeMetrics pInnerType)

Add metrics for an inner type to this instance.

Parameters:

pInnerType - The inner type metrics.

Throws:

java.lang.NullPointerException - if pInnerType is null.