Package org.myire.scent.metrics

Class FieldMetrics

java.lang.Object

org.myire.scent.metrics.CodeElementMetrics

org.myire.scent.metrics.StatementElementMetrics

org.myire.scent.metrics.FieldMetrics

@NotThreadSafe
public class FieldMetrics
extends StatementElementMetrics

Source code metrics for a field, an enum constant or an annotation type element.

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

Author:

Peter Franzen

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
FieldMetrics.Kind	getKind()	Get the field's kind.

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

Methods inherited from class org.myire.scent.metrics.StatementElementMetrics

getStatements

Constructor Detail

FieldMetrics

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

Create a new FieldMetrics.

Parameters:

pName - The name of the field.

pKind - The field's kind.

Throws:

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

Method Detail

getKind

@Nonnull
public FieldMetrics.Kind getKind()

Get the field's kind.

Returns:

The field's kind, never null.