com.togethersoft.sca.core
Interface ICodeInspectorExecutable

All Superinterfaces:

IExtensionExecutable

All Known Subinterfaces:

IMetricPlugin

All Known Implementing Classes:

ReportManager

public interface ICodeInspectorExecutable

extends IExtensionExecutable

The common interface for implementing a code inpector.

A code inspector provides user-visible services such as source code verification, analysis, etc. A code inspector can optionally contain a set of analyzers that allow to specify tasks at a finer granularity level.

Code inspectors are logically contained in plugins. A plugin may contain several code inspectors.

Code inspector objects are created by the framework on demand.

This interface may be implemented by clients.

See Also:

ICodeInspector

Method Summary

void	configureRegistry(IAnalyzerRegistry registry) Configures the analyzer registry.
void	run(IProject project, IAnalyzerDescriptor[] analyzers, JobControl jobControl) Performs analysis of the project.

Methods inherited from interface com.togethersoft.sca.core.IExtensionExecutable

setParameters

Method Detail

configureRegistry

public void configureRegistry(IAnalyzerRegistry registry)

Configures the analyzer registry.

run

public void run(IProject project,
                IAnalyzerDescriptor[] analyzers,
                JobControl jobControl)

Performs analysis of the project.

The clients should not call this method directly. The framework will call it on behalf of (@link IStaticAnalyzer.run()}.

Parameters:

project - the Java project to be inspected.

analyzers - specifies code anlyzers to run. This may be null for code inspectors that do not define code analyzers.

jobControl - a job control object.