org.sonar.api.batch.bootstrap.ProjectBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonarlint-core Show documentation
Show all versions of sonarlint-core Show documentation
Common library used by some SonarLint flavors
/*
* SonarQube
* Copyright (C) 2009-2021 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.api.batch.bootstrap;
import org.sonar.api.ExtensionPoint;
import org.sonar.api.config.Configuration;
import org.sonar.api.scanner.ScannerSide;
/**
* This extension point allows to change project structure at runtime. It is executed once during task startup.
* Some use-cases :
*
* - Add sub-projects. For example the C# plugin gets the hierarchy
* of sub-projects from the Visual Studio metadata file. The single root pom.xml does not contain any declarations of
* modules
* - Change project metadata like description or source directories.
*
*
* @deprecated since 6.5. It won't be possible to manipulate the project's structure.
* @since 2.9
*/
@ScannerSide
@ExtensionPoint
@Deprecated
public abstract class ProjectBuilder {
@Deprecated
public interface Context {
ProjectReactor projectReactor();
/**
* Global config (command line arguments, global scanner properties).
* @since 8.3 Only as a replacement for injecting Settings
*/
Configuration config();
}
/**
* @since 3.7
*/
protected ProjectBuilder() {
}
/**
* Override this method to change project reactor structure.
* @since 3.7
*/
public void build(Context context) {
// Call deprecated method for backward compatibility
build(context.projectReactor());
}
/**
* @deprecated since 3.7 override {@link #build(Context)} instead
*/
@Deprecated
protected void build(ProjectReactor reactor) {
}
}