Package org.sonar.api.batch.sensor

Interface SensorDescriptor

All Known Implementing Classes:

DefaultSensorDescriptor

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

Modifier and Type	Method	Description
SensorDescriptor	createIssuesForRuleRepositories(java.lang.String... repositoryKeys)	List rule repositories this Sensor create issues for.
SensorDescriptor	createIssuesForRuleRepository(java.lang.String... repositoryKey)	Rule repository this Sensor create issues for.
SensorDescriptor	global()	Deprecated. since 7.6 change your Sensor to a ProjectSensor instead
SensorDescriptor	name(java.lang.String sensorName)	Displayable name of the Sensor.
SensorDescriptor	onlyOnFileType(InputFile.Type type)	InputFile.Type this Sensor work on.
SensorDescriptor	onlyOnLanguage(java.lang.String languageKey)	Language this Sensor work on.
SensorDescriptor	onlyOnLanguages(java.lang.String... languageKeys)	List languages this Sensor work on.
SensorDescriptor	onlyWhenConfiguration(java.util.function.Predicate<Configuration> predicate)	Predicate that will be evaluated on current project Configuration by the platform to decide if execution of the Sensor should be skipped.
SensorDescriptor	requireProperties(java.lang.String... propertyKeys)	Deprecated. since 6.5 use onlyWhenConfiguration(Predicate)
SensorDescriptor	requireProperty(java.lang.String... propertyKey)	Deprecated. since 6.5 use onlyWhenConfiguration(Predicate)

Method Detail

name

SensorDescriptor name(java.lang.String sensorName)

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

onlyOnLanguage

SensorDescriptor onlyOnLanguage(java.lang.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(java.lang.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(java.lang.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(java.lang.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

@Deprecated
SensorDescriptor requireProperty(java.lang.String... propertyKey)

Deprecated.

since 6.5 use onlyWhenConfiguration(Predicate)

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

requireProperties

@Deprecated
SensorDescriptor requireProperties(java.lang.String... propertyKeys)

Deprecated.

since 6.5 use onlyWhenConfiguration(Predicate)

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

global

@Deprecated
SensorDescriptor global()

Deprecated.

since 7.6 change your Sensor to a ProjectSensor instead

This sensor should be executed at the project level, instead of per-module.

Since:

6.4

onlyWhenConfiguration

SensorDescriptor onlyWhenConfiguration(java.util.function.Predicate<Configuration> predicate)

Predicate that will be evaluated on current project Configuration by the platform to decide if execution of the Sensor should be skipped.

Since:

6.5