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