Package org.sonar.iac.common.yaml

Class YamlSensor

java.lang.Object

org.sonar.iac.common.extension.IacSensor

org.sonar.iac.common.yaml.YamlSensor

All Implemented Interfaces:

org.sonar.api.batch.sensor.Sensor, org.sonar.api.scanner.sensor.ProjectSensor

public abstract class YamlSensor
extends IacSensor

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.sonar.api.batch.rule.Checks<IacCheck>	checks
protected static final String	FILE_SEPERATOR
protected static final String	JSON_LANGUAGE_KEY
protected static final String	YAML_LANGUAGE_KEY

Fields inherited from class org.sonar.iac.common.extension.IacSensor

fileLinesContextFactory, language, noSonarFilter, sonarRuntime

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	YamlSensor(org.sonar.api.SonarRuntime sonarRuntime, org.sonar.api.measures.FileLinesContextFactory fileLinesContextFactory, org.sonar.api.batch.rule.CheckFactory checkFactory, org.sonar.api.issue.NoSonarFilter noSonarFilter, org.sonar.api.resources.Language language, List<Class<?>> checks)

Method Summary

Modifier and Type	Method	Description
protected abstract org.sonar.api.batch.fs.FilePredicate	customFilePredicate(org.sonar.api.batch.sensor.SensorContext sensorContext)
void	describe(org.sonar.api.batch.sensor.SensorDescriptor descriptor)
protected org.sonar.api.batch.fs.FilePredicate	mainFilePredicate(org.sonar.api.batch.sensor.SensorContext sensorContext)
protected ParseException	toParseException(String action, org.sonar.api.batch.fs.InputFile inputFile, Exception cause)
protected TreeParser<Tree>	treeParser()
protected List<TreeVisitor<InputFileContext>>	visitors(org.sonar.api.batch.sensor.SensorContext sensorContext, DurationStatistics statistics)

Methods inherited from class org.sonar.iac.common.extension.IacSensor

execute, getActivationSettingKey, importExternalReports, isNotSonarLintContext, repositoryKey

Methods inherited from class java.lang.Object

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

Field Details

JSON_LANGUAGE_KEY

protected static final String JSON_LANGUAGE_KEY

See Also:

• Constant Field Values

YAML_LANGUAGE_KEY

protected static final String YAML_LANGUAGE_KEY

See Also:

• Constant Field Values

FILE_SEPERATOR

protected static final String FILE_SEPERATOR

See Also:

• Constant Field Values

checks

protected final org.sonar.api.batch.rule.Checks<IacCheck> checks

Constructor Details

YamlSensor

protected YamlSensor(org.sonar.api.SonarRuntime sonarRuntime,
 org.sonar.api.measures.FileLinesContextFactory fileLinesContextFactory,
 org.sonar.api.batch.rule.CheckFactory checkFactory,
 org.sonar.api.issue.NoSonarFilter noSonarFilter,
 org.sonar.api.resources.Language language,
 List<Class<?>> checks)

Method Details

describe

public void describe(org.sonar.api.batch.sensor.SensorDescriptor descriptor)

Specified by:

describe in interface org.sonar.api.scanner.sensor.ProjectSensor

Specified by:

describe in interface org.sonar.api.batch.sensor.Sensor

Overrides:

describe in class IacSensor

treeParser

protected TreeParser<Tree> treeParser()

Specified by:

treeParser in class IacSensor

visitors

protected List<TreeVisitor<InputFileContext>> visitors(org.sonar.api.batch.sensor.SensorContext sensorContext,
 DurationStatistics statistics)

Specified by:

visitors in class IacSensor

toParseException

protected ParseException toParseException(String action,
 org.sonar.api.batch.fs.InputFile inputFile,
 Exception cause)

Overrides:

toParseException in class IacSensor

mainFilePredicate

protected org.sonar.api.batch.fs.FilePredicate mainFilePredicate(org.sonar.api.batch.sensor.SensorContext sensorContext)

Overrides:

mainFilePredicate in class IacSensor

customFilePredicate

protected abstract org.sonar.api.batch.fs.FilePredicate customFilePredicate(org.sonar.api.batch.sensor.SensorContext sensorContext)