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.bootstrap;
021
022import org.sonar.api.task.TaskExtension;
023
024/**
025 * This extension point initializes the project structure. It is extended by batch bootstrappers
026 * like sonar-runner or Maven plugin. It is not supposed to be used by standard plugins (.NET, ...).
027 * Some use-cases :
028 * <ul>
029 *   <li>Maven Plugins defines project structure from pom.xml</li>
030 *   <li>Sonar Runner defines project from sonar-runner.properties</li>
031 * </ul>
032 * Only one instance is allowed per environment.
033 *
034 * @since 3.7
035 */
036public interface ProjectBootstrapper extends TaskExtension {
037
038  /**
039   * Implement this method to create project reactor
040   */
041  ProjectReactor bootstrap();
042
043}