Package org.myire.scent.metrics

Class AggregatedMetrics

java.lang.Object

org.myire.scent.metrics.AggregatedMetrics

@NotThreadSafe
public class AggregatedMetrics
extends java.lang.Object

An aggregation of several source code metrics instances.

Author:

Peter Franzen

Constructor Summary

Constructors

Constructor	Description
AggregatedMetrics()

Method Summary

Modifier and Type	Method	Description
AggregatedMetrics	add(CommentMetrics pValues)	Add the values of a CommentMetrics to this aggregation.
AggregatedMetrics	add(CompilationUnitMetrics pValues)	Add a CompilationUnitMetrics to this aggregation.
AggregatedMetrics	add(FieldMetrics pValues)	Add a FieldMetrics to this aggregation.
AggregatedMetrics	add(MethodMetrics pValues)	Add a MethodMetrics to this aggregation.
AggregatedMetrics	add(ModularCompilationUnitMetrics pValues)	Add a ModularCompilationUnitMetrics to this aggregation.
AggregatedMetrics	add(PackageMetrics pValues)	Add a PackageMetrics to this aggregation.
AggregatedMetrics	add(StatementMetrics pValues)	Add the values of a StatementMetrics to this aggregation.
AggregatedMetrics	add(TypeMetrics pValues)	Add a TypeMetrics to this aggregation.
AggregatedMetrics	addChildren(CompilationUnitMetrics pValues)	Add the comments and types of a CompilationUnitMetrics to this aggregation.
AggregatedMetrics	addChildren(FieldMetrics pValues)	Add the statements and comments of a FieldMetrics to this aggregation.
AggregatedMetrics	addChildren(MethodMetrics pValues)	Add the statements and comments of a MethodMetrics to this aggregation.
AggregatedMetrics	addChildren(PackageMetrics pValues)	Add the compilation units of a PackageMetrics to this aggregation.
AggregatedMetrics	addChildren(TypeMetrics pValues)	Add the comments and members of a TypeMetrics to this aggregation.
int	getBlockCommentsLength()	Get the length of the block comments' content in this aggregation.
int	getJavaDocCommentsLength()	Get the length of the JavaDoc comments' content in this aggregation.
int	getLineCommentsLength()	Get the length of the line comments' content in this aggregation.
int	getNumBlockCommentLines()	Get the number of block comment lines in this aggregation.
int	getNumBlockComments()	Get the number of block comments in this aggregation.
int	getNumCompilationUnits()	Get the number of compilation units in this aggregation.
int	getNumFields()	Get the number of fields in this aggregation.
int	getNumJavaDocComments()	Get the number of JavaDoc comments in this aggregation.
int	getNumJavaDocLines()	Get the number of JavaDoc comment lines in this aggregation.
int	getNumLineComments()	Get the number of line comments in this aggregation.
int	getNumMethods()	Get the number of methods in this aggregation.
int	getNumModularCompilationUnits()	Get the number of modular compilation units in this aggregation.
int	getNumPackages()	Get the number of packages in this aggregation.
int	getNumStatements()	Get the number of statements in this aggregation.
int	getNumTypes()	Get the number of types in this aggregation.
static AggregatedMetrics	of(CompilationUnitMetrics pValues)	Create a new AggregatedMetrics and add the values from a CompilationUnitMetrics to the aggregation.
static AggregatedMetrics	of(FieldMetrics pValues)	Create a new AggregatedMetrics and add the values of a FieldMetrics to the aggregation.
static AggregatedMetrics	of(JavaMetrics pValues)	Create a new AggregatedMetrics and add the values from a JavaMetrics to the aggregation.
static AggregatedMetrics	of(MethodMetrics pValues)	Create a new AggregatedMetrics and add the values from a MethodMetrics to the aggregation.
static AggregatedMetrics	of(PackageMetrics pValues)	Create a new AggregatedMetrics and add the values from a PackageMetrics to the aggregation.
static AggregatedMetrics	of(TypeMetrics pValues)	Create a new AggregatedMetrics and add the values from a TypeMetrics to the aggregation.
static AggregatedMetrics	ofChildren(CompilationUnitMetrics pValues)	Create a new AggregatedMetrics and add values from the comments and types of a CompilationUnitMetrics to the aggregation.
static AggregatedMetrics	ofChildren(FieldMetrics pValues)	Create a new AggregatedMetrics and add values from the comments and statements of a FieldMetrics to the aggregation.
static AggregatedMetrics	ofChildren(MethodMetrics pValues)	Create a new AggregatedMetrics and add values from the comments and statements of a MethodMetrics to the aggregation.
static AggregatedMetrics	ofChildren(PackageMetrics pValues)	Create a new AggregatedMetrics and add values from the compilation units of a PackageMetrics to the aggregation.
static AggregatedMetrics	ofChildren(TypeMetrics pValues)	Create a new AggregatedMetrics and add values from the comments and members of a TypeMetrics to the aggregation.

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregatedMetrics

public AggregatedMetrics()

Method Detail

of

@Nonnull
public static AggregatedMetrics of(@Nonnull
                                   JavaMetrics pValues)

Create a new AggregatedMetrics and add the values from a JavaMetrics to the aggregation.

Parameters:

pValues - The values to add.

Returns:

A new AggregatedMetrics, never null.

Throws:

java.lang.NullPointerException - if pValues is null.

of

@Nonnull
public static AggregatedMetrics of(@Nonnull
                                   PackageMetrics pValues)

Create a new AggregatedMetrics and add the values from a PackageMetrics to the aggregation.

Parameters:

pValues - The values to add.

Returns:

A new AggregatedMetrics, never null.

Throws:

java.lang.NullPointerException - if pValues is null.

ofChildren

@Nonnull
public static AggregatedMetrics ofChildren(@Nonnull
                                           PackageMetrics pValues)

Create a new AggregatedMetrics and add values from the compilation units of a PackageMetrics to the aggregation. This differs from calling of(PackageMetrics) in that the aggregated number of packages isn't incremented by this method.

Parameters:

pValues - The values to add.

Returns:

A new AggregatedMetrics, never null.

Throws:

java.lang.NullPointerException - if pValues is null.

of

@Nonnull
public static AggregatedMetrics of(@Nonnull
                                   CompilationUnitMetrics pValues)

Create a new AggregatedMetrics and add the values from a CompilationUnitMetrics to the aggregation.

Parameters:

pValues - The values to add.

Returns:

A new AggregatedMetrics, never null.

Throws:

java.lang.NullPointerException - if pValues is null.

ofChildren

@Nonnull
public static AggregatedMetrics ofChildren(@Nonnull
                                           CompilationUnitMetrics pValues)

Create a new AggregatedMetrics and add values from the comments and types of a CompilationUnitMetrics to the aggregation. This differs from calling of(CompilationUnitMetrics) in that the aggregated number of compilation units isn't incremented by this method.

Parameters:

pValues - The values to add.

Returns:

A new AggregatedMetrics, never null.

Throws:

java.lang.NullPointerException - if pValues is null.

of

@Nonnull
public static AggregatedMetrics of(@Nonnull
                                   TypeMetrics pValues)

Create a new AggregatedMetrics and add the values from a TypeMetrics to the aggregation.

Parameters:

pValues - The values to add.

Returns:

A new AggregatedMetrics, never null.

Throws:

java.lang.NullPointerException - if pValues is null.

ofChildren

@Nonnull
public static AggregatedMetrics ofChildren(@Nonnull
                                           TypeMetrics pValues)

Create a new AggregatedMetrics and add values from the comments and members of a TypeMetrics to the aggregation. This differs from calling of(TypeMetrics) in that the aggregated number of types is only incremented for the type's inner types, not for the type itself.

Parameters:

pValues - The values to add.

Returns:

A new AggregatedMetrics, never null.

Throws:

java.lang.NullPointerException - if pValues is null.

of

@Nonnull
public static AggregatedMetrics of(@Nonnull
                                   MethodMetrics pValues)

Create a new AggregatedMetrics and add the values from a MethodMetrics to the aggregation.

Parameters:

pValues - The values to add.

Returns:

A new AggregatedMetrics, never null.

Throws:

java.lang.NullPointerException - if pValues is null.

ofChildren

@Nonnull
public static AggregatedMetrics ofChildren(@Nonnull
                                           MethodMetrics pValues)

Create a new AggregatedMetrics and add values from the comments and statements of a MethodMetrics to the aggregation. This differs from calling of(MethodMetrics) in that the aggregated number of methods isn't incremented by this method.

Parameters:

pValues - The values to add.

Returns:

A new AggregatedMetrics, never null.

Throws:

java.lang.NullPointerException - if pValues is null.

of

@Nonnull
public static AggregatedMetrics of(@Nonnull
                                   FieldMetrics pValues)

Create a new AggregatedMetrics and add the values of a FieldMetrics to the aggregation.

Parameters:

pValues - The values to add.

Returns:

A new AggregatedMetrics, never null.

Throws:

java.lang.NullPointerException - if pValues is null.

ofChildren

@Nonnull
public static AggregatedMetrics ofChildren(@Nonnull
                                           FieldMetrics pValues)

Create a new AggregatedMetrics and add values from the comments and statements of a FieldMetrics to the aggregation. This differs from calling of(FieldMetrics) in that the aggregated number of fields isn't incremented by this method.

Parameters:

pValues - The values to add.

Returns:

A new AggregatedMetrics, never null.

Throws:

java.lang.NullPointerException - if pValues is null.

getNumModularCompilationUnits

public int getNumModularCompilationUnits()

Get the number of modular compilation units in this aggregation.

Returns:

The number of modular compilation units.

getNumPackages

public int getNumPackages()

Get the number of packages in this aggregation.

Returns:

The number of packages.

getNumCompilationUnits

public int getNumCompilationUnits()

Get the number of compilation units in this aggregation.

Returns:

The number of compilation units.

getNumTypes

public int getNumTypes()

Get the number of types in this aggregation.

Returns:

The number of types.

getNumMethods

public int getNumMethods()

Get the number of methods in this aggregation.

Returns:

The number of methods.

getNumFields

public int getNumFields()

Get the number of fields in this aggregation.

Returns:

The number of fields.

getNumStatements

public int getNumStatements()

Get the number of statements in this aggregation.

Returns:

The number of statements.

getNumLineComments

public int getNumLineComments()

Get the number of line comments in this aggregation.

Returns:

The number of line comments.

getLineCommentsLength

public int getLineCommentsLength()

Get the length of the line comments' content in this aggregation. The length is the number of characters remaining when leading and trailing whitespace has been trimmed away from the comments.

Returns:

The content length of the line comments.

getNumBlockComments

public int getNumBlockComments()

Get the number of block comments in this aggregation.

Returns:

The number of block comments.

getNumBlockCommentLines

public int getNumBlockCommentLines()

Get the number of block comment lines in this aggregation.

Returns:

The number of block comment lines.

getBlockCommentsLength

public int getBlockCommentsLength()

Get the length of the block comments' content in this aggregation. The length is the number of characters remaining when leading and trailing whitespace and asterisks have been trimmed away from each line in the comments.

Returns:

The content length of the block comments.

getNumJavaDocComments

public int getNumJavaDocComments()

Get the number of JavaDoc comments in this aggregation.

Returns:

The number of JavaDoc comments.

getNumJavaDocLines

public int getNumJavaDocLines()

Get the number of JavaDoc comment lines in this aggregation.

Returns:

The number of JavaDoc comment lines.

getJavaDocCommentsLength

public int getJavaDocCommentsLength()

Get the length of the JavaDoc comments' content in this aggregation. The length is the number of characters remaining when leading and trailing whitespace and asterisks have been trimmed away from each line in the comments.

Returns:

The content length of the JavaDoc comments.

add

@Nonnull
public AggregatedMetrics add(@Nonnull
                             ModularCompilationUnitMetrics pValues)

Add a ModularCompilationUnitMetrics to this aggregation.

Parameters:

pValues - The values to add.

Returns:

This instance.

Throws:

java.lang.NullPointerException - if pValues is null.

add

@Nonnull
public AggregatedMetrics add(@Nonnull
                             PackageMetrics pValues)

Add a PackageMetrics to this aggregation.

Parameters:

pValues - The values to add.

Returns:

This instance.

Throws:

java.lang.NullPointerException - if pValues is null.

addChildren

@Nonnull
public AggregatedMetrics addChildren(@Nonnull
                                     PackageMetrics pValues)

Add the compilation units of a PackageMetrics to this aggregation.

Parameters:

pValues - The instance to add the children from.

Returns:

This instance.

Throws:

java.lang.NullPointerException - if pValues is null.

add

@Nonnull
public AggregatedMetrics add(@Nonnull
                             CompilationUnitMetrics pValues)

Add a CompilationUnitMetrics to this aggregation.

Parameters:

pValues - The values to add.

Returns:

This instance.

Throws:

java.lang.NullPointerException - if pValues is null.

addChildren

@Nonnull
public AggregatedMetrics addChildren(@Nonnull
                                     CompilationUnitMetrics pValues)

Add the comments and types of a CompilationUnitMetrics to this aggregation.

Parameters:

pValues - The instance to add the children from.

Returns:

This instance.

Throws:

java.lang.NullPointerException - if pValues is null.

add

@Nonnull
public AggregatedMetrics add(@Nonnull
                             TypeMetrics pValues)

Add a TypeMetrics to this aggregation.

Parameters:

pValues - The values to add.

Returns:

This instance.

Throws:

java.lang.NullPointerException - if pValues is null.

addChildren

@Nonnull
public AggregatedMetrics addChildren(@Nonnull
                                     TypeMetrics pValues)

Add the comments and members of a TypeMetrics to this aggregation.

Parameters:

pValues - The instance to add the children from.

Returns:

This instance.

Throws:

java.lang.NullPointerException - if pValues is null.

add

@Nonnull
public AggregatedMetrics add(@Nonnull
                             MethodMetrics pValues)

Add a MethodMetrics to this aggregation.

Parameters:

pValues - The values to add.

Returns:

This instance.

Throws:

java.lang.NullPointerException - if pValues is null.

addChildren

@Nonnull
public AggregatedMetrics addChildren(@Nonnull
                                     MethodMetrics pValues)

Add the statements and comments of a MethodMetrics to this aggregation.

Parameters:

pValues - The instance to add the children from.

Returns:

This instance.

Throws:

java.lang.NullPointerException - if pValues is null.

add

@Nonnull
public AggregatedMetrics add(@Nonnull
                             FieldMetrics pValues)

Add a FieldMetrics to this aggregation.

Parameters:

pValues - The values to add.

Returns:

This instance.

Throws:

java.lang.NullPointerException - if pValues is null.

addChildren

@Nonnull
public AggregatedMetrics addChildren(@Nonnull
                                     FieldMetrics pValues)

Add the statements and comments of a FieldMetrics to this aggregation.

Parameters:

pValues - The instance to add the children from.

Returns:

This instance.

Throws:

java.lang.NullPointerException - if pValues is null.

add

@Nonnull
public AggregatedMetrics add(@Nonnull
                             StatementMetrics pValues)

Add the values of a StatementMetrics to this aggregation.

Parameters:

pValues - The values to add.

Returns:

This instance.

Throws:

java.lang.NullPointerException - if pValues is null.

add

@Nonnull
public AggregatedMetrics add(@Nonnull
                             CommentMetrics pValues)

Add the values of a CommentMetrics to this aggregation.

Parameters:

pValues - The values to add.

Returns:

This instance.

Throws:

java.lang.NullPointerException - if pValues is null.