Slight refactor of the EventManager.

- Shuffle out the clutter of deviations of registerListener to a builder system that is much more flexible to future changes
- Remove unregisterPluginListeners. It is a pointless separation when unregisterListeners could simply account for it in an implementation as dictated by the javadoc specification

Signed-off-by: Chris Sanders <[email protected]>

Javadocs, TypeToken -> Type.

Signed-off-by: Chris Sanders <[email protected]>

Author: Zidane

src/main/java/org/spongepowered/api/event/EventListener.java

@@ -29,6 +29,7 @@
  *
  * @param <T> The type of the event
  */
+@FunctionalInterface
 public interface EventListener<T extends Event> {
 
     /**

src/main/java/org/spongepowered/api/event/EventListenerRegistration.java

@@ -0,0 +1,78 @@
+/*
+ * This file is part of SpongeAPI, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * 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 org.spongepowered.api.event;
+
+import io.leangen.geantyref.TypeToken;
+import org.spongepowered.api.Sponge;
+import org.spongepowered.api.util.ResettableBuilder;
+import org.spongepowered.plugin.PluginContainer;
+
+import java.lang.reflect.Type;
+import java.util.Objects;
+
+/**
+ * Represents the composition of a {@link EventListener listener} and the attributes that define it
+ * to the system.
+ *
+ * @param <T> The event type
+ */
+public interface EventListenerRegistration<T extends Event> {
+
+    static <T extends Event> EventListenerRegistration.Builder<T> builder(final TypeToken<T> eventType) {
+        return Sponge.game().factoryProvider().provide(Factory.class).builder(Objects.requireNonNull(eventType, "eventType"));
+    }
+
+    static <T extends Event> EventListenerRegistration.Builder<T> builder(final Class<T> eventClass) {
+        return Sponge.game().factoryProvider().provide(Factory.class).builder(TypeToken.get(eventClass));
+    }
+
+    Type eventType();
+
+    PluginContainer plugin();
+
+    Order order();
+
+    boolean beforeModifications();
+
+    EventListener<? super T> listener();
+
+    interface Builder<T extends Event> extends ResettableBuilder<EventListenerRegistration<T>, Builder<T>> {
+
+        Builder<T> plugin(PluginContainer plugin);
+
+        Builder<T> order(Order order);
+
+        Builder<T> beforeModifications(boolean beforeModifications);
+
+        Builder<T> listener(EventListener<? super T> listener);
+
+        EventListenerRegistration<T> build();
+    }
+
+    interface Factory {
+
+        <T extends Event> Builder<T> builder(TypeToken<T> eventType);
+    }
+}

src/main/java/org/spongepowered/api/event/EventManager.java

@@ -24,14 +24,21 @@
  */
 package org.spongepowered.api.event;
 
-import io.leangen.geantyref.TypeToken;
 import org.spongepowered.plugin.PluginContainer;
 
 /**
  * Manages the registration of event listeners and the dispatching of events.
  */
 public interface EventManager {
 
+    /**
+     * Submits a new {@link EventListenerRegistration listener registration} to this manager.
+     * @param registration The registration
+     * @param <E> The event type
+     * @return This manager, for fluency
+     */
+    <E extends Event> EventManager registerListener(EventListenerRegistration<E> registration);
+
     /**
      * Registers {@link Event} methods annotated with @{@link Listener} in the
      * specified object.
@@ -41,131 +48,23 @@ public interface EventManager {
      *
      * @param plugin The plugin instance
      * @param obj The object
-     * @throws IllegalArgumentException Thrown if {@code plugin} is not a plugin
-     *         instance
-     */
-    void registerListeners(PluginContainer plugin, Object obj);
-
-    /**
-     * Registers an event listener for a specific event class.
-     *
-     * <p>Normally, the annotation-based way in
-     * {@link #registerListeners(PluginContainer, Object)} should be preferred over this way. This
-     * method exists primarily to support dynamic event registration like needed
-     * in scripting plugins.</p>
-     *
-     * @param plugin The plugin instance
-     * @param eventClass The event to listen to
-     * @param listener The listener to receive the events
-     * @param <T> The type of the event
+     * @return This manager, for fluency
      */
-    <T extends Event> void registerListener(PluginContainer plugin, Class<T> eventClass, EventListener<? super T> listener);
-
-    /**
-     * Registers an event listener for a specific event {@link TypeToken}.
-     *
-     * <p>Normally, the annotation-based way in
-     * {@link #registerListeners(PluginContainer, Object)} should be preferred over this way. This
-     * method exists primarily to support dynamic event registration like needed
-     * in scripting plugins.</p>
-     *
-     * @param plugin The plugin instance
-     * @param eventType The event to listen to
-     * @param listener The listener to receive the events
-     * @param <T> The type of the event
-     */
-    <T extends Event> void registerListener(PluginContainer plugin, TypeToken<T> eventType, EventListener<? super T> listener);
-
-    /**
-     * Registers an event listener with the specified order for a specific event
-     * class.
-     *
-     * <p>Normally, the annotation-based way in
-     * {@link #registerListeners(PluginContainer, Object)} should be preferred over this way. This
-     * method exists primarily to support dynamic event registration like needed
-     * in scripting plugins.</p>
-     *
-     * @param plugin The plugin instance
-     * @param eventClass The event to listen to
-     * @param order The order the listener will get called at
-     * @param listener The listener to receive the events
-     * @param <T> The type of the event
-     */
-    <T extends Event> void registerListener(PluginContainer plugin, Class<T> eventClass, Order order, EventListener<? super T> listener);
-
-    /**
-     * Registers an event listener with the specified order for a specific event
-     * {@link TypeToken}.
-     *
-     * <p>Normally, the annotation-based way in
-     * {@link #registerListeners(PluginContainer, Object)} should be preferred over this way. This
-     * method exists primarily to support dynamic event registration like needed
-     * in scripting plugins.</p>
-     *
-     * @param plugin The plugin instance
-     * @param eventType The event to listen to
-     * @param order The order the listener will get called at
-     * @param listener The listener to receive the events
-     * @param <T> The type of the event
-     */
-    <T extends Event> void registerListener(PluginContainer plugin, TypeToken<T> eventType, Order order, EventListener<? super T> listener);
-
-    /**
-     * Registers an event listener with the specified order for a specific event
-     * class.
-     *
-     * <p>Normally, the annotation-based way in
-     * {@link #registerListeners(PluginContainer, Object)} should be preferred over this way. This
-     * method exists primarily to support dynamic event registration like needed
-     * in scripting plugins.</p>
-     *
-     * @param plugin The plugin instance
-     * @param eventClass The event to listen to
-     * @param order The order the listener will get called at
-     * @param beforeModifications Whether to call the listener before other
-     *      server modifications
-     * @param listener The listener to receive the events
-     * @param <T> The type of the event
-     */
-    <T extends Event> void registerListener(PluginContainer plugin, Class<T> eventClass, Order order, boolean beforeModifications,
-            EventListener<? super T> listener);
-
-    /**
-     * Registers an event listener with the specified order for a specific event
-     * class.
-     *
-     * <p>Normally, the annotation-based way in
-     * {@link #registerListeners(PluginContainer, Object)} should be preferred over this way. This
-     * method exists primarily to support dynamic event registration like needed
-     * in scripting plugins.</p>
-     *
-     * @param plugin The plugin instance
-     * @param eventType The event to listen to
-     * @param order The order the listener will get called at
-     * @param beforeModifications Whether to call the listener before other
-     *      server modifications
-     * @param listener The listener to receive the events
-     * @param <T> The type of the event
-     */
-    <T extends Event> void registerListener(PluginContainer plugin, TypeToken<T> eventType, Order order, boolean beforeModifications,
-            EventListener<? super T> listener);
+    EventManager registerListeners(PluginContainer plugin, Object obj);
 
     /**
      * Un-registers an object from receiving {@link Event}s.
      *
-     * @param obj The object
-     */
-    void unregisterListeners(Object obj);
-
-    /**
-     * Un-registers all event listeners of a plugin.
+     * <p>If the provided object is a {@link PluginContainer plugin}, all events associated
+     * with that plugin will be unregistered.</p>
      *
-     * @param plugin The plugin instance
+     * @param obj The object
+     * @return This manager, for fluency
      */
-    void unregisterPluginListeners(PluginContainer plugin);
+    EventManager unregisterListeners(Object obj);
 
     /**
-     * Calls a {@link Event} to all listeners that listen to it.
+     * Calls an {@link Event} to all listeners that listen to it.
      *
      * @param event The event
      * @return True if cancelled, false if not