team.unnamed.creative.central.event.EventBus Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of creative-central-api Show documentation
The resource-pack unifier for Minecraft: Java Edition servers.
There is a newer version: 1.4.0
/*
 * This file is part of creative-central, licensed under the MIT license
 *
 * Copyright (c) 2021-2023 Unnamed Team
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package team.unnamed.creative.central.event;

import java.util.function.Consumer;

/**
 * An event bus. Main interface for an event/listener
 * or pub/sub local system.
 *
 * @since 1.0.0
 */
public interface EventBus {

    /**
     * Registers a new {@link EventListener} for the given
     * {@code eventType}, from the given {@code plugin}
     *
     * @param plugin The registerer plugin
     * @param eventType The subscribed event type
     * @param listener The actual event listener
     * @param  The event type
     * @since 1.0.0
     */
     void listen(Object plugin, Class eventType, EventListener listener);

    /**
     * Registers a new {@link EventListener} using the given
     * {@code listener} and {@code priority}, from the given
     * {@code plugin} and for the given event type
     *
     * @param plugin The registerer plugin
     * @param eventType The subscribed event type
     * @param priority The event listener priority
     * @param listener The actual event listener
     * @param  The event type
     * @since 1.0.0
     */
    default  void listen(Object plugin, Class eventType, EventListener.Priority priority, Consumer listener) {
        listen(plugin, eventType, new EventListener() {

            @Override
            public void on(E event) {
                listener.accept(event);
            }

            @Override
            public Priority priority() {
                return priority;
            }

            @Override
            public String toString() {
                return "EventListener<" + eventType + "> { " +
                        "priority = '" + priority + "', " +
                        "listener = '" + listener + "' " +
                        "}";
            }

        });
    }

    /**
     * Calls the given {@code event}. This will execute
     * all the listener subscribed to the provided event
     * type.
     *
     * @param eventType The event type
     * @param event The event data
     * @param  The event type
     * @since 1.0.0
     */
     void call(Class eventType, E event);

}