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