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.BatchExtension; 023import org.sonar.api.batch.InstantiationStrategy; 024 025/** 026 * This extension point allows to change project structure at runtime. It is executed once during task startup. 027 * Some use-cases : 028 * <ul> 029 * <li>Add sub-projects. For example the C# plugin gets the hierarchy 030 * of sub-projects from the Visual Studio metadata file. The single root pom.xml does not contain any declarations of 031 * modules</li> 032 * <li>Change project metadata like description or source directories.</li> 033 * </ul> 034 * 035 * @since 2.9 036 */ 037@InstantiationStrategy(InstantiationStrategy.PER_BATCH) 038public abstract class ProjectBuilder implements BatchExtension { 039 040 /** 041 * Plugins can use the implementation {@link org.sonar.api.batch.bootstrap.internal.ProjectBuilderContext} 042 * for their unit tests. 043 */ 044 public interface Context { 045 ProjectReactor projectReactor(); 046 } 047 /** 048 * Don't inject ProjectReactor as it may not be available 049 * @deprecated since 3.7 use {@link #ProjectBuilder()} 050 */ 051 @Deprecated 052 protected ProjectBuilder(final ProjectReactor reactor) { 053 } 054 055 /** 056 * @since 3.7 057 */ 058 protected ProjectBuilder() { 059 } 060 061 /** 062 * Override this method to change project reactor structure. 063 * @since 3.7 064 */ 065 public void build(Context context) { 066 // Call deprecated method for backward compatibility 067 build(context.projectReactor()); 068 } 069 070 /** 071 * @deprecated since 3.7 override {@link #build(Context)} instead 072 */ 073 @Deprecated 074 protected void build(ProjectReactor reactor) { 075 } 076}