Package org.myire.scent.metrics

Class CommentMetrics

java.lang.Object

org.myire.scent.metrics.CommentMetrics

@NotThreadSafe
public class CommentMetrics
extends java.lang.Object

Metrics for source code comments, separated into block comments, line comments, and JavaDoc comments.

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

Author:

Peter Franzen

Constructor Summary

Constructors

Constructor	Description
CommentMetrics()

Method Summary

Modifier and Type	Method	Description
void	add(com.github.javaparser.ast.comments.BlockComment pComment)	Add metrics from a block comment.
void	add(com.github.javaparser.ast.comments.JavadocComment pComment)	Add metrics from a JavaDoc comment.
void	add(com.github.javaparser.ast.comments.LineComment pComment)	Add metrics from a line comment.
void	add(CommentMetrics pValues)	Add the values of another CommentMetrics to this instance.
int	getBlockCommentsLength()	Get the total number of significant characters in the BlockComment instances added to this instance.
int	getJavaDocCommentsLength()	Get the total number of significant characters in the JavadocComment instances added to this instance.
int	getLineCommentsLength()	Get the total number of significant characters in the LineComment instances added to this instance.
int	getNumBlockCommentLines()	Get the number of block comment lines collected from the BlockComment instances added to this instance.
int	getNumBlockComments()	Get the number of block comments collected from the BlockComment instances added to this instance.
int	getNumJavaDocComments()	Get the number of JavaDoc comments collected from the JavadocComment instances added to this instance.
int	getNumJavaDocLines()	Get the number of lines collected from the JavadocComment instances added to this instance.
int	getNumLineComments()	Get the number of line comments collected from the LineComment instances added to this instance.
boolean	isEmpty()	Is this instance empty?

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentMetrics

public CommentMetrics()

Method Detail

isEmpty

public boolean isEmpty()

Is this instance empty?

Returns:

True if all comment counts are zero, false if at least one of them is non-zero.

getNumLineComments

public int getNumLineComments()

Get the number of line comments collected from the LineComment instances added to this instance.

Returns:

The number of line comments.

getLineCommentsLength

public int getLineCommentsLength()

Get the total number of significant characters in the LineComment instances added to this instance. Significant characters are the ones remaining when leading and trailing whitespace has been trimmed away.

Returns:

The content length of the line comments.

getNumBlockComments

public int getNumBlockComments()

Get the number of block comments collected from the BlockComment instances added to this instance.

Returns:

The number of block comments.

getNumBlockCommentLines

public int getNumBlockCommentLines()

Get the number of block comment lines collected from the BlockComment instances added to this instance.

Returns:

The number of block comment lines.

getBlockCommentsLength

public int getBlockCommentsLength()

Get the total number of significant characters in the BlockComment instances added to this instance. Significant characters are the ones 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 collected from the JavadocComment instances added to this instance.

Returns:

The number of JavaDoc comments.

getNumJavaDocLines

public int getNumJavaDocLines()

Get the number of lines collected from the JavadocComment instances added to this instance.

Returns:

The number of JavaDoc comment lines.

getJavaDocCommentsLength

public int getJavaDocCommentsLength()

Get the total number of significant characters in the JavadocComment instances added to this instance. Significant characters are the ones 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

public void add(@Nonnull
                CommentMetrics pValues)

Add the values of another CommentMetrics to this instance.

Parameters:

pValues - The values to add.

Throws:

java.lang.NullPointerException - if pValues is null.

add

public void add(@Nonnull
                com.github.javaparser.ast.comments.LineComment pComment)

Add metrics from a line comment.

Parameters:

pComment - The line comment to add metrics from.

Throws:

java.lang.NullPointerException - if pComment is null.

add

public void add(@Nonnull
                com.github.javaparser.ast.comments.BlockComment pComment)

Add metrics from a block comment.

Parameters:

pComment - The block comment to add metrics from.

Throws:

java.lang.NullPointerException - if pComment is null.

add

public void add(@Nonnull
                com.github.javaparser.ast.comments.JavadocComment pComment)

Add metrics from a JavaDoc comment.

Parameters:

pComment - The JavaDoc comment to add metrics from.

Throws:

java.lang.NullPointerException - if pComment is null.