001/*
002 * SonarQube
003 * Copyright (C) 2009-2017 SonarSource SA
004 * mailto:info AT sonarsource DOT com
005 *
006 * This program is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * This program is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019 */
020package org.sonar.api.batch.sensor;
021
022import org.sonar.api.ExtensionPoint;
023import org.sonar.api.batch.ScannerSide;
024import org.sonar.api.batch.sensor.internal.SensorContextTester;
025import org.sonarsource.api.sonarlint.SonarLintSide;
026
027/**
028 * <p>
029 * A sensor is invoked once for each module of a project, starting from leaf modules. The sensor can parse a flat file, connect to a web server... Sensors are
030 * used to add measure and issues at file level.
031 * <p>
032 * For example the Cobertura Sensor parses Cobertura report and saves the first-level of measures on files.
033 * 
034 * For testing purpose you can use {@link SensorContextTester}
035 * @since 5.1
036 */
037@ScannerSide
038@SonarLintSide
039@ExtensionPoint
040public interface Sensor {
041
042  /**
043   * Populate {@link SensorDescriptor} of this sensor.
044   */
045  void describe(SensorDescriptor descriptor);
046
047  /**
048   * The actual sensor code.
049   */
050  void execute(SensorContext context);
051
052}