|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Beta public interface SensorDescriptor
Describe what an Sensor
is doing. Information may be used by the platform
to log interesting information or perform some optimization.
Method Summary | |
---|---|
SensorDescriptor |
createIssuesForRuleRepositories(String... repositoryKeys)
List InputFile.Type this Sensor work on. |
SensorDescriptor |
dependsOn(Metric<?>... metrics)
List Metric this Sensor depends on. |
SensorDescriptor |
name(String name)
Name of the Sensor . |
SensorDescriptor |
provides(Metric<?>... metrics)
List Metric this Sensor provides. |
SensorDescriptor |
workOnFileTypes(InputFile.Type... types)
List InputFile.Type this Sensor work on. |
SensorDescriptor |
workOnLanguages(String... languageKeys)
List languages this Sensor work on. |
Method Detail |
---|
SensorDescriptor name(String name)
Sensor
. Will be displayed in logs.
SensorDescriptor dependsOn(Metric<?>... metrics)
Metric
this Sensor
depends on. Will be used to execute sensors in correct order.
SensorDescriptor provides(Metric<?>... metrics)
Metric
this Sensor
provides. Will be used to execute sensors in correct order.
SensorDescriptor workOnLanguages(String... languageKeys)
Sensor
work on. May be used by the platform to skip execution of the Sensor
when
no file for given languages are present in the project.
If no language is provided then it will be executed for all languages.
SensorDescriptor workOnFileTypes(InputFile.Type... types)
InputFile.Type
this Sensor
work on. May be used by the platform to skip execution of the Sensor
when
no file for given type are present in the project.
If you don't call this method then it means sensor is working on all input file types.
SensorDescriptor createIssuesForRuleRepositories(String... repositoryKeys)
InputFile.Type
this Sensor
work on. May be used by the platform to skip execution of the Sensor
when
no file for given type are present in the project.
If not type is provided then it will be executed for all types.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |