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.events;
021
022import java.util.List;
023import org.sonar.api.batch.Sensor;
024
025/**
026 * @since 2.8
027 */
028@FunctionalInterface
029public interface SensorsPhaseHandler extends EventHandler {
030
031  /**
032   * This interface is not intended to be implemented by clients.
033   */
034  interface SensorsPhaseEvent {
035
036    /**
037     * @return list of Sensors in the order of execution
038     */
039    List<Sensor> getSensors();
040
041    boolean isStart();
042
043    boolean isEnd();
044
045  }
046
047  /**
048   * Called before and after execution of all {@link Sensor}s.
049   */
050  void onSensorsPhase(SensorsPhaseEvent event);
051
052}