org.fuin.cqrs4j.EventDispatcher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cqrs-4-java Show documentation

Base classes for Command Query Responsibility Segregation (CQRS) with Java

There is a newer version: 0.5.0

/**
 * Copyright (C) 2015 Michael Schnell. All rights reserved. 
 * http://www.fuin.org/
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 3 of the License, or (at your option) any
 * later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library. If not, see http://www.gnu.org/licenses/.
 */
package org.fuin.cqrs4j;

import java.util.List;
import java.util.Set;

import javax.validation.constraints.NotNull;

import org.fuin.ddd4j.ddd.Event;
import org.fuin.ddd4j.ddd.EventType;
import org.fuin.esc.api.CommonEvent;

/**
 * Registry with all event handlers.
 */
public interface EventDispatcher {

    /**
     * Returns a set of all known types.
     * 
     * @return All known event types.
     */
    @NotNull
    public Set getAllTypes();

    /**
     * Dispatch all common events to the appropriate event handler.
     * 
     * @param commonEvents
     *            Events to dispatch.
     */
    public void dispatchCommonEvents(@NotNull List commonEvents);

    /**
     * Dispatch all events to the appropriate event handler.
     * 
     * @param events
     *            Events to dispatch.
     */
    public void dispatchEvents(@NotNull List events);

    /**
     * Dispatches the given event to the appropriate event handler. The event is
     * ignored if no event handler can be found that is capable of handling it.
     * 
     * @param event
     *            Event to dispatch.
     */
    public void dispatchEvent(@NotNull Event event);

}