feat: use jspecify nullable annotations

api/build.gradle.kts

@@ -9,5 +9,6 @@ projectConfiguration {
 }
 
 dependencies {
-
+    // annotations
+    implementation("org.jspecify:jspecify:1.0.0")
 }

api/src/main/java/com/github/philippheuer/events4j/api/IEventManager.java

@@ -4,6 +4,8 @@
 import com.github.philippheuer.events4j.api.domain.IEventSubscription;
 import com.github.philippheuer.events4j.api.service.IEventHandler;
 import com.github.philippheuer.events4j.api.service.IServiceMediator;
+import org.jspecify.annotations.NonNull;
+import org.jspecify.annotations.Nullable;
 
 import java.util.List;
 import java.util.function.Consumer;
@@ -15,14 +17,14 @@ public interface IEventManager extends AutoCloseable {
      *
      * @param event Event
      */
-    void publish(Object event);
+    void publish(@NonNull Object event);
 
     /**
      * Register EventHandler
      *
      * @param eventHandler IEventHandler
      */
-    void registerEventHandler(IEventHandler eventHandler);
+    void registerEventHandler(@NonNull IEventHandler eventHandler);
 
     /**
      * Registers a new consumer based default event handler if supported
@@ -32,13 +34,15 @@ public interface IEventManager extends AutoCloseable {
      * @param <E>        the event type
      * @return a new Disposable of the given eventType
      */
-    <E> IDisposable onEvent(Class<E> eventClass, Consumer<E> consumer);
+    @NonNull
+    <E> IDisposable onEvent(@NonNull Class<E> eventClass, @NonNull Consumer<E> consumer);
 
     /**
      * Get the ServiceMediator
      *
      * @return ServiceMediator
      */
+    @NonNull
     IServiceMediator getServiceMediator();
 
     /**
@@ -47,29 +51,33 @@ public interface IEventManager extends AutoCloseable {
      * @param eventHandlerClass the event handler class
      * @return boolean
      */
-    boolean hasEventHandler(Class<? extends IEventHandler> eventHandlerClass);
+    boolean hasEventHandler(@NonNull Class<? extends IEventHandler> eventHandlerClass);
 
     /**
      * Retrieves a EventHandler of the provided type
      *
      * @param eventHandlerClass the event handler class
      * @param <E> the eventHandler type
+     * @throws RuntimeException if no event handler of the provided type is registered
      * @return a reference to the requested event handler
      */
-    <E extends IEventHandler> E getEventHandler(Class<E> eventHandlerClass);
+    @NonNull
+    <E extends IEventHandler> E getEventHandler(@NonNull Class<E> eventHandlerClass);
 
     /**
      * Gets all registered event handlers
      *
      * @return a list of all registered event handlers
      */
+    @NonNull
     List<IEventHandler> getEventHandlers();
 
     /**
      * Gets a list of all active subscriptions
      *
      * @return a list that holds IEventSubscription`s
      */
+    @NonNull
     List<IEventSubscription> getActiveSubscriptions();
 
 }

api/src/main/java/com/github/philippheuer/events4j/api/domain/DisposableWrapper.java

@@ -2,6 +2,7 @@
 
 import lombok.Getter;
 import lombok.ToString;
+import org.jspecify.annotations.NonNull;
 
 import java.util.Map;
 import java.util.function.Consumer;
@@ -24,7 +25,7 @@ public class DisposableWrapper implements IEventSubscription {
     private final Map<String, IEventSubscription> activeSubscriptions;
 
     @SuppressWarnings("rawtypes")
-    public DisposableWrapper(IDisposable disposable, String id, Class eventType, Consumer consumer, Map<String, IEventSubscription> activeSubscriptions) {
+    public DisposableWrapper(@NonNull IDisposable disposable, @NonNull String id, @NonNull Class eventType, @NonNull Consumer consumer, @NonNull Map<String, IEventSubscription> activeSubscriptions) {
         this.disposable = disposable;
         this.id = id;
         this.eventType = eventType;

api/src/main/java/com/github/philippheuer/events4j/api/domain/IEventSubscription.java

@@ -1,14 +1,19 @@
 package com.github.philippheuer.events4j.api.domain;
 
+import org.jspecify.annotations.NonNull;
+
 import java.util.function.Consumer;
 
 public interface IEventSubscription extends IDisposable {
 
+    @NonNull
     String getId();
 
+    @NonNull
     @SuppressWarnings("rawtypes")
     Class getEventType();
 
+    @NonNull
     @SuppressWarnings("rawtypes")
     Consumer getConsumer();
 

api/src/main/java/com/github/philippheuer/events4j/api/service/IEventHandler.java

@@ -1,6 +1,7 @@
 package com.github.philippheuer.events4j.api.service;
 
 import com.github.philippheuer.events4j.api.domain.IDisposable;
+import lombok.NonNull;
 
 import java.util.function.Consumer;
 
@@ -11,7 +12,7 @@ public interface IEventHandler extends AutoCloseable {
      *
      * @param event Event
      */
-    void publish(Object event);
+    void publish(@NonNull Object event);
 
     /**
      * Registers a new consumer based default event handler if supported
@@ -21,6 +22,6 @@ public interface IEventHandler extends AutoCloseable {
      * @param <E>        the event type
      * @return a new Disposable of the given eventType
      */
-    <E> IDisposable onEvent(Class<E> eventClass, Consumer<E> consumer);
+    <E> IDisposable onEvent(@NonNull Class<E> eventClass, @NonNull Consumer<E> consumer);
 
 }

api/src/main/java/com/github/philippheuer/events4j/api/service/IServiceMediator.java

@@ -1,5 +1,7 @@
 package com.github.philippheuer.events4j.api.service;
 
+import org.jspecify.annotations.NonNull;
+
 public interface IServiceMediator {
 
     /**
@@ -8,16 +10,18 @@ public interface IServiceMediator {
      * @param serviceName     The ServiceName
      * @param serviceInstance The ServiceInstance
      */
-    void addService(String serviceName, Object serviceInstance);
+    void addService(@NonNull String serviceName, @NonNull Object serviceInstance);
 
     /**
      * Gets a service from the ServiceMediator
      *
      * @param serviceClass The ServiceClass you expect
      * @param serviceName  The ServiceName
      * @param <T>          The type of the Service
+     * @throws RuntimeException if no service of the provided type and name is registered
      * @return The ServiceInstance
      */
-    <T> T getService(Class<T> serviceClass, String serviceName);
+    @NonNull
+    <T> T getService(@NonNull Class<T> serviceClass, @NonNull String serviceName);
 
 }

core/build.gradle.kts

@@ -9,8 +9,11 @@ projectConfiguration {
 }
 
 dependencies {
-	// Project
+	// project
 	api(project(":api"))
 	testImplementation(project(":handler-simple"))
 	testImplementation(project(":handler-reactor"))
+
+	// annotations
+	implementation("org.jspecify:jspecify:1.0.0")
 }

core/src/main/java/com/github/philippheuer/events4j/core/EventManager.java

@@ -10,6 +10,8 @@
 import com.github.philippheuer.events4j.core.services.ServiceMediator;
 import lombok.Getter;
 import lombok.extern.slf4j.Slf4j;
+import org.jspecify.annotations.NonNull;
+import org.jspecify.annotations.Nullable;
 
 import java.lang.reflect.InvocationTargetException;
 import java.util.ArrayList;
@@ -23,10 +25,6 @@
 
 /**
  * The EventManager
- *
- * @author Philipp Heuer [https://github.com/PhilippHeuer]
- * @version %I%, %G%
- * @since 1.0
  */
 @Getter
 @Slf4j
@@ -79,7 +77,7 @@ public EventManager() {
      *
      * @param eventHandler IEventHandler
      */
-    public void registerEventHandler(IEventHandler eventHandler) {
+    public void registerEventHandler(@NonNull IEventHandler eventHandler) {
         if (!eventHandlers.contains(eventHandler)) {
             eventHandlers.add(eventHandler);
             eventHandlerCache.put(eventHandler.getClass().getCanonicalName(), eventHandler.getClass());
@@ -89,6 +87,7 @@ public void registerEventHandler(IEventHandler eventHandler) {
     /**
      * @return returns the list of all active subscriptions
      */
+    @NonNull
     public List<IEventSubscription> getActiveSubscriptions() {
         return Collections.unmodifiableList(new ArrayList<>(activeSubscriptions.values()));
     }
@@ -126,7 +125,7 @@ public void autoDiscovery() {
      *
      * @param event A event of any kinds, should implement IEvent if possible
      */
-    public void publish(Object event) {
+    public void publish(@NonNull Object event) {
         // check for stop
         if (isStopped) {
             log.warn("Tried to dispatch a event to a closed eventManager!");
@@ -163,7 +162,7 @@ public void publish(Object event) {
      * @param eventHandlerClass the event handler class
      * @return boolean
      */
-    public boolean hasEventHandler(Class<? extends IEventHandler> eventHandlerClass) {
+    public boolean hasEventHandler(@NonNull Class<? extends IEventHandler> eventHandlerClass) {
         return getEventHandlers().stream().anyMatch(h -> h.getClass().getName().equalsIgnoreCase(eventHandlerClass.getName()));
     }
 
@@ -174,7 +173,7 @@ public boolean hasEventHandler(Class<? extends IEventHandler> eventHandlerClass)
      * @param <E>               the eventHandler type
      * @return a reference to the requested event handler
      */
-    public <E extends IEventHandler> E getEventHandler(Class<E> eventHandlerClass) {
+    public <E extends IEventHandler> E getEventHandler(@NonNull Class<E> eventHandlerClass) {
         Optional<E> eventHandler = getEventHandlers().stream().filter(h -> h.getClass().getName().equalsIgnoreCase(eventHandlerClass.getName())).map(h -> (E) h).findAny();
         return eventHandler.orElseThrow(() -> new RuntimeException("No eventHandler of type " + eventHandlerClass.getName() + " is registered!"));
     }
@@ -187,8 +186,14 @@ public <E extends IEventHandler> E getEventHandler(Class<E> eventHandlerClass) {
      * @param <E>        the event type
      * @return a new Disposable of the given eventType
      */
-    public <E> IEventSubscription onEvent(Class<E> eventClass, Consumer<E> consumer) {
-        return onEvent(consumer.getClass().getCanonicalName() + "/" + consumerSequence.getAndAdd(1), eventClass, consumer);
+    @NonNull
+    public <E> IEventSubscription onEvent(@NonNull Class<E> eventClass, @NonNull Consumer<E> consumer) {
+        IEventSubscription sub;
+        do {
+             sub = onEvent(consumer.getClass().getCanonicalName() + "/" + consumerSequence.getAndAdd(1), eventClass, consumer);
+        } while (sub == null);
+
+        return sub;
     }
 
     /**
@@ -202,7 +207,8 @@ public <E> IEventSubscription onEvent(Class<E> eventClass, Consumer<E> consumer)
      * @param <E>        the event type
      * @return a new Disposable of the given eventType
      */
-    public synchronized <E> IEventSubscription onEvent(String id, Class<E> eventClass, Consumer<E> consumer) {
+    @Nullable
+    public synchronized <E> IEventSubscription onEvent(@NonNull String id, @NonNull Class<E> eventClass, @NonNull Consumer<E> consumer) {
         // return null if a disposable with the given id is already present when idUnique is set
         if (activeSubscriptions.containsKey(id)) {
             return null;

core/src/main/java/com/github/philippheuer/events4j/core/domain/Event.java

@@ -13,10 +13,6 @@
 
 /**
  * Used to represent an event.
- *
- * @author Philipp Heuer [https://github.com/PhilippHeuer]
- * @version %I%, %G%
- * @since 1.0
  */
 @Data
 public abstract class Event implements IEvent {

core/src/main/java/com/github/philippheuer/events4j/core/services/ServiceMediator.java

@@ -3,6 +3,7 @@
 import com.github.philippheuer.events4j.api.IEventManager;
 import com.github.philippheuer.events4j.api.service.IServiceMediator;
 import lombok.Getter;
+import org.jspecify.annotations.NonNull;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -11,10 +12,6 @@
  * The ServiceMediator
  * <p>
  * The ServiceMediator provides access to 3rd party services for your custom events
- *
- * @author Philipp Heuer [https://github.com/PhilippHeuer]
- * @version %I%, %G%
- * @since 1.0
  */
 public final class ServiceMediator implements IServiceMediator {
 
@@ -44,7 +41,7 @@ public ServiceMediator(final IEventManager eventManager) {
      * @param serviceName     The ServiceName
      * @param serviceInstance The ServiceInstance
      */
-    public void addService(String serviceName, Object serviceInstance) {
+    public void addService(@NonNull String serviceName, @NonNull Object serviceInstance) {
         serviceReferences.put(serviceName, serviceInstance);
     }
 
@@ -56,7 +53,8 @@ public void addService(String serviceName, Object serviceInstance) {
      * @param <T>          The type of the Service
      * @return The ServiceInstance
      */
-    public <T> T getService(Class<T> serviceClass, String serviceName) {
+    @NonNull
+    public <T> T getService(@NonNull Class<T> serviceClass, @NonNull String serviceName) {
         Object serviceInstance = serviceReferences.get(serviceName);
 
         if (serviceClass.isInstance(serviceInstance)) {

handler-reactor/build.gradle.kts

@@ -9,12 +9,15 @@ projectConfiguration {
 }
 
 dependencies {
-	// Project
+	// project
 	api(project(":api"))
 	testImplementation(project(":core"))
 
-	// Reactor - see https://repo1.maven.org/maven2/io/projectreactor/reactor-bom/Dysprosium-SR12/reactor-bom-Dysprosium-SR12.pom
+	// reactor - see https://repo1.maven.org/maven2/io/projectreactor/reactor-bom/Dysprosium-SR12/reactor-bom-Dysprosium-SR12.pom
 	api("io.projectreactor:reactor-core:3.7.2")
 	api("io.projectreactor.addons:reactor-extra:3.5.2")
 	testImplementation("io.projectreactor:reactor-test:3.7.2")
+
+	// annotations
+	implementation("org.jspecify:jspecify:1.0.0")
 }

handler-reactor/src/main/java/com/github/philippheuer/events4j/reactor/ReactorEventHandler.java

@@ -5,6 +5,7 @@
 import com.github.philippheuer.events4j.reactor.util.Events4JSubscriber;
 import lombok.Getter;
 import lombok.extern.slf4j.Slf4j;
+import org.jspecify.annotations.NonNull;
 import org.reactivestreams.Subscriber;
 import reactor.core.publisher.EmitterProcessor;
 import reactor.core.publisher.Flux;
@@ -53,7 +54,7 @@ public ReactorEventHandler() {
      *
      * @param scheduler        The scheduler provides some guarantees required by Reactive Streams flows like FIFO execution
      * @param processor        Used to bridge gateway events to the subscribers
-     * @param overflowStrategy Safely gates a multi-threaded producer.
+     * @param overflowStrategy Safely gates a multithreaded producer.
      * @deprecated {@link FluxProcessor} is deprecated.
      */
     @Deprecated
@@ -64,7 +65,7 @@ public ReactorEventHandler(Scheduler scheduler, FluxProcessor<Object, Object> pr
     }
 
     @Override
-    public void publish(Object event) {
+    public void publish(@NonNull Object event) {
         // publish event
         eventSink.next(event);
     }
@@ -77,8 +78,9 @@ public void publish(Object event) {
      * @param <E>        the event type
      * @return a new {@link reactor.core.publisher.Flux} of the given eventType
      */
+    @NonNull
     @Override
-    public <E> IDisposable onEvent(Class<E> eventClass, Consumer<E> consumer) {
+    public <E> IDisposable onEvent(@NonNull Class<E> eventClass, @NonNull Consumer<E> consumer) {
         Flux<E> flux = processor
             .publishOn(this.scheduler)
             .ofType(eventClass);

handler-reactor/src/test/java/com/github/philippheuer/events4j/reactor/ReactorEventHandlerTest.java

@@ -16,10 +16,6 @@
 
 /**
  * Reactor EventHandler Test
- *
- * @author Philipp Heuer [https://github.com/PhilippHeuer]
- * @version %I%, %G%
- * @since 1.0
  */
 class ReactorEventHandlerTest {