com.togethersoft.sca.core
Interface IAnalyzerDescriptor

public interface IAnalyzerDescriptor

Represents a code analyzer, such as audit rule, metric, detection strategy, etc. Analyzer descriptors are obtained from the plugin manifest file (plugin.xml, for example).

Analyzer descriptors are framework-defined objects that exist in the analyzer registry independent of whether an analyzer has been activated.

This interface is not intended to be implemented by clients.

Field Summary

static java.lang.String	PARAM_ENABLED_ID The identifier of the parameter that defines state (enabled or disabled) of this code analyzer.
static java.lang.String	PARAM_SEVERITY_ID The identifier of the parameter that defines severity of this code analyzer.

Method Summary

java.lang.Object	clone() Creates a deep copy of this analyzer descriptor.
IAnalyzerCategory	getCategory() Returns the category of this analyzer, or an empty string ("") if it is not contained in any category.
java.lang.String	getId() Returns the unique identifier of this analyzer.
java.lang.String	getImplementation() Returns the analyzer-specific description of the analyzer implementation.
ICodeInspector	getInspector() Returns the code inspector in which this analyzer is declared.
java.lang.String	getLibrary() Returns the name of a jar library which contains the analyzer class files.
java.lang.String	getName() Returns the name of this analyzer.
IParameterRegistry	getParameterRegistry() Returns the registry that holds the parameters of this code analyzer.

Field Detail

PARAM_ENABLED_ID

public static final java.lang.String PARAM_ENABLED_ID

The identifier of the parameter that defines state (enabled or disabled) of this code analyzer.

PARAM_SEVERITY_ID

public static final java.lang.String PARAM_SEVERITY_ID

The identifier of the parameter that defines severity of this code analyzer.

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Creates a deep copy of this analyzer descriptor.

getCategory

public IAnalyzerCategory getCategory()

Returns the category of this analyzer, or an empty string ("") if it is not contained in any category.

getId

public java.lang.String getId()

Returns the unique identifier of this analyzer.

getImplementation

public java.lang.String getImplementation()

Returns the analyzer-specific description of the analyzer implementation. This may be, for example, the implementing class name or formal specification of the analysis algorithm.

getInspector

public ICodeInspector getInspector()

Returns the code inspector in which this analyzer is declared.

getLibrary

public java.lang.String getLibrary()

Returns the name of a jar library which contains the analyzer class files. This will return null for analyzers placed in the default location.

getName

public java.lang.String getName()

Returns the name of this analyzer.

getParameterRegistry

public IParameterRegistry getParameterRegistry()

Returns the registry that holds the parameters of this code analyzer. Returns an empty registry if this code analyzer has no parameters.