diff --git a/README.md b/README.md new file mode 100644 index 0000000..021f73b --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# EventBus + +EventBus is designed to be a simple subscriber-publisher framework. Originally inspired by [Guava], with intentions to be faster by replacing reflection with generated accessor classes. EventBus is intended to be a generic library usable in any project. It has grown larger API/Feature/Complexity/Dependency wise then it was ever intended, and thus will be receiving some redesigns and simplification eventually. + +The major focus of EventBus is fast event dispatching. As such any changes should have benchmarks run. See [Benchmarking]. + +### Thanks +[![YourKit](https://www.yourkit.com/images/yklogo.png)](https://www.yourkit.com/) + +YourKit for providing us access to their [YourKit Java Profiler] which helps identify bottlenecks and places for improvment. + + +[Guava]: https://guava.dev/releases/snapshot-jre/api/docs/com/google/common/eventbus/EventBus.html +[Benchmarking]: https://github.com/MinecraftForge/EventBus/blob/master/Benchmarking.md +[YourKit Java Profiler]: https://www.yourkit.com/java/profiler/ \ No newline at end of file diff --git a/src/main/java/net/minecraftforge/eventbus/api/Event.java b/src/main/java/net/minecraftforge/eventbus/api/Event.java index 39584ac..259a99b 100644 --- a/src/main/java/net/minecraftforge/eventbus/api/Event.java +++ b/src/main/java/net/minecraftforge/eventbus/api/Event.java @@ -60,7 +60,7 @@ public boolean isCanceled() { * invoke this method on an event that is not cancelable (as determined by {@link #isCancelable} * will result in an {@link UnsupportedOperationException}. *
- * The functionality of setting the canceled state is defined on a per-event bases. + * The functionality of setting the canceled state is defined on a per-event basis. *
* Throws a {@link IllegalStateException} if called during the {@link EventPriority#MINOTOR} phase.
* Note: If the event bus does not track the phases then this protection doesn't function. Most standard @@ -104,7 +104,7 @@ public Result getResult() { * Sets the result value for this event, not all events can have a result set, and any attempt to * set a result for a event that isn't expecting it will result in a IllegalArgumentException. * - * The functionality of setting the result is defined on a per-event bases. + * The functionality of setting the result is defined on a per-event basis. * * @param value The new result */