org.sonar.api.batch.analyzer
Interface AnalyzerContext

@Beta
public interface AnalyzerContext

Since:

4.4

Method Summary

ActiveRules	activeRules() Get list of active rules.
boolean	addIssue(AnalyzerIssue issue) Add an issue.
void	addMeasure(AnalyzerMeasure<?> measure) Add a measure.
FileSystem	fileSystem() Get filesystem of the current project.
<G extends Serializable> AnalyzerMeasure<G>	getMeasure(InputFile file, Metric<G> metric) Find a file measure.
AnalyzerMeasure	getMeasure(InputFile file, String metricKey) Find a file measure.
<G extends Serializable> AnalyzerMeasure<G>	getMeasure(Metric<G> metric) Find a project measure.
AnalyzerMeasure	getMeasure(String metricKey) Find a project measure.
AnalyzerIssueBuilder	issueBuilder() Builder to create a new AnalyzerIssue.
<G extends Serializable> AnalyzerMeasureBuilder<G>	measureBuilder() Builder to create a new AnalyzerMeasure.
Settings	settings() Get settings of the current project.

Method Detail

settings

Settings settings()

Get settings of the current project.

fileSystem

FileSystem fileSystem()

Get filesystem of the current project.

activeRules

ActiveRules activeRules()

Get list of active rules.

measureBuilder

<G extends Serializable> AnalyzerMeasureBuilder<G> measureBuilder()

Builder to create a new AnalyzerMeasure.

getMeasure

@CheckForNull
AnalyzerMeasure getMeasure(String metricKey)

Find a project measure.

getMeasure

@CheckForNull
<G extends Serializable> AnalyzerMeasure<G> getMeasure(Metric<G> metric)

Find a project measure.

getMeasure

@CheckForNull
AnalyzerMeasure getMeasure(InputFile file,
                                        String metricKey)

Find a file measure.

getMeasure

@CheckForNull
<G extends Serializable> AnalyzerMeasure<G> getMeasure(InputFile file,
                                                                    Metric<G> metric)

Find a file measure.

addMeasure

void addMeasure(AnalyzerMeasure<?> measure)

Add a measure. Use measureBuilder() to create the new measure.

issueBuilder

AnalyzerIssueBuilder issueBuilder()

Builder to create a new AnalyzerIssue.

addIssue

boolean addIssue(AnalyzerIssue issue)

Add an issue. Use issueBuilder() to create the new issue.

Returns:

true if the new issue is registered, false if the related rule does not exist or is disabled in the Quality profile.