org.sonar.api.batch.sensor
Interface SensorContext

@Beta
public interface SensorContext

Experimental - do not use

Since:

4.4

Method Summary

ActiveRules	activeRules() Get list of active rules.
boolean	addIssue(Issue issue) Add an issue.
void	addMeasure(Measure<?> measure) Add a measure.
DuplicationBuilder	duplicationBuilder(InputFile inputFile) Builder to manually define duplications in a file.
DuplicationTokenBuilder	duplicationTokenBuilder(InputFile inputFile) Builder to define tokens in a file.
FileSystem	fileSystem() Get filesystem of the current project.
<G extends Serializable> Measure<G>	getMeasure(InputFile file, Metric<G> metric) Find a file measure.
Measure	getMeasure(InputFile file, String metricKey) Find a file measure.
<G extends Serializable> Measure<G>	getMeasure(Metric<G> metric) Find a project measure.
Measure	getMeasure(String metricKey) Find a project measure.
HighlightingBuilder	highlightingBuilder(InputFile inputFile) Builder to define highlighting of a file.
IssueBuilder	issueBuilder() Builder to create a new Issue.
<G extends Serializable> MeasureBuilder<G>	measureBuilder() Builder to create a new Measure.
void	saveDuplications(InputFile inputFile, List<DuplicationGroup> duplications) Register all duplications of an InputFile.
Settings	settings() Get settings of the current project.
SymbolTableBuilder	symbolTableBuilder(InputFile inputFile) Builder to define symbol references in a file.

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> MeasureBuilder<G> measureBuilder()

Builder to create a new Measure.

getMeasure

@CheckForNull
Measure getMeasure(String metricKey)

Find a project measure.

getMeasure

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

Find a project measure.

getMeasure

@CheckForNull
Measure getMeasure(InputFile file,
                                String metricKey)

Find a file measure.

getMeasure

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

Find a file measure.

addMeasure

void addMeasure(Measure<?> measure)

Add a measure. Use measureBuilder() to create the new measure. A measure for a given metric can only be saved once for the same resource.

issueBuilder

IssueBuilder issueBuilder()

Builder to create a new Issue.

addIssue

boolean addIssue(Issue issue)

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

Returns:

true if the new issue is registered, false if:

• the rule does not exist
• the rule is disabled in the Quality profile

highlightingBuilder

HighlightingBuilder highlightingBuilder(InputFile inputFile)

Builder to define highlighting of a file.

Since:

4.5

symbolTableBuilder

SymbolTableBuilder symbolTableBuilder(InputFile inputFile)

Builder to define symbol references in a file.

Since:

4.5

duplicationTokenBuilder

DuplicationTokenBuilder duplicationTokenBuilder(InputFile inputFile)

Builder to define tokens in a file. Tokens are used to compute duplication using default SonarQube engine.

Since:

4.5

duplicationBuilder

DuplicationBuilder duplicationBuilder(InputFile inputFile)

Builder to manually define duplications in a file. When duplication are manually computed then no need to use duplicationTokenBuilder(InputFile).

Since:

4.5

saveDuplications

void saveDuplications(InputFile inputFile,
                      List<DuplicationGroup> duplications)

Register all duplications of an InputFile. Use duplicationBuilder(InputFile) to create list of duplications.