@Deprecated @ScannerSide @ExtensionPoint public interface Sensor extends CheckProject
A Sensor is invoked once during the analysis of a project. The sensor can parse a flat file, connect to a web server... Sensor are generally used to add measure at the lowest level of the resource tree. A sensor can access and save measures on the whole tree of resources.
For example the Cobertura Sensor parses Cobertura report and saves the first-level of measures on resources.
A particular attention should be given to resource exclusion. Sonar already manages exclusions at file level : if you try to save a measure on a resource that is excluded in the settings, then Sonar will not save the measure. When handling a plugin or an external tool, you should make sure that exclusions are passed if you are going to get back consolidated data.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
FLAG_SQUID_ANALYSIS
Deprecated.
Sensors that depend upon Squid must declare the following method :
|
Modifier and Type | Method and Description |
---|---|
void |
analyse(Project module,
SensorContext context)
Deprecated.
The method that is going to be run when the sensor is called
|
shouldExecuteOnProject
static final java.lang.String FLAG_SQUID_ANALYSIS
@DependsUpon public String dependsUponSquidAnalysis() { return Sensor.FLAG_SQUID_ANALYSIS; }
void analyse(Project module, SensorContext context)
module
- the module the sensor runs oncontext
- the context