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.batch.events;
021    
022    import org.sonar.api.batch.events.EventHandler;
023    
024    /**
025     * Root of all Sonar Batch events.
026     * 
027     * @param <H> handler type
028     */
029    public abstract class BatchEvent<H extends EventHandler> {
030    
031      protected BatchEvent() {
032      }
033    
034      /**
035       * Do not call directly - should be called only by {@link EventBus}.
036       * Typically should be implemented as following: <code>handler.onEvent(this)</code>
037       */
038      protected abstract void dispatch(H handler);
039    
040      /**
041       * Returns class of associated handler. Used by {@link EventBus} to dispatch events to the correct handlers.
042       */
043      protected abstract Class getType();
044    
045    }