zdm/event-bus
zdm/event-bus
3
Fork 0
Code Issues 2 Pull Requests Releases 8 Wiki Activity

Rephrase some Javadoc

Browse Source 
As suggested by @delvh.
This commit is contained in:
Kai S. K. Engelbart 2021-11-01 20:52:14 +01:00
parent 82c66c45ec
commit 872b395374
Signed by: kske
GPG Key ID: 8BEB13EC5DF7EF13
2 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
event-bus-core/src/main/java/dev/kske/eventbus/core/EventBus.java
View File

@ -75,14 +75,15 @@ public final class EventBus {
private final Map<Class<?>, TreeSet<EventHandler>> bindings = new ConcurrentHashMap<>(); private final Map<Class<?>, TreeSet<EventHandler>> bindings = new ConcurrentHashMap<>();
/** /**
* Registered listeners. * Stores all registered event listeners (which declare event handlers) and prevents them from
* being garbage collected.
* *
* @since 0.0.1 * @since 0.0.1
*/ */
private final Set<Object> registeredListeners = ConcurrentHashMap.newKeySet(); private final Set<Object> registeredListeners = ConcurrentHashMap.newKeySet();
/** /**
* Thread-local dispatch state. * The current event dispatching state, local to each thread.
* *
* @since 0.1.0 * @since 0.1.0
*/ */

2
event-bus-core/src/main/java/dev/kske/eventbus/core/EventBusException.java
View File

@ -4,7 +4,7 @@ package dev.kske.eventbus.core;
* This unchecked exception is specific to the event bus and can be thrown under the following * This unchecked exception is specific to the event bus and can be thrown under the following
* circumstances: * circumstances:
* <ul> * <ul>
* <li>An event handler throws an exception (which is stores as the cause)</li> * <li>An event handler throws an exception (which is stored as the cause)</li>
* <li>An event listener with an invalid event handler is registered</li> * <li>An event listener with an invalid event handler is registered</li>
* <li>{@link EventBus#cancel()} is invoked from outside an active dispatch thread</li> * <li>{@link EventBus#cancel()} is invoked from outside an active dispatch thread</li>
* </ul> * </ul>