org.sonar.api.batch.analyzer
Interface AnalyzerDescriptor

All Known Implementing Classes:
DefaultAnalyzerDescriptor

@Beta
public interface AnalyzerDescriptor

Describe what an Analyzer is doing. Information may be used by the platform to log interesting information or perform some optimization.

Since:
4.4

Method Summary
 AnalyzerDescriptor createIssuesForRuleRepositories(String... repositoryKeys)
          List InputFile.Type this Analyzer work on.
 AnalyzerDescriptor dependsOn(Metric<?>... metrics)
          List Metric this Analyzer depends on.
 AnalyzerDescriptor name(String name)
          Name of the Analyzer.
 AnalyzerDescriptor provides(Metric<?>... metrics)
          List Metric this Analyzer provides.
 AnalyzerDescriptor workOnFileTypes(InputFile.Type... types)
          List InputFile.Type this Analyzer work on.
 AnalyzerDescriptor workOnLanguages(String... languageKeys)
          List languages this Analyzer work on.
 

Method Detail

name

AnalyzerDescriptor name(String name)
Name of the Analyzer. Will be displayed in logs.


dependsOn

AnalyzerDescriptor dependsOn(Metric<?>... metrics)
List Metric this Analyzer depends on. Will be used to execute Analyzers in correct order.


provides

AnalyzerDescriptor provides(Metric<?>... metrics)
List Metric this Analyzer provides. Will be used to execute Analyzers in correct order.


workOnLanguages

AnalyzerDescriptor workOnLanguages(String... languageKeys)
List languages this Analyzer work on. May be used by the platform to skip execution of the Analyzer when no file for given languages are present in the project. If no language is provided then it will be executed for all languages.


workOnFileTypes

AnalyzerDescriptor workOnFileTypes(InputFile.Type... types)
List InputFile.Type this Analyzer work on. May be used by the platform to skip execution of the Analyzer when no file for given type are present in the project. If not type is provided then it will be executed for all types.


createIssuesForRuleRepositories

AnalyzerDescriptor createIssuesForRuleRepositories(String... repositoryKeys)
List InputFile.Type this Analyzer work on. May be used by the platform to skip execution of the Analyzer when no file for given type are present in the project. If not type is provided then it will be executed for all types.



Copyright © 2009-2014 SonarSource. All Rights Reserved.