com.alexvasilkov.events

Class Event

java.lang.Object

EventBase

com.alexvasilkov.events.Event

public class Event
extends EventBase

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Event.Builder

Method Summary

Modifier and Type	Method and Description
java.lang.String	getKey()
<T> T	getParam(int index) Returns value at index position and implicitly casts it to T.
int	getParamsCount()
<T> T	getTag(int index) Returns value at index position and implicitly casts it to T.
int	getTagsCount()
static boolean	isDeeplyEqual(Event e1, Event e2) Two events are considered deeply equal if they have same key and exactly same parameters lists.
Event	postResult(EventResult result) Schedules event's result to be passed to all available subscribers. This method should only be called inside of method marked with Events.Subscribe. See Events.Result.
Event	postResult(java.lang.Object... params) Wraps given params as EventResult and passes them to postResult(EventResult).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getKey

public java.lang.String getKey()

getParam

public <T> T getParam(int index)

Returns value at index position and implicitly casts it to T. Returns null if there is no value for specified index.

getParamsCount

public int getParamsCount()

getTag

public <T> T getTag(int index)

Returns value at index position and implicitly casts it to T. Returns null if there is no value for specified index.

getTagsCount

public int getTagsCount()

postResult

public Event postResult(EventResult result)

Schedules event's result to be passed to all available subscribers.
This method should only be called inside of method marked with Events.Subscribe.
See Events.Result.

postResult

public Event postResult(java.lang.Object... params)

Wraps given params as EventResult and passes them to postResult(EventResult).

isDeeplyEqual

public static boolean isDeeplyEqual(Event e1,
                                    Event e2)

Two events are considered deeply equal if they have same key and exactly same parameters lists.

Parameters are compared using Arrays.deepEquals(Object[], Object[]), so be sure to have correct implementation of Object.equals(Object) method for all parameters.

If you don't want some of parameters to be compared pass them as tags using Event.Builder.tag(Object...) builder method.