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