All Known Implementing Classes:

SensorContextTester
```
public interface SensorContext
```
See Sensor.execute(SensorContext) In order to write unit tests you can use SensorContextTester

Since:

5.1

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`ActiveRules`	`activeRules()`	Get list of active rules.
`void`	`addContextProperty(java.lang.String key, java.lang.String value)`	Add a property to the scanner context.
`Configuration`	`config()`	Get settings of the project.
`FileSystem`	`fileSystem()`	Get filesystem of the project.
`Version`	`getSonarQubeVersion()`	Version of API at runtime, not at compilation time.
`boolean`	`isCancelled()`	Test if a cancellation of the analysis was requested.
`void`	`markForPublishing(InputFile inputFile)`	Indicate that a file should be published in the report sent to SonarQube.
`InputModule`	`module()`	Deprecated. since 7.6 modules are deprecated.
`NewAdHocRule`	`newAdHocRule()`	Fluent builder to create a new `AdHocRule`.
`NewAnalysisError`	`newAnalysisError()`	Builder to declare errors that happened while processing a source file.
`NewCoverage`	`newCoverage()`	Builder to define coverage in a file.
`NewCpdTokens`	`newCpdTokens()`	Builder to define CPD tokens in a file.
`NewExternalIssue`	`newExternalIssue()`	Fluent builder to create a new `ExternalIssue`.
`NewHighlighting`	`newHighlighting()`	Builder to define highlighting of a file.
`NewIssue`	`newIssue()`	Fluent builder to create a new `Issue`.
`<G extends java.io.Serializable> NewMeasure<G>`	`newMeasure()`	Fluent builder to create a new `Measure`.
`NewSignificantCode`	`newSignificantCode()`	Builder to declare which parts of the code is significant code.
`NewSymbolTable`	`newSymbolTable()`	Builder to define symbol table of a file.
`InputProject`	`project()`	The current project.
`SonarRuntime`	`runtime()`	Runtime information, mainly: to be able to have different behaviours between SonarQube and SonarLint to enable new features depending on version of API available at runtime
`Settings`	`settings()`	Deprecated. since 6.5 use `config()`

- Method Detail
  - settings
```
@Deprecated
Settings settings()
```
    Deprecated.
    since 6.5 use config()
  - config
```
Configuration config()
```
    Get settings of the project.
    
    Since:
    
    6.5
  - fileSystem
```
FileSystem fileSystem()
```
    Get filesystem of the project.
  - activeRules
```
ActiveRules activeRules()
```
    Get list of active rules.
  - module
```
@Deprecated
InputModule module()
```
    Deprecated.
    since 7.6 modules are deprecated. Use project() instead.
    
    Throws:
    
    java.lang.UnsupportedOperationException - for global ProjectSensors
    
    Since:
    
    5.5
  - project
```
InputProject project()
```
    The current project.
    
    Since:
    
    7.6
  - getSonarQubeVersion
```
Version getSonarQubeVersion()
```
    Version of API at runtime, not at compilation time. It's a shortcut on runtime().getApiVersion() since 6.0.
    
    Since:
    
    5.5
    
    See Also:
    
    since version 6.0.
  - runtime
```
SonarRuntime runtime()
```
    Runtime information, mainly:
    
    to be able to have different behaviours between SonarQube and SonarLint
    
    to enable new features depending on version of API available at runtime
    Since:
    
    6.0
  - isCancelled
```
boolean isCancelled()
```
    Test if a cancellation of the analysis was requested. Sensors should periodically test this flag and gracefully stop if value is true. For example it could be tested between each processed file.
    
    Since:
    
    6.0
  - newMeasure
```
<G extends java.io.Serializable> NewMeasure<G> newMeasure()
```
    Fluent builder to create a new Measure. Don't forget to call NewMeasure.save() once all parameters are provided.
  - newIssue
```
NewIssue newIssue()
```
    Fluent builder to create a new Issue. Don't forget to call NewIssue.save() once all parameters are provided.
  - newExternalIssue
```
NewExternalIssue newExternalIssue()
```
    Fluent builder to create a new ExternalIssue. Don't forget to call NewExternalIssue.save() once all parameters are provided.
    
    Since:
    
    7.2
  - newAdHocRule
```
NewAdHocRule newAdHocRule()
```
    Fluent builder to create a new AdHocRule. Don't forget to call NewAdHocRule.save() once all parameters are provided.
    
    Since:
    
    7.4
  - newHighlighting
```
NewHighlighting newHighlighting()
```
    Builder to define highlighting of a file. Don't forget to call NewHighlighting.save() once all elements are provided.
  - newSymbolTable
```
NewSymbolTable newSymbolTable()
```
    Builder to define symbol table of a file. Don't forget to call NewSymbolTable.save() once all symbols are provided.
    
    Since:
    
    5.6
  - newCoverage
```
NewCoverage newCoverage()
```
    Builder to define coverage in a file. Don't forget to call NewCoverage.save().
  - newCpdTokens
```
NewCpdTokens newCpdTokens()
```
    Builder to define CPD tokens in a file. Don't forget to call NewCpdTokens.save().
    
    Since:
    
    5.5
  - newAnalysisError
```
NewAnalysisError newAnalysisError()
```
    Builder to declare errors that happened while processing a source file. Don't forget to call NewAnalysisError.save().
    
    Since:
    
    6.0
  - newSignificantCode
```
NewSignificantCode newSignificantCode()
```
    Builder to declare which parts of the code is significant code. Ranges that are not reported as significant code will be ignored and won't be considered when calculating which lines were modified. If the significant code is not reported for a file, it is assumed that the entire file is significant code.
    
    Since:
    
    7.2
  - addContextProperty
```
void addContextProperty(java.lang.String key,
                        java.lang.String value)
```
    Add a property to the scanner context. This context is available in Compute Engine when processing the report.
    The properties starting with "sonar.analysis." are included to the payload of webhooks.
    
    Throws:
    
    java.lang.IllegalArgumentException - if key or value parameter is null
    
    Since:
    
    6.1
    
    See Also:
    
    PostProjectAnalysisTask.ProjectAnalysis.getScannerContext()
  - markForPublishing
```
void markForPublishing(InputFile inputFile)
```
    Indicate that a file should be published in the report sent to SonarQube. Files are automatically marked if any data is created for it (issues, highlighting, coverage, etc.).
    
    Since:
    
    6.3

Interface SensorContext

Method Summary

Method Detail

settings

config

fileSystem

activeRules

module

project

getSonarQubeVersion

runtime

isCancelled

newMeasure

newIssue

newExternalIssue

newAdHocRule

newHighlighting

newSymbolTable

newCoverage

newCpdTokens

newAnalysisError

newSignificantCode

addContextProperty

markForPublishing