Package com.ensoftcorp.open.commons.analyzers

Class Analyzers

java.lang.Object

com.ensoftcorp.open.commons.codemap.PrioritizedCodemapStage

com.ensoftcorp.open.commons.analyzers.Analyzers

public class Analyzers
extends PrioritizedCodemapStage

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Analyzers.AnalyzerResultChangedCallback

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	IDENTIFIER	The unique identifier for analyzer definitions

Constructor Summary

Constructors

Constructor	Description
Analyzers()

Method Summary

Modifier and Type	Method	Description
static void	cacheResults(Analyzer analyzer, java.util.List<Analyzer.Result> results)
static void	clearCachedResults()
static java.util.List<Analyzer.Result>	getAnalyzerResults(Analyzer analyzer)
static java.util.List<Analyzer.Result>	getAnalyzerResults(java.lang.String analyzerName)
java.lang.String[]	getCodemapStageDependencies()	Returns a set of prioritized codemap stage identifier strings that should perform indexing before this prioritized codemap stage Note: this should represent a conservative set of the worst case dependencies.
java.lang.String	getDisplayName()	Returns the display name of the codemap stage
java.lang.String	getIdentifier()	A unique string that serves as the identity of this PrioritizedCodemapStage
static java.util.Set<Analyzer>	getRegisteredAnalyzers()	Returns a copy of the currently registered analyzers
static boolean	hasCachedResult(Analyzer analyzer)
static boolean	hasCachedResult(java.lang.String analyzerName)
static void	loadAnalyzerContributions()	Registers the contributed plugin analyzer definitions
boolean	performIndexing(org.eclipse.core.runtime.IProgressMonitor monitor)	The codemap stage indexing task to be performed.
static void	registerAnalyzerResultChangedCallback(Analyzers.AnalyzerResultChangedCallback callback)
static void	unregisterAnalyzerResultChangedCallback(Analyzers.AnalyzerResultChangedCallback callback)

Methods inherited from class com.ensoftcorp.open.commons.codemap.PrioritizedCodemapStage

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

IDENTIFIER

public static final java.lang.String IDENTIFIER

The unique identifier for analyzer definitions

See Also:

Constant Field Values

Constructor Detail

Analyzers

public Analyzers()

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Description copied from class: PrioritizedCodemapStage

Returns the display name of the codemap stage

Specified by:

getDisplayName in class PrioritizedCodemapStage

Returns:

getIdentifier

public java.lang.String getIdentifier()

Description copied from class: PrioritizedCodemapStage

A unique string that serves as the identity of this PrioritizedCodemapStage

Specified by:

getIdentifier in class PrioritizedCodemapStage

Returns:

getCodemapStageDependencies

public java.lang.String[] getCodemapStageDependencies()

Description copied from class: PrioritizedCodemapStage

Returns a set of prioritized codemap stage identifier strings that should perform indexing before this prioritized codemap stage Note: this should represent a conservative set of the worst case dependencies. That is, if it is possible that under some configuration of the toolbox that the toolbox could depend on a prioritized codemap stage, then it should be listed here. Note: mutual dependencies are not supported!

Specified by:

getCodemapStageDependencies in class PrioritizedCodemapStage

Returns:

performIndexing

public boolean performIndexing(org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from class: PrioritizedCodemapStage

The codemap stage indexing task to be performed.

Specified by:

performIndexing in class PrioritizedCodemapStage

Returns:

Returns true if the codemap stage was actually run.

registerAnalyzerResultChangedCallback

public static void registerAnalyzerResultChangedCallback(Analyzers.AnalyzerResultChangedCallback callback)

unregisterAnalyzerResultChangedCallback

public static void unregisterAnalyzerResultChangedCallback(Analyzers.AnalyzerResultChangedCallback callback)

clearCachedResults

public static void clearCachedResults()

hasCachedResult

public static boolean hasCachedResult(Analyzer analyzer)

cacheResults

public static void cacheResults(Analyzer analyzer,
                                java.util.List<Analyzer.Result> results)

hasCachedResult

public static boolean hasCachedResult(java.lang.String analyzerName)

getAnalyzerResults

public static java.util.List<Analyzer.Result> getAnalyzerResults(Analyzer analyzer)

getAnalyzerResults

public static java.util.List<Analyzer.Result> getAnalyzerResults(java.lang.String analyzerName)

getRegisteredAnalyzers

public static java.util.Set<Analyzer> getRegisteredAnalyzers()

Returns a copy of the currently registered analyzers

Returns:

loadAnalyzerContributions

public static void loadAnalyzerContributions()

Registers the contributed plugin analyzer definitions