Merge pull request #3 from 7orivorian/3.3.0

3.3.0

README.md

@@ -31,7 +31,7 @@ Lightweight Java event library created and maintained by [7orivorian](https://gi
 <dependency>
     <groupId>com.github.7orivorian</groupId>
     <artifactId>Wraith</artifactId>
-    <version>3.2.2</version>
+    <version>3.3.0</version>
 </dependency>
 ```
 
@@ -51,13 +51,13 @@ repositories {
 
 ```gradle
 dependencies {
-    implementation 'com.github.7orivorian:Wraith:3.2.2'
+    implementation 'com.github.7orivorian:Wraith:3.3.0'
 }
 ```
 
 ### Other
 
-Download a `.jar` file from [releases](https://github.com/7orivorian/Wraith/releases/tag/3.2.2)
+Download a `.jar` file from [releases](https://github.com/7orivorian/Wraith/releases/tag/3.3.0)
 
 # Building
 
@@ -99,6 +99,7 @@ Once you've defined your subscriber, you can subscribe it to an event bus direct
 public class Consts {
     private static final IEventBus EVENT_BUS = new EventBus();
 }
+
 public class ExampleSubscriber extends Subscriber {
 
     public ExampleSubscriber() {
@@ -200,8 +201,7 @@ public class ExampleSubscriber extends Subscriber {
 <details>
 <summary><i>Details...</i></summary>
 
-To dispatch an event to an event bus, call one of the `dispatch` methods defined in any `IEventBus`
-implementation, passing your event as a parameter:
+To dispatch an event, call one of the `dispatch` methods defined in `EventBus`, passing your event as a parameter:
 
 ```java
 import me.tori.wraith.event.staged.EventStage;

examples/java/me/tori/example/expanded/ExampleEvent.java

@@ -21,17 +21,17 @@
 
 package me.tori.example.expanded;
 
-import me.tori.wraith.event.cancelable.CancelableEvent;
 import me.tori.wraith.event.staged.EventStage;
 import me.tori.wraith.event.staged.IStagedEvent;
+import me.tori.wraith.event.status.StatusEvent;
 
 /**
  * Example event.
- * <p>Last updated for version <b>3.1.0</b>
  *
- * @author <b><a href="https://github.com/7orivorian">7orivorian</a></b>
+ * @author <a href="https://github.com/7orivorian">7orivorian</a>
+ * @since 1.0.0
  */
-class ExampleEvent extends CancelableEvent implements IStagedEvent {
+class ExampleEvent extends StatusEvent implements IStagedEvent {
 
     private String message;
     private final EventStage stage;

examples/java/me/tori/example/expanded/ExampleListener.java

@@ -26,10 +26,9 @@
 
 /**
  * Example listener.
- * <p>Last updated for version <b>3.1.0</b>
  *
- * @author <b><a href="https://github.com/7orivorian">7orivorian</a></b>
- * @since <b>1.0.0</b>
+ * @author <a href="https://github.com/7orivorian">7orivorian</a>
+ * @since 1.0.0
  */
 class ExampleListener extends EventListener<ExampleEvent> {
 

examples/java/me/tori/example/expanded/ExampleMain.java

@@ -26,10 +26,10 @@
 import me.tori.wraith.event.staged.EventStage;
 
 /**
- * Example program
- * <p>Last updated for version <b>3.1.0</b>
+ * Example program.
  *
- * @author <b><a href="https://github.com/7orivorian">7orivorian</a></b>
+ * @author <a href="https://github.com/7orivorian">7orivorian</a>
+ * @since 1.0.0
  */
 class ExampleMain {
 
@@ -44,15 +44,15 @@ public static void main(String[] args) {
 
         EVENT_BUS.dispatch(event1);
 
-        if (!event1.isCanceled()) {
+        if (!event1.isSuppressed()) {
             System.out.println(event1.getMessage());
         }
 
         ExampleEvent event2 = new ExampleEvent(EventStage.POST);
 
         EVENT_BUS.dispatch(event2);
 
-        if (!event2.isCanceled()) {
+        if (!event2.isSuppressed()) {
             System.out.println(event2.getMessage());
         }
     }

examples/java/me/tori/example/expanded/ExampleSubscriber.java

@@ -27,10 +27,9 @@
 
 /**
  * Example subscriber.
- * <p>Last updated for version <b>3.1.0</b>
  *
- * @author <b><a href="https://github.com/7orivorian">7orivorian</a></b>
- * @since <b>1.0.0</b>
+ * @author <a href="https://github.com/7orivorian">7orivorian</a>
+ * @since 1.0.0
  */
 class ExampleSubscriber extends Subscriber {
 

examples/java/me/tori/example/simple/SimpleExample.java

@@ -22,16 +22,14 @@
 package me.tori.example.simple;
 
 import me.tori.wraith.bus.EventBus;
-import me.tori.wraith.event.cancelable.CancelableEvent;
+import me.tori.wraith.event.status.StatusEvent;
 import me.tori.wraith.listener.LambdaEventListener;
 import me.tori.wraith.subscriber.Subscriber;
 
 /**
- * One-class example
- * <p>
- * Last updated for version <b>3.1.0</b>
+ * One-class example.
  *
- * @author <b><a href="https://github.com/7orivorian">7orivorian</a></b>
+ * @author <a href="https://github.com/7orivorian">7orivorian</a>
  */
 class SimpleExample {
 
@@ -45,38 +43,23 @@ public static void main(String[] args) {
         // Subscribe to the event bus
         bus.subscribe(subscriber);
 
-        SimpleEvent event;
-
         // Create a simple event
-        // This event will be canceled, see the lambda in SimpleSubscriber to know why ;P
-        event = new SimpleEvent("Pie is gross!");
-
-        if (!bus.dispatch(event)) {
-            // Only log the message if our event isn't canceled
-            System.out.println(event.getMessage());
-        }
+        SimpleEvent event = new SimpleEvent("Pie is delicious <3");
 
-        event = new SimpleEvent("Pie is delicious <3");
-        if (!bus.dispatch(event)) {
-            System.out.println(event.getMessage());
-        }
+        // Dispatch our event
+        bus.dispatch(event);
     }
 
     private static final class SimpleSubscriber extends Subscriber {
 
         public SimpleSubscriber() {
             registerListener(
-                    new LambdaEventListener<>(SimpleEvent.class, event -> {
-                        if (event.getMessage().contains("gross")) {
-                            // Pie is not gross, so we cancel this event, preventing it from being written to the console
-                            event.cancel();
-                        }
-                    })
+                    new LambdaEventListener<>(SimpleEvent.class, event -> System.out.println(event.getMessage()))
             );
         }
     }
 
-    private static final class SimpleEvent extends CancelableEvent {
+    private static final class SimpleEvent extends StatusEvent {
 
         private final String message;
 

pom.xml

@@ -10,7 +10,7 @@
     <groupId>me.tori</groupId>
     <artifactId>Wraith</artifactId>
     <packaging>jar</packaging>
-    <version>3.2.2</version>
+    <version>3.3.0</version>
 
     <licenses>
         <license>