org.netbeans.modules.analysis.spi

Class Analyzer.AnalyzerFactory

java.lang.Object

org.netbeans.modules.analysis.spi.Analyzer.AnalyzerFactory

Enclosing interface:

Analyzer

public abstract static class Analyzer.AnalyzerFactory
extends Object

Constructor Summary

Constructors

Constructor and Description
AnalyzerFactory(String id, String displayName, Image icon)
AnalyzerFactory(String id, String displayName, String iconPath)

Method Summary

Modifier and Type	Method and Description
abstract Analyzer	createAnalyzer(Analyzer.Context context)
Analyzer	createAnalyzer(Analyzer.Context context, Analyzer.Result result) Creates a new Analyzer with a context and warning collector.
abstract <D,C extends JComponent> Analyzer.CustomizerProvider<D,C>	getCustomizerProvider()
abstract Iterable<? extends Analyzer.WarningDescription>	getWarnings()
Collection<? extends Analyzer.MissingPlugin>	requiredPlugins(Analyzer.Context context) If additional modules are required to run the analysis (for the given context), return their description.
void	warningOpened(ErrorDescription warning)

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyzerFactory

public AnalyzerFactory(String id,
                       String displayName,
                       String iconPath)

Parameters:

id - a unique id of the analyzer

displayName - the display name of the analyzer

iconPath - a path to icon associated with this analyzer

AnalyzerFactory

public AnalyzerFactory(String id,
                       String displayName,
                       Image icon)

Parameters:

id - a unique id of the analyzer

displayName - the display name of the analyzer

icon - an icon associated with this analyzer

Since:

1.6

Method Detail

requiredPlugins

public Collection<? extends Analyzer.MissingPlugin> requiredPlugins(Analyzer.Context context)

If additional modules are required to run the analysis (for the given context), return their description.

Parameters:

context - over which the analysis is going to be performed

Returns:

descriptions of the missing plugins, if any

getWarnings

public abstract Iterable<? extends Analyzer.WarningDescription> getWarnings()

getCustomizerProvider

@CheckForNull
public abstract <D,C extends JComponent> Analyzer.CustomizerProvider<D,C> getCustomizerProvider()

createAnalyzer

public abstract Analyzer createAnalyzer(Analyzer.Context context)

Parameters:

context - containing the required Scope

Returns:

createAnalyzer

public Analyzer createAnalyzer(Analyzer.Context context,
                               Analyzer.Result result)

Creates a new Analyzer with a context and warning collector.

Parameters:

context - the Analyzer.Context of the analysis

result - the warning collector

Returns:

the Analyzer

Since:

1.16

warningOpened

public void warningOpened(ErrorDescription warning)