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 org.sonar.api.batch.fs.InputFile;
023    import org.sonar.api.batch.measure.Metric;
024    
025    /**
026     * Describe what an {@link Sensor} is doing. Information may be used by the platform
027     * to log interesting information or perform some optimization.
028     * See {@link Sensor#describe(SensorDescriptor)}
029     * @since 5.0
030     */
031    public interface SensorDescriptor {
032    
033      /**
034       * Name of the {@link Sensor}. Will be displayed in logs.
035       */
036      SensorDescriptor name(String name);
037    
038      /**
039       * List {@link Metric} this {@link Sensor} depends on. Will be used to execute sensors in correct order.
040       */
041      SensorDescriptor dependsOn(Metric<?>... metrics);
042    
043      /**
044       * List {@link Metric} this {@link Sensor} provides. Will be used to execute sensors in correct order.
045       */
046      SensorDescriptor provides(Metric<?>... metrics);
047    
048      /**
049       * List languages this {@link Sensor} work on. May be used by the platform to skip execution of the {@link Sensor} when
050       * no file for given languages are present in the project.
051       * If no language is provided then it will be executed for all languages.
052       */
053      SensorDescriptor workOnLanguages(String... languageKeys);
054    
055      /**
056       * List {@link InputFile.Type} this {@link Sensor} work on. May be used by the platform to skip execution of the {@link Sensor} when
057       * no file for given type are present in the project.
058       * If you don't call this method then it means sensor is working on all input file types.
059       */
060      SensorDescriptor workOnFileTypes(InputFile.Type... types);
061    
062      /**
063       * List {@link InputFile.Type} this {@link Sensor} work on. May be used by the platform to skip execution of the {@link Sensor} when
064       * no file for given type are present in the project.
065       * If not type is provided then it will be executed for all types.
066       */
067      SensorDescriptor createIssuesForRuleRepositories(String... repositoryKeys);
068    
069    }