Package org.myire.scent.collect

Class JavaMetricsCollector

java.lang.Object

org.myire.scent.collect.JavaMetricsCollector

@NotThreadSafe
public class JavaMetricsCollector
extends java.lang.Object

A collector of Java source code metrics. Metrics are collected and stored in an instance of this class with repeated calls to collect(String, InputStream, Charset). The collected metrics can then be retrieved by calling getCollectedMetrics().

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	JavaMetricsCollector.LanguageLevel	The supported Java language levels.

Constructor Summary

Constructors

Constructor	Description
JavaMetricsCollector()	Create a new JavaMetricsCollector for the default language level as specified by JavaMetricsCollector.LanguageLevel.getDefault().
JavaMetricsCollector(JavaMetricsCollector.LanguageLevel pLanguageLevel)	Create a new JavaMetricsCollector for a specific language level.

Method Summary

Modifier and Type	Method	Description
void	collect(java.lang.String pName, java.io.InputStream pJavaSource, java.nio.charset.Charset pEncoding)	Parse an InputStream containing Java source code and collect metrics from it.
void	collect(java.lang.String pName, java.lang.String pJavaSource)	Parse a string containing Java source code and collect metrics from it.
JavaMetrics	getCollectedMetrics()	Get the metrics collected in all calls to collect.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaMetricsCollector

public JavaMetricsCollector()

Create a new JavaMetricsCollector for the default language level as specified by JavaMetricsCollector.LanguageLevel.getDefault().

JavaMetricsCollector

public JavaMetricsCollector(@Nonnull
                            JavaMetricsCollector.LanguageLevel pLanguageLevel)

Create a new JavaMetricsCollector for a specific language level.

Parameters:

pLanguageLevel - The language level.

Throws:

java.lang.NullPointerException - if pLanguageLevel is null.

Method Detail

collect

public void collect(@Nonnull
                    java.lang.String pName,
                    @Nonnull
                    java.io.InputStream pJavaSource,
                    @Nonnull
                    java.nio.charset.Charset pEncoding)
             throws java.text.ParseException

Parse an InputStream containing Java source code and collect metrics from it. The resulting metrics will be stored in this instance and returned when getCollectedMetrics() is called.

Parameters:

pName - The name of the stream's origin, will be used as the name of the CompilationUnitMetrics where the collected metrics are put.

pJavaSource - The input stream containing the source code to parse and collect metrics for.

pEncoding - The encoding of the stream's bytes.

Throws:

java.text.ParseException - if the stream's source code is lexically or syntactically invalid.

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

collect

public void collect(@Nonnull
                    java.lang.String pName,
                    @Nonnull
                    java.lang.String pJavaSource)
             throws java.text.ParseException

Parse a string containing Java source code and collect metrics from it. The resulting metrics will be stored in this instance and returned when getCollectedMetrics() is called.

Parameters:

pName - The name of the string's origin, will be used as the name of the CompilationUnitMetrics where the collected metrics are put.

pJavaSource - The string containing the source code to parse and collect metrics for.

Throws:

java.text.ParseException - if the string's source code is lexically or syntactically invalid.

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

getCollectedMetrics

@Nonnull
public JavaMetrics getCollectedMetrics()

Get the metrics collected in all calls to collect.

Returns:

A JavaMetrics containing the collected metrics, never null.