001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2008-2012 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * Sonar 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     * Sonar 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
017     * License along with Sonar; if not, write to the Free Software
018     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019     */
020    package org.sonar.api.batch.bootstrap;
021    
022    import org.sonar.api.BatchExtension;
023    import org.sonar.api.batch.InstantiationStrategy;
024    
025    /**
026     * This extension point allows to change project structure at runtime. It is executed once during batch startup.
027     * Some use-cases :
028     * <ul>
029     *   <li>Add sub-projects which are not defined in batch bootstrapper. 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)
038    public abstract class ProjectBuilder implements BatchExtension {
039    
040      private ProjectReactor reactor;
041    
042      protected ProjectBuilder(final ProjectReactor reactor) {
043        this.reactor = reactor;
044      }
045    
046      public final void start() {
047        build(reactor);
048      }
049    
050      protected abstract void build(ProjectReactor reactor);
051    }