org.gmetrics.analyzer
Interface SourceAnalyzer

All Known Implementing Classes:

AntFileSetSourceAnalyzer, FilesystemSourceAnalyzer

public interface SourceAnalyzer

The interface for objects that can analyze the source files within one or more directory trees using a specified MetricSet and produce report results.

Version:

$Revision: 101 $ - $Date: 2010-03-10 19:17:23 -0500 (Wed, 10 Mar 2010) $

Author:

Chris Mair

Method Summary

ResultsNode	analyze(MetricSet metricSet) Analyze all source code using the specified set of Metrics and return the results.
java.util.List	getSourceDirectories() Return the List of source directories to be analyzed.

Method Detail

analyze

ResultsNode analyze(MetricSet metricSet)

Analyze all source code using the specified set of Metrics and return the results.

Parameters:

metricSet - - the MetricSet to apply to each source component; must not be null.

Returns:

the results from applying the metrics to all of the source

getSourceDirectories

java.util.List getSourceDirectories()

Return the List of source directories to be analyzed. May be empty; may not be null.