SensorContextTester (SonarQube :: Plugin API 5.6.7 API)

java.lang.Object
- org.sonar.api.batch.sensor.internal.SensorContextTester

All Implemented Interfaces:

SensorContext
```
@Beta
public class SensorContextTester
extends Object
implements SensorContext
```
Utility class to help testing Sensor. This is not an API and method signature may evolve. Usage: call create(File) to create an "in memory" implementation of SensorContext with a filesystem initialized with provided baseDir.
You have to manually register inputFiles using:
```
   sensorContextTester.fileSystem().add(new DefaultInputFile("myProjectKey", "src/Foo.java")
      .setLanguage("java")
      .initMetadata("public class Foo {\n}"));
 
```
Then pass it to your Sensor. You can then query elements provided by your sensor using methods allIssues(), ...

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActiveRules`	`activeRules()` Get list of active rules.
`Collection<Issue>`	`allIssues()`
`Integer`	`conditions(String fileKey, CoverageType type, int line)`
`Integer`	`coveredConditions(String fileKey, CoverageType type, int line)`
`List<TokensLine>`	`cpdTokens(String componentKey)`
`static SensorContextTester`	`create(File moduleBaseDir)`
`static SensorContextTester`	`create(Path moduleBaseDir)`
`DefaultFileSystem`	`fileSystem()` Get filesystem of the current module.
`Version`	`getSonarQubeVersion()` Default value is the version of this API.
`List<TypeOfText>`	`highlightingTypeAt(String componentKey, int line, int lineOffset)` Return list of syntax highlighting applied for a given position in a file.
`Integer`	`lineHits(String fileKey, CoverageType type, int line)`
`<G extends Serializable> Measure<G>`	`measure(String componetKey, Metric<G> metric)`
`<G extends Serializable> Measure<G>`	`measure(String componentKey, String metricKey)`
`Collection<Measure>`	`measures(String componentKey)`
`InputModule`	`module()`
`NewCoverage`	`newCoverage()` Builder to define coverage in a file.
`NewCpdTokens`	`newCpdTokens()` Builder to define CPD tokens in a file.
`NewHighlighting`	`newHighlighting()` Builder to define highlighting of a file.
`NewIssue`	`newIssue()` Fluent builder to create a new `Issue`.
`<G extends Serializable> NewMeasure<G>`	`newMeasure()` Fluent builder to create a new `Measure`.
`NewSymbolTable`	`newSymbolTable()` Builder to define symbol table of a file.
`Collection<TextRange>`	`referencesForSymbolAt(String componentKey, int line, int lineOffset)` Return list of symbol references ranges for the symbol at a given position in a file.
`SensorContextTester`	`setActiveRules(ActiveRules activeRules)`
`SensorContextTester`	`setFileSystem(DefaultFileSystem fs)`
`SensorContextTester`	`setSettings(Settings settings)`
`SensorContextTester`	`setSonarQubeVersion(Version version)`
`Settings`	`settings()` Get settings of the current module.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static SensorContextTester create(File moduleBaseDir)
```
  - create
```
public static SensorContextTester create(Path moduleBaseDir)
```
  - settings
```
public Settings settings()
```
    Description copied from interface: SensorContext
    
    Get settings of the current module.
    
    Specified by:
    
    settings in interface SensorContext
  - setSettings
```
public SensorContextTester setSettings(Settings settings)
```
  - fileSystem
```
public DefaultFileSystem fileSystem()
```
    Description copied from interface: SensorContext
    
    Get filesystem of the current module.
    
    Specified by:
    
    fileSystem in interface SensorContext
  - setFileSystem
```
public SensorContextTester setFileSystem(DefaultFileSystem fs)
```
  - activeRules
```
public ActiveRules activeRules()
```
    Description copied from interface: SensorContext
    
    Get list of active rules.
    
    Specified by:
    
    activeRules in interface SensorContext
  - setActiveRules
```
public SensorContextTester setActiveRules(ActiveRules activeRules)
```
  - getSonarQubeVersion
```
public Version getSonarQubeVersion()
```
    Default value is the version of this API. You can override it using setSonarQubeVersion(Version) to test your Sensor behavior.
    
    Specified by:
    
    getSonarQubeVersion in interface SensorContext
  - setSonarQubeVersion
```
public SensorContextTester setSonarQubeVersion(Version version)
```
  - module
```
public InputModule module()
```
    Specified by:
    
    module in interface SensorContext
  - newMeasure
```
public <G extends Serializable> NewMeasure<G> newMeasure()
```
    Description copied from interface: SensorContext
    
    Fluent builder to create a new Measure. Don't forget to call NewMeasure.save() once all parameters are provided.
    
    Specified by:
    
    newMeasure in interface SensorContext
  - measures
```
public Collection<Measure> measures(String componentKey)
```
  - measure
```
public <G extends Serializable> Measure<G> measure(String componetKey,
                                                   Metric<G> metric)
```
  - measure
```
public <G extends Serializable> Measure<G> measure(String componentKey,
                                                   String metricKey)
```
  - newIssue
```
public NewIssue newIssue()
```
    Description copied from interface: SensorContext
    
    Fluent builder to create a new Issue. Don't forget to call NewIssue.save() once all parameters are provided.
    
    Specified by:
    
    newIssue in interface SensorContext
  - allIssues
```
public Collection<Issue> allIssues()
```
  - lineHits
```
@CheckForNull
public Integer lineHits(String fileKey,
                                      CoverageType type,
                                      int line)
```
  - conditions
```
@CheckForNull
public Integer conditions(String fileKey,
                                        CoverageType type,
                                        int line)
```
  - coveredConditions
```
@CheckForNull
public Integer coveredConditions(String fileKey,
                                               CoverageType type,
                                               int line)
```
  - cpdTokens
```
@CheckForNull
public List<TokensLine> cpdTokens(String componentKey)
```
  - newHighlighting
```
public NewHighlighting newHighlighting()
```
    Description copied from interface: SensorContext
    
    Builder to define highlighting of a file. Don't forget to call NewHighlighting.save() once all elements are provided.
    
    Specified by:
    
    newHighlighting in interface SensorContext
  - newCoverage
```
public NewCoverage newCoverage()
```
    Description copied from interface: SensorContext
    
    Builder to define coverage in a file. Don't forget to call NewCoverage.save().
    
    Specified by:
    
    newCoverage in interface SensorContext
  - newCpdTokens
```
public NewCpdTokens newCpdTokens()
```
    Description copied from interface: SensorContext
    
    Builder to define CPD tokens in a file. Don't forget to call NewCpdTokens.save().
    
    Specified by:
    
    newCpdTokens in interface SensorContext
  - newSymbolTable
```
public NewSymbolTable newSymbolTable()
```
    Description copied from interface: SensorContext
    
    Builder to define symbol table of a file. Don't forget to call NewSymbolTable.save() once all symbols are provided.
    
    Specified by:
    
    newSymbolTable in interface SensorContext
  - highlightingTypeAt
```
public List<TypeOfText> highlightingTypeAt(String componentKey,
                                           int line,
                                           int lineOffset)
```
    Return list of syntax highlighting applied for a given position in a file. The result is a list because in theory you can apply several styles to the same range.
    
    Parameters:
    
    componentKey - Key of the file like 'myProjectKey:src/foo.php'
    
    line - Line you want to query
    
    lineOffset - Offset you want to query.
    
    Returns:
    
    List of styles applied to this position or empty list if there is no highlighting at this position.
  - referencesForSymbolAt
```
public Collection<TextRange> referencesForSymbolAt(String componentKey,
                                                   int line,
                                                   int lineOffset)
```
    Return list of symbol references ranges for the symbol at a given position in a file.
    
    Parameters:
    
    componentKey - Key of the file like 'myProjectKey:src/foo.php'
    
    line - Line you want to query
    
    lineOffset - Offset you want to query.
    
    Returns:
    
    List of references for the symbol or empty list if there is no symbol at this position or if there is no reference for this symbol.

Class SensorContextTester

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

create

settings

setSettings

fileSystem

setFileSystem

activeRules

setActiveRules

getSonarQubeVersion

setSonarQubeVersion

module

newMeasure

measures

measure

measure

newIssue

allIssues

lineHits

conditions

coveredConditions

cpdTokens

newHighlighting

newCoverage

newCpdTokens

newSymbolTable

highlightingTypeAt

referencesForSymbolAt