org.sonar.api.batch.sensor

Interface SensorDescriptor

All Known Implementing Classes:

DefaultSensorDescriptor

@Beta
public interface SensorDescriptor

Describe what a Sensor is doing. Information may be used by the platform to log interesting information or perform some optimization. See Sensor.describe(SensorDescriptor)

Since:

5.1

Method Summary

Methods

Modifier and Type	Method and Description
SensorDescriptor	createIssuesForRuleRepositories(String... repositoryKeys) List rule repositories this Sensor create issues for.
SensorDescriptor	createIssuesForRuleRepository(String... repositoryKey) Rule repository this Sensor create issues for.
SensorDescriptor	disabledInIssues() Should this sensor be disabled in issues mode.
SensorDescriptor	name(String sensorName) Displayable name of the Sensor.
SensorDescriptor	onlyOnFileType(InputFile.Type type) InputFile.Type this Sensor work on.
SensorDescriptor	onlyOnLanguage(String languageKey) Language this Sensor work on.
SensorDescriptor	onlyOnLanguages(String... languageKeys) List languages this Sensor work on.
SensorDescriptor	requireProperties(String... propertyKeys) List properties this Sensor depends on.
SensorDescriptor	requireProperty(String... propertyKey) Property this Sensor depends on.

Method Detail

name

SensorDescriptor name(String sensorName)

Displayable name of the Sensor. Will be displayed in logs.

onlyOnLanguage

SensorDescriptor onlyOnLanguage(String languageKey)

Language this Sensor work on. Used by the platform to skip execution of the Sensor when no file for given languages are present in the project. Default is to execute sensor for all languages.

onlyOnLanguages

SensorDescriptor onlyOnLanguages(String... languageKeys)

List languages this Sensor work on. Used by the platform to skip execution of the Sensor when no file for given languages are present in the project. Default is to execute sensor for all languages.

onlyOnFileType

SensorDescriptor onlyOnFileType(InputFile.Type type)

InputFile.Type this Sensor work on. Used by the platform to skip execution of the Sensor when no file for given type are present in the project. Default is to execute sensor whatever are the available file types.

createIssuesForRuleRepository

SensorDescriptor createIssuesForRuleRepository(String... repositoryKey)

Rule repository this Sensor create issues for. Used by the platform to skip execution of the Sensor when no rule is activated for the given repository.

createIssuesForRuleRepositories

SensorDescriptor createIssuesForRuleRepositories(String... repositoryKeys)

List rule repositories this Sensor create issues for. Used by the platform to skip execution of the Sensor when no rule is activated for the given repositories.

requireProperty

SensorDescriptor requireProperty(String... propertyKey)

Property this Sensor depends on. Used by the platform to skip execution of the Sensor when property is not set.

requireProperties

SensorDescriptor requireProperties(String... propertyKeys)

List properties this Sensor depends on. Used by the platform to skip execution of the Sensor when property is not set.

disabledInIssues

SensorDescriptor disabledInIssues()

Should this sensor be disabled in issues mode. Default is to run all sensors in issues mode.