org.yestech.event.multicaster.IEventMulticaster Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yesevent Show documentation

Java Based Event framework that can be used with a Dependency Injection system or without. Currently Spring and Guice are supported. The Framework is pluggable with implementation that support direct routing and integration of apache camel to handle the routing of events.

The newest version!

/*
 * Copyright LGPL3
 * YES Technology Association
 * http://yestech.org
 *
 * http://www.opensource.org/licenses/lgpl-3.0.html
 */
package org.yestech.event.multicaster;

import org.yestech.event.listener.IListener;
import org.yestech.event.event.IEvent;

/**
 * Interface for the event multicaster
 *
 * @see org.yestech.event.event.IEvent
 * @see org.yestech.event.listener.IListener
 */
public interface IEventMulticaster
{

    /**
     * Return is the result type should be checked.
     *
     * @return
     */
    public boolean isCheckResultType();

    /**
     * Sets whether the type of result is checked or not.
     *
     * @param resultTypeCheck
     */
    public void setCheckResultType(boolean checkResultType);

    /**
     * Called by the client to process an event.
     *
     * @param event The event that should be processed.
     * @return A result from the multicaster.
     */
    RESULT process(EVENT event);

    /**
     * Registers a listener with an event it can handle.
     *
     * @param listener Listener to register
     */
      void registerListener(L listener);

    /**
     * DeRegisters a listener from and event it can handle.
     *
     * @param listener Listener to deregister
     */
     void deregisterListener(L listener);

}