001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2014 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     */
020    package org.sonar.api.batch;
021    
022    import org.sonar.api.BatchExtension;
023    import org.sonar.api.resources.Project;
024    
025    /**
026     * <p>
027     * Initializer can execute external tool (like a Maven plugin), change project configuration. For example CoberturaMavenInitializer invokes
028     * the Codehaus Cobertura Mojo and sets path to Cobertura report according to Maven POM.
029     * </p>
030     * 
031     * <p>
032     * Initializers are executed first and once during project analysis.
033     * </p>
034     * 
035     * @since 2.6
036     */
037    public abstract class Initializer implements BatchExtension, CheckProject {
038    
039      public boolean shouldExecuteOnProject(Project project) {
040        return true;
041      }
042    
043      public abstract void execute(Project project);
044    
045      @Override
046      public String toString() {
047        return getClass().getSimpleName();
048      }
049    
050    }