001/* 002 * SonarQube 003 * Copyright (C) 2009-2017 SonarSource SA 004 * mailto:info AT sonarsource DOT com 005 * 006 * This program 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 * This program 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; 021 022import org.sonar.api.ExtensionPoint; 023import org.sonar.api.batch.fs.FileSystem; 024import org.sonar.api.resources.Project; 025 026/** 027 * <p> 028 * Initializer are executed at the very beginning of each module analysis, prior the core listing files to be analyzed. It means {@link FileSystem} should not be accessed. 029 * <p> 030 * @since 2.6 031 */ 032@ScannerSide 033@ExtensionPoint 034public abstract class Initializer implements CheckProject { 035 036 /** 037 * @deprecated since 5.6 should no more be implemented by plugins 038 */ 039 @Deprecated 040 @Override 041 public boolean shouldExecuteOnProject(Project project) { 042 return true; 043 } 044 045 /** 046 * @deprecated since 5.6 override {@link #execute()} instead 047 */ 048 @Deprecated 049 public void execute(Project project) { 050 execute(); 051 } 052 053 public void execute() { 054 // To be implemented by client 055 } 056 057 @Override 058 public String toString() { 059 return getClass().getSimpleName(); 060 } 061 062}