org.openstreetmap.atlas.event.Processor Maven / Gradle / Ivy

Go to download
package org.openstreetmap.atlas.event;

/**
 * The {@link Processor} interface provides simple hooks for implementations to handle events.
 *
 * @author mkalender
 * @param 
 *            Type that is going to be processed
 */
public interface Processor
{
    /**
     * Method to process {@link ShutdownEvent}. This method will be called only once.

     * Please make sure to add {@code @Subscribe} annotation to the method that is
     * implementing this method.
     *
     * @param event
     *            {@link ShutdownEvent} to process
     */
    void process(ShutdownEvent event);

    /**
     * Method to process {@link Event}. If your method can process multiple events simultaneously,
     * then mark your method with {@code @AllowConcurrentEvents} annotation.Please make sure
     * to add {@code @Subscribe} annotation to the method that is implementing this method.
     *
     * @param event
     *            {@link Event} to process
     */
    void process(T event);
}