From 5a6d8bcf3592b7f0812181290ee13b78e4a45bba Mon Sep 17 00:00:00 2001 From: kske Date: Thu, 25 Nov 2021 14:34:13 +0100 Subject: [PATCH] Rename EventBus#printExecutionOrder(Class) to debugExecutionOrder The method doesn't print anything, but rather returns a string containing the debug information. --- README.md | 2 +- .../src/main/java/dev/kske/eventbus/core/EventBus.java | 2 +- .../src/test/java/dev/kske/eventbus/core/DispatchTest.java | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7a21f40..de0d376 100644 --- a/README.md +++ b/README.md @@ -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)); ``` Then, the execution order can be inspected in the console. diff --git a/event-bus-core/src/main/java/dev/kske/eventbus/core/EventBus.java b/event-bus-core/src/main/java/dev/kske/eventbus/core/EventBus.java index 42060b7..02cf156 100644 --- a/event-bus-core/src/main/java/dev/kske/eventbus/core/EventBus.java +++ b/event-bus-core/src/main/java/dev/kske/eventbus/core/EventBus.java @@ -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"); diff --git a/event-bus-core/src/test/java/dev/kske/eventbus/core/DispatchTest.java b/event-bus-core/src/test/java/dev/kske/eventbus/core/DispatchTest.java index 250fc26..07b6db7 100644 --- a/event-bus-core/src/test/java/dev/kske/eventbus/core/DispatchTest.java +++ b/event-bus-core/src/test/java/dev/kske/eventbus/core/DispatchTest.java @@ -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"