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

Document Latest Features in README #27

Merged
kske merged 6 commits from f/improved-readme into develop 2021-11-26 13:54:58 +01:00
Conversation 0 Commits 6 Files Changed 3 +4 -4
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 5a6d8bcf35 - Show all commits

2
README.md
View File

@ -204,7 +204,7 @@ In more complex setups, taking a look at the event handler execution order can b
Event Bus offers a method for this purpose which can be used as follows:
```java
System.out.println(EventBus.getInstance().printExecutionOrder(SimpleEvent.class));
System.out.println(EventBus.getInstance().debugExecutionOrder(SimpleEvent.class));
kske marked this conversation as resolved Outdated
delvh commented 2021-11-25 11:25:28 +01:00
Outdated
Review
Copy Link

Something looks strange here:
a) if printXY prints directly, the syso part is unneeded.
b) if printXY only returns the result, then the function should be renamed.

Something looks strange here: a) if `printXY` prints directly, the `syso` part is unneeded. b) if `printXY` only returns the result, then the function should be renamed.
kske commented 2021-11-25 12:07:48 +01:00
Outdated
Review
Copy Link

The code itself is correct, but I agree that the name of the method can be misleading. What would you call a method that formats the execution order in a human-readable way as a string, but doesn't print it. Printing it to sysout directly seemed to specific to me, as some applications would prefer using a logger instead.

The code itself is correct, but I agree that the name of the method can be misleading. What would you call a method that formats the execution order in a human-readable way as a string, but doesn't print it. Printing it to sysout directly seemed to specific to me, as some applications would prefer using a logger instead.
delvh commented 2021-11-25 12:21:44 +01:00
Outdated
Review
Copy Link

generateExecutionOrder?
getDebugInformation?
createExecutionOrderString?
executionOrderAsString?
getExecutionOrderAsString?

`generateExecutionOrder`? `getDebugInformation`? `createExecutionOrderString`? `executionOrderAsString`? `getExecutionOrderAsString`?
```
Then, the execution order can be inspected in the console.

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

@ -381,7 +381,7 @@ public final class EventBus {
* @return a human-readable event handler list suitable for debugging purposes
* @since 1.2.0
*/
public String printExecutionOrder(Class<?> eventType) {
public String debugExecutionOrder(Class<?> eventType) {
var handlers = getHandlersFor(eventType);
var sj = new StringJoiner("\n");

4
event-bus-core/src/test/java/dev/kske/eventbus/core/DispatchTest.java
View File

@ -45,13 +45,13 @@ class DispatchTest {
}
/**
* Tests {@link EventBus#printExecutionOrder(Class)} based on the currently registered handlers.
* Tests {@link EventBus#debugExecutionOrder(Class)} based on the currently registered handlers.
*
* @since 1.2.0
*/
@Test
void testPrintExecutionOrder() {
String executionOrder = bus.printExecutionOrder(SimpleEvent.class);
String executionOrder = bus.debugExecutionOrder(SimpleEvent.class);
System.out.println(executionOrder);
assertEquals(
"Event handler execution order for class dev.kske.eventbus.core.SimpleEvent (3 handler(s)):\n"