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;
021
022import org.sonar.api.resources.Language;
023import org.sonar.api.resources.Project;
024import org.sonar.api.resources.ProjectFileSystem;
025import org.sonar.api.resources.Resource;
026
027import java.io.File;
028import java.nio.charset.Charset;
029import java.util.List;
030
031/**
032 * @since 1.10
033 * @deprecated since 4.2 Component indexing and source import are done by core and this extension is not used.
034 */
035@Deprecated
036@Phase(name = Phase.Name.PRE)
037public abstract class AbstractSourceImporter implements Sensor {
038
039  private Language language;
040
041  public AbstractSourceImporter(Language language) {
042    this.language = language;
043  }
044
045  @Override
046  public boolean shouldExecuteOnProject(Project project) {
047    return false;
048  }
049
050  @Override
051  public void analyse(Project project, SensorContext context) {
052    // Do not remove for backward compatibility
053  }
054
055  protected void onFinished() {
056
057  }
058
059  protected void analyse(ProjectFileSystem fileSystem, SensorContext context) {
060    // Do not remove for backward compatibility
061  }
062
063  protected void parseDirs(SensorContext context, List<File> files, List<File> sourceDirs, boolean unitTest, Charset sourcesEncoding) {
064    // Do not remove for backward compatibility
065  }
066
067  protected Resource createResource(File file, List<File> sourceDirs, boolean unitTest) {
068    return null;
069  }
070
071  protected boolean isEnabled(Project project) {
072    return false;
073  }
074
075  public Language getLanguage() {
076    return language;
077  }
078}