Package org.myire.scent.file

Class JavaFileMetricsCollector

java.lang.Object

java.nio.file.SimpleFileVisitor<java.nio.file.Path>

org.myire.scent.file.JavaFileMetricsCollector

All Implemented Interfaces:

java.nio.file.FileVisitor<java.nio.file.Path>

@NotThreadSafe
public class JavaFileMetricsCollector
extends java.nio.file.SimpleFileVisitor<java.nio.file.Path>

A FileVisitor that collects source code metrics for each visited Java file. The metrics are collected by calling JavaMetricsCollector.collect(String, InputStream, Charset).

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

Author:

Peter Franzen

Constructor Summary

Constructors

Constructor	Description
JavaFileMetricsCollector(JavaMetricsCollector pDelegate)	Create a new JavaFileMetricsCollector that operates on files encoded with UTF-8.
JavaFileMetricsCollector(JavaMetricsCollector pDelegate, java.nio.charset.Charset pFileEncoding)	Create a new JavaFileMetricsCollector.

Method Summary

Modifier and Type	Method	Description
protected JavaMetricsCollector	getDelegate()	Get the JavaMetricsCollector passed to the constructor.
int	getNumFiles()	Get the number of files that metrics have been collected for.
java.nio.file.FileVisitResult	visitFile(java.nio.file.Path pFile, java.nio.file.attribute.BasicFileAttributes pAttributes)

Methods inherited from class java.lang.Object

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

Methods inherited from class java.nio.file.SimpleFileVisitor

postVisitDirectory, preVisitDirectory, visitFileFailed

Constructor Detail

JavaFileMetricsCollector

public JavaFileMetricsCollector(@Nonnull
                                JavaMetricsCollector pDelegate)

Create a new JavaFileMetricsCollector that operates on files encoded with UTF-8.

Parameters:

pDelegate - The instance to collect metrics with.

Throws:

java.lang.NullPointerException - if pDelegate is null.

JavaFileMetricsCollector

public JavaFileMetricsCollector(@Nonnull
                                JavaMetricsCollector pDelegate,
                                @Nonnull
                                java.nio.charset.Charset pFileEncoding)

Create a new JavaFileMetricsCollector.

Parameters:

pDelegate - The instance to collect metrics with.

pFileEncoding - The charset the files are encoded with.

Throws:

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

Method Detail

visitFile

public java.nio.file.FileVisitResult visitFile(@Nonnull
                                               java.nio.file.Path pFile,
                                               @Nullable
                                               java.nio.file.attribute.BasicFileAttributes pAttributes)
                                        throws java.io.IOException

Specified by:

visitFile in interface java.nio.file.FileVisitor<java.nio.file.Path>

Overrides:

visitFile in class java.nio.file.SimpleFileVisitor<java.nio.file.Path>

Throws:

java.io.IOException

getNumFiles

public int getNumFiles()

Get the number of files that metrics have been collected for.

Returns:

The number of files.

getDelegate

@Nonnull
protected JavaMetricsCollector getDelegate()

Get the JavaMetricsCollector passed to the constructor. The Java file parsing and metrics collection is delegated to that instance.

Returns:

The delegate JavaMetricsCollector, never null.