001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2014 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * SonarQube 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     * SonarQube 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     */
020    package org.sonar.api.batch.sensor;
021    
022    import com.google.common.annotations.Beta;
023    import org.sonar.api.BatchExtension;
024    
025    /**
026     * <p>
027     * A sensor is invoked once during the analysis of a project. The sensor can parse a flat file, connect to a web server... Sensors are
028     * used to add measure and issues at file level.
029     * </p>
030     *
031     * <p>
032     * For example the Cobertura Sensor parses Cobertura report and saves the first-level of measures on files.
033     * </p>
034     *
035     * @since 4.4
036     */
037    @Beta
038    public interface Sensor extends BatchExtension {
039    
040      /**
041       * Populate {@link SensorDescriptor} of this sensor.
042       */
043      void describe(SensorDescriptor descriptor);
044    
045      /**
046       * The actual sensor code.
047       */
048      void execute(SensorContext context);
049    
050    }