net.sf.seide.event.EventHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of seide-core Show documentation

The newest version!

package net.sf.seide.event;

import net.sf.seide.message.Message;
import net.sf.seide.stages.RoutingOutcome;
import net.sf.seide.stages.Stage;

/**
 * {@link EventHandler} represents the unit of work behind the {@link Stage}.
 * 
 * @author german.kondolf
 * @see {@link Message}
 * @see {@link RoutingOutcome}
 */
public interface EventHandler {

    /**
     * Execution of {@link Stage} {@link EventHandler}.
     * 
     * @param message payload received.
     * @return {@link RoutingOutcome} specifiying the next {@link Stage} and the {@link Message} passsed to it or them.
     *         Null return value is allowed, mainly to mark the end of a execution path.
     */
    RoutingOutcome execute(T message);

}