org.openstreetmap.josm.eventbus

Class Subscriber

java.lang.Object

org.openstreetmap.josm.eventbus.Subscriber

Direct Known Subclasses:

Subscriber.SynchronizedSubscriber

class Subscriber
extends Object

A subscriber method on a specific object, plus the executor that should be used for dispatching events to it.

Two subscribers are equivalent when they refer to the same method on the same object (not class). This property is used to ensure that no subscriber method is registered more than once.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	Subscriber.SynchronizedSubscriber Subscriber that synchronizes invocations of a method to ensure that only one thread may enter the method at a time.

Field Summary

Fields

Modifier and Type	Field and Description
private EventBus	bus The event bus this subscriber belongs to.
private Executor	executor Executor to use for dispatching events to this subscriber.
private Method	method Subscriber method.
(package private) Object	target The object with the subscriber method.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Subscriber(EventBus bus, Object target, Method method)

Method Summary

Modifier and Type	Method and Description
private SubscriberExceptionContext	context(Object event) Gets the context for the given event.
(package private) static Subscriber	create(EventBus bus, Object listener, Method method) Creates a Subscriber for method on listener.
(package private) void	dispatchEvent(Object event) Dispatches event to this subscriber using the proper executor.
boolean	equals(Object obj)
int	hashCode()
(package private) void	invokeSubscriberMethod(Object event) Invokes the subscriber method.
private static boolean	isDeclaredThreadSafe(Method method) Checks whether method is thread-safe, as indicated by the presence of the AllowConcurrentEvents annotation.

Methods inherited from class java.lang.Object

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

Field Detail

bus

private EventBus bus

The event bus this subscriber belongs to.

target

final Object target

The object with the subscriber method.

method

private final Method method

Subscriber method.

executor

private final Executor executor

Executor to use for dispatching events to this subscriber.

Constructor Detail

Subscriber

private Subscriber(EventBus bus,
                   Object target,
                   Method method)

Method Detail

create

static Subscriber create(EventBus bus,
                         Object listener,
                         Method method)

Creates a Subscriber for method on listener.

Parameters:

bus - event bus

listener - listener

method - method

Returns:

subscriber

dispatchEvent

final void dispatchEvent(Object event)

Dispatches event to this subscriber using the proper executor.

Parameters:

event - event to dispatch

invokeSubscriberMethod

void invokeSubscriberMethod(Object event)
                     throws InvocationTargetException

Invokes the subscriber method. This method can be overridden to make the invocation synchronized.

Parameters:

event - event to dispatch

Throws:

InvocationTargetException - if the invocation fails

context

private SubscriberExceptionContext context(Object event)

Gets the context for the given event.

Parameters:

event - event

Returns:

context for the given event

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

isDeclaredThreadSafe

private static boolean isDeclaredThreadSafe(Method method)

Checks whether method is thread-safe, as indicated by the presence of the AllowConcurrentEvents annotation.

Parameters:

method - method to check

Returns:

true if method is thread-safe