org.sonar.api.batch.sensor.internal

Class DefaultSensorDescriptor

java.lang.Object

org.sonar.api.batch.sensor.internal.DefaultSensorDescriptor

All Implemented Interfaces:

SensorDescriptor

public class DefaultSensorDescriptor
extends Object
implements SensorDescriptor

Constructor Summary

Constructors

Constructor and Description
DefaultSensorDescriptor()

Method Summary

Modifier and Type	Method and Description
Predicate<Configuration>	configurationPredicate()
DefaultSensorDescriptor	createIssuesForRuleRepositories(String... repositoryKeys) List rule repositories this Sensor create issues for.
DefaultSensorDescriptor	createIssuesForRuleRepository(String... repositoryKey) Rule repository this Sensor create issues for.
SensorDescriptor	global() This sensor should be executed at the project level, instead of per-module.
boolean	isGlobal()
Collection<String>	languages()
String	name()
DefaultSensorDescriptor	name(String name) Displayable name of the Sensor.
DefaultSensorDescriptor	onlyOnFileType(InputFile.Type type) InputFile.Type this Sensor work on.
DefaultSensorDescriptor	onlyOnLanguage(String languageKey) Language this Sensor work on.
DefaultSensorDescriptor	onlyOnLanguages(String... languageKeys) List languages this Sensor work on.
SensorDescriptor	onlyWhenConfiguration(Predicate<Configuration> configurationPredicate) Predicate that will be evaluated on current module/project Configuration by the platform to decide if execution of the Sensor should be skipped.
DefaultSensorDescriptor	requireProperties(String... propertyKeys) List properties this Sensor depends on.
DefaultSensorDescriptor	requireProperty(String... propertyKey) Property this Sensor depends on.
Collection<String>	ruleRepositories()
InputFile.Type	type()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultSensorDescriptor

public DefaultSensorDescriptor()

Method Detail

name

public String name()

languages

public Collection<String> languages()

type

@Nullable
public InputFile.Type type()

ruleRepositories

public Collection<String> ruleRepositories()

configurationPredicate

public Predicate<Configuration> configurationPredicate()

isGlobal

public boolean isGlobal()

name

public DefaultSensorDescriptor name(String name)

Description copied from interface: SensorDescriptor

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

Specified by:

name in interface SensorDescriptor

onlyOnLanguage

public DefaultSensorDescriptor onlyOnLanguage(String languageKey)

Description copied from interface: SensorDescriptor

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.

Specified by:

onlyOnLanguage in interface SensorDescriptor

onlyOnLanguages

public DefaultSensorDescriptor onlyOnLanguages(String... languageKeys)

Description copied from interface: SensorDescriptor

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.

Specified by:

onlyOnLanguages in interface SensorDescriptor

onlyOnFileType

public DefaultSensorDescriptor onlyOnFileType(InputFile.Type type)

Description copied from interface: SensorDescriptor

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.

Specified by:

onlyOnFileType in interface SensorDescriptor

createIssuesForRuleRepository

public DefaultSensorDescriptor createIssuesForRuleRepository(String... repositoryKey)

Description copied from interface: SensorDescriptor

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.

Specified by:

createIssuesForRuleRepository in interface SensorDescriptor

createIssuesForRuleRepositories

public DefaultSensorDescriptor createIssuesForRuleRepositories(String... repositoryKeys)

Description copied from interface: SensorDescriptor

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.

Specified by:

createIssuesForRuleRepositories in interface SensorDescriptor

requireProperty

public DefaultSensorDescriptor requireProperty(String... propertyKey)

Description copied from interface: SensorDescriptor

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

Specified by:

requireProperty in interface SensorDescriptor

requireProperties

public DefaultSensorDescriptor requireProperties(String... propertyKeys)

Description copied from interface: SensorDescriptor

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

Specified by:

requireProperties in interface SensorDescriptor

global

public SensorDescriptor global()

Description copied from interface: SensorDescriptor

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

Specified by:

global in interface SensorDescriptor

onlyWhenConfiguration

public SensorDescriptor onlyWhenConfiguration(Predicate<Configuration> configurationPredicate)

Description copied from interface: SensorDescriptor

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

Specified by:

onlyWhenConfiguration in interface SensorDescriptor