org.openstreetmap.josm.eventbus

Class JosmEventBus

java.lang.Object

org.openstreetmap.josm.eventbus.JosmEventBus

public class JosmEventBus
extends Object

The unique JOSM event bus.

Field Summary

Fields

Modifier and Type	Field and Description
private static EventBus	BUS

Constructor Summary

Constructors

Modifier	Constructor and Description
private	JosmEventBus()

Method Summary

Modifier and Type	Method and Description
static EventBus	getBus() Returns the unique JOSM event bus.
static void	post(Object event) Posts an event to all registered subscribers.
static void	register(Object object) Registers all subscriber methods on object to receive events.
static void	unregister(Object object) Unregisters all subscriber methods on a registered object.

Methods inherited from class java.lang.Object

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

Field Detail

BUS

private static final EventBus BUS

Constructor Detail

JosmEventBus

private JosmEventBus()

Method Detail

getBus

public static EventBus getBus()

Returns the unique JOSM event bus.

Returns:

the unique JOSM event bus

register

public static void register(Object object)

Registers all subscriber methods on object to receive events.

Parameters:

object - object whose subscriber methods should be registered.

See Also:

EventBus.register(java.lang.Object)

unregister

public static void unregister(Object object)

Unregisters all subscriber methods on a registered object.

Parameters:

object - object whose subscriber methods should be unregistered.

Throws:

IllegalArgumentException - if the object was not previously registered.

See Also:

EventBus.unregister(java.lang.Object)

post

public static void post(Object event)

Posts an event to all registered subscribers. This method will return successfully after the event has been posted to all subscribers, and regardless of any exceptions thrown by subscribers.

If no subscribers have been subscribed for event's class, and event is not already a DeadEvent, it will be wrapped in a DeadEvent and reposted.

Parameters:

event - event to post.

See Also:

EventBus.post(java.lang.Object)