org.timothyb89.eventbus

Class EventQueueDefinition

java.lang.Object

org.timothyb89.eventbus.EventQueueDefinition

public class EventQueueDefinition
extends Object

Defines an event queue which contains multiple priority-specific event handler sinks.

This class is thread-safe and should block minimally when accessed concurrently.

Author:

timothyb89

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	EventQueueDefinition.ReverseNaturalComparator<T extends Comparable>

Constructor Summary

Constructors

Constructor and Description
EventQueueDefinition(Class<? extends Event> eventType)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(EventQueueEntry entry) Registers the given entry for events.
void	push(Event event) Notifies entries in the event queue of the given event.
void	push(Event event, int priority) Notifies entries in the event queue with the given minimum priority.
void	remove(EventQueueEntry entry) Removes the given queue entry from the notification list.
void	removeAll(Object object) Removes all handler methods in the given object from notifications by this queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventQueueDefinition

public EventQueueDefinition(Class<? extends Event> eventType)

Method Detail

add

public void add(EventQueueEntry entry)

Registers the given entry for events. This may cause minor blocking on priority-specific lists when used concurrently with remove(EventQueueEntry), removeAll(Object), and push(Event).

Parameters:

entry - the entry to add to the notification queue

remove

public void remove(EventQueueEntry entry)

Removes the given queue entry from the notification list.

Parameters:

entry - the entry to remove

removeAll

public void removeAll(Object object)

Removes all handler methods in the given object from notifications by this queue.

Parameters:

object - the object to deregister

push

public void push(Event event)

Notifies entries in the event queue of the given event. Note that events may be vetoed by queue entries if their vetoable property is set to true (the default), which will cause remaining, lower priority events to be skipped. Ideally listeners that may veto events should have an above-normal priority to ensure consistent behavior.

Parameters:

event - the event to dispatch

push

public void push(Event event,
        int priority)

Notifies entries in the event queue with the given minimum priority.

Parameters:

event - The event to dispatch

priority - The minimum priority

See Also:

push(Event)